|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object nl.flotsam.pecia.builder.base.AbstractBuilder<T> nl.flotsam.pecia.builder.base.DefaultSectionBuilder<T>
public class DefaultSectionBuilder<T>
Constructor Summary | |
---|---|
DefaultSectionBuilder(DocumentBuilder builder,
String title,
T parent,
LifecycleListener listener)
|
Method Summary | |
---|---|
Section<T> |
document(Documenter<SimpleContents<?>> target)
Generates documentation, and returns the current context. |
String |
getId()
|
String |
getTitle()
|
ItemizedList<? extends Section<T>> |
itemizedList()
Adds an itemized list. |
AnnotatedSection<T> |
mark(String id)
Marks the section with a certain unique identifier. |
ItemizedList<? extends Section<T>> |
orderedList()
Adds an ordered list. |
Para<? extends Section<T>> |
para()
Adds a paragraph. |
Section<T> |
para(String text)
Adds a paragraph ( Para ) containing the text passed in. |
AnnotatedSection<? extends Section<T>> |
section(String title)
Adds a new section. |
AnnotatedSection<T> |
start()
|
Table2Cols<? extends Section<T>> |
table2Cols()
Adds a two-column table. |
Table3Cols<? extends Section<T>> |
table3Cols()
Adds a three-column table. |
Table4Cols<? extends Section<T>> |
table4Cols()
Adds a four-column table. |
Table5Cols<? extends Section<T>> |
table5Cols()
Adds a five-column table. |
Verbatim<? extends Section<T>> |
verbatim()
Adds verbatim content. |
Methods inherited from class nl.flotsam.pecia.builder.base.AbstractBuilder |
---|
end, getBuilder, getListener, getParent |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface nl.flotsam.pecia.DocumentElement |
---|
end, getParent |
Constructor Detail |
---|
public DefaultSectionBuilder(DocumentBuilder builder, String title, T parent, LifecycleListener listener)
Method Detail |
---|
public ItemizedList<? extends Section<T>> itemizedList()
SimpleContents
itemizedList
in interface SimpleContents<Section<T>>
public ItemizedList<? extends Section<T>> orderedList()
SimpleContents
orderedList
in interface SimpleContents<Section<T>>
public Para<? extends Section<T>> para()
SimpleContents
para
in interface SimpleContents<Section<T>>
public AnnotatedSection<? extends Section<T>> section(String title)
Contents
section
in interface Contents<Section<T>>
title
- The title of the section.
public Table2Cols<? extends Section<T>> table2Cols()
SimpleContents
table2Cols
in interface SimpleContents<Section<T>>
public Table3Cols<? extends Section<T>> table3Cols()
SimpleContents
table3Cols
in interface SimpleContents<Section<T>>
public Table4Cols<? extends Section<T>> table4Cols()
SimpleContents
table4Cols
in interface SimpleContents<Section<T>>
public Table5Cols<? extends Section<T>> table5Cols()
SimpleContents
table5Cols
in interface SimpleContents<Section<T>>
public Verbatim<? extends Section<T>> verbatim()
SimpleContents
verbatim
in interface SimpleContents<Section<T>>
public AnnotatedSection<T> start()
start
in interface Initializer<AnnotatedSection<T>>
public String getTitle()
getTitle
in interface SectionBuilder<T>
public AnnotatedSection<T> mark(String id)
AnnotatedSection
mark
in interface AnnotatedSection<T>
id
- The identifier of that section.
Section
, allowing you to potentially
add more metadata.)public String getId()
getId
in interface SectionBuilder<T>
public Section<T> para(String text)
SimpleContents
Para
) containing the text passed in.
para
in interface SimpleContents<Section<T>>
text
- The text to be added to the paragraph.
public Section<T> document(Documenter<SimpleContents<?>> target)
SimpleContents
document
in interface SimpleContents<Section<T>>
target
- The object generating the documentation.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |