Package org.daisy.dotify.api.formatter
Interface BlockBuilder
-
- All Superinterfaces:
BlockContentBuilder
- All Known Subinterfaces:
ContentCollection
,FormatterCore
,FormatterSequence
,TableOfContents
,VolumeContentBuilder
public interface BlockBuilder extends BlockContentBuilder
Provides methods that supply content in a hierarchy of blocks.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description void
endBlock()
End the current block.void
startBlock(BlockProperties props)
Start a new block with the supplied BlockProperties.void
startBlock(BlockProperties props, String blockId)
Start a new block with the supplied BlockProperties.-
Methods inherited from interface org.daisy.dotify.api.formatter.BlockContentBuilder
addChars, endSpan, endStyle, insertAnchor, insertEvaluate, insertLeader, insertMarker, insertReference, newLine, startSpan, startStyle
-
-
-
-
Method Detail
-
startBlock
void startBlock(BlockProperties props)
Start a new block with the supplied BlockProperties.- Parameters:
props
- the BlockProperties of the new block- Throws:
IllegalStateException
- if the current state does not allow this call to be made
-
startBlock
void startBlock(BlockProperties props, String blockId)
Start a new block with the supplied BlockProperties.- Parameters:
props
- the block propertiesblockId
- the block id- Throws:
IllegalStateException
- if the current state does not allow this call to be made
-
endBlock
void endBlock()
End the current block.- Throws:
IllegalStateException
- if the current state does not allow this call to be made
-
-