nl.flotsam.pecia
Interface AnnotatedSection<T>

Type Parameters:

T - The type of content.

All Superinterfaces:

Contents<Section<T>>, DocumentElement<T>, Section<T>, SimpleContents<Section<T>>

All Known Subinterfaces:

SectionBuilder<T>

All Known Implementing Classes:

DefaultSectionBuilder

public interface AnnotatedSection<T>
extends Section<T>

A specialization of Section, allowing you to add some Section metadata. Once you start adding content to the Section, there is no way turning back to the Section itself.

Author:

Wilfred Springer

Method Summary

AnnotatedSection<T>

mark(String id) Marks the section with a certain unique identifier.

Methods inherited from interface nl.flotsam.pecia.Contents

section

Methods inherited from interface nl.flotsam.pecia.SimpleContents

document, itemizedList, orderedList, para, para, table2Cols, table3Cols, table4Cols, table5Cols, verbatim

Methods inherited from interface nl.flotsam.pecia.DocumentElement

end, getParent

Method Detail

mark

AnnotatedSection<T> mark(String id)

Marks the section with a certain unique identifier. (Relevant for cross references.)

Parameters:

id - The identifier of that section.

Returns:

The start of the Section, allowing you to potentially add more metadata.)