Package org.daisy.dotify.api.formatter
Interface ReferenceListBuilder
-
public interface ReferenceListBuilderProvides a method to add a reference list.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description FormatterCorenewOnCollectionEnd()Creates a new on collection end block.FormatterCorenewOnCollectionStart()Creates a new on collection start block.FormatterCorenewOnPageEnd()Creates a new on page end block.FormatterCorenewOnPageStart()Creates a new on page start block.FormatterCorenewOnVolumeEnd()Creates a new on volume end block.FormatterCorenewOnVolumeStart()Creates a new on volume start block.
-
-
-
Method Detail
-
newOnCollectionStart
FormatterCore newOnCollectionStart()
Creates a new on collection start block.
Calling this method is only valid within an item sequence.
- Returns:
- a formatter core
- Throws:
IllegalStateException- if not in an item sequence
-
newOnCollectionEnd
FormatterCore newOnCollectionEnd()
Creates a new on collection end block.
Calling this method is only valid within an item sequence.
- Returns:
- a formatter core
-
newOnVolumeStart
FormatterCore newOnVolumeStart()
Creates a new on volume start block.
Calling this method is only valid within an item sequence.
- Returns:
- a formatter core
-
newOnVolumeEnd
FormatterCore newOnVolumeEnd()
Creates a new on volume end block.
Calling this method is only valid within an item sequence.
- Returns:
- a formatter core
-
newOnPageStart
FormatterCore newOnPageStart()
Creates a new on page start block.
Calling this method is only valid within an item sequence.
- Returns:
- a formatter core
-
newOnPageEnd
FormatterCore newOnPageEnd()
Creates a new on page end block.
Calling this method is only valid within an item sequence.
- Returns:
- a formatter core
-
-