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

Modifier and Type	Method and 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, insertExternalReference, insertLeader, insertMarker, insertMarkerReference, insertPageReference, 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 properties

blockId - 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