Package org.daisy.dotify.api.formatter

Interface VolumeContentBuilder

All Superinterfaces:

BlockBuilder, BlockContentBuilder, FormatterCore

public interface VolumeContentBuilder
extends FormatterCore

Provides methods needed to build volume anchored content, such as cover pages and TOC.

Method Summary

Modifier and Type	Method	Description
DynamicSequenceBuilder	newDynamicSequence(SequenceProperties props)	Creates a new dynamic sequence.
void	newOnTocEnd()	Creates a new on toc end block that always apply.
void	newOnTocEnd(Condition condition)	Creates a new on toc end block.
void	newOnTocStart()	Creates a new on toc start block that always apply.
void	newOnTocStart(Condition condition)	Creates a new on toc start block.
void	newOnVolumeEnd()	Creates a new on volume end block that always apply.
void	newOnVolumeEnd(Condition condition)	Creates a new on volume end block.
void	newOnVolumeStart()	Creates a new on volume start block that always apply.
void	newOnVolumeStart(Condition condition)	Creates a new on volume start block.
void	newSequence(SequenceProperties props)	Creates a new sequence at the current position.
void	newTocSequence(TocProperties props)	Creates a new toc sequence at the current position.

Methods inherited from interface org.daisy.dotify.api.formatter.BlockBuilder

endBlock, startBlock, startBlock

Methods inherited from interface org.daisy.dotify.api.formatter.BlockContentBuilder

addChars, endSpan, endStyle, insertAnchor, insertEvaluate, insertLeader, insertMarker, insertReference, newLine, startSpan, startStyle

Methods inherited from interface org.daisy.dotify.api.formatter.FormatterCore

beginsTableBody, beginsTableCell, beginsTableHeader, beginsTableRow, endTable, insertDynamicLayout, startTable

Method Detail

newSequence

void newSequence(SequenceProperties props)

Creates a new sequence at the current position.

Parameters:

props - the properties of the sequence

newTocSequence

void newTocSequence(TocProperties props)

Creates a new toc sequence at the current position.

Parameters:

props - the properties of the toc sequence

newOnTocStart

void newOnTocStart(Condition condition)

Creates a new on toc start block. In a scenario where conditions overlap, the first one added takes precedence.

Calling this method is only valid within a TOC sequence.

Parameters:

condition - a condition, or null

Throws:

IllegalStateException - if not in a TOC sequence

newOnTocStart

void newOnTocStart()

Creates a new on toc start block that always apply. In a scenario where conditions overlap, the first one added takes precedence.

Calling this method is only valid within a TOC sequence.

Throws:

IllegalStateException - if not in a TOC sequence

newOnVolumeStart

void newOnVolumeStart(Condition condition)

Creates a new on volume start block. In a scenario where conditions overlap, the first one added takes precedence.

Calling this method is only valid within a TOC sequence.

Parameters:

condition - a condition, or null

Throws:

IllegalStateException - if not in a TOC sequence

newOnVolumeStart

void newOnVolumeStart()

Creates a new on volume start block that always apply. In a scenario where conditions overlap, the first one added takes precedence.

Calling this method is only valid within a TOC sequence.

Throws:

IllegalStateException - if not in a TOC sequence

newOnVolumeEnd

void newOnVolumeEnd(Condition condition)

Creates a new on volume end block. In a scenario where conditions overlap, the first one added takes precedence.

Calling this method is only valid within a TOC sequence.

Parameters:

condition - a condition, or null

Throws:

IllegalStateException - if not in a TOC sequence

newOnVolumeEnd

void newOnVolumeEnd()

Creates a new on volume end block that always apply. In a scenario where conditions overlap, the first one added takes precedence.

Calling this method is only valid within a TOC sequence.

Throws:

IllegalStateException - if not in a TOC sequence

newOnTocEnd

void newOnTocEnd(Condition condition)

Creates a new on toc end block. In a scenario where conditions overlap, the first one added takes precedence.

Calling this method is only valid within a TOC sequence.

Parameters:

condition - a condition, or null

Throws:

IllegalStateException - if not in a TOC sequence

newOnTocEnd

void newOnTocEnd()

Creates a new on toc end block that always apply. In a scenario where conditions overlap, the first one added takes precedence.

Calling this method is only valid within a TOC sequence.

Throws:

IllegalStateException - if not in a TOC sequence

newDynamicSequence

DynamicSequenceBuilder newDynamicSequence(SequenceProperties props)

Creates a new dynamic sequence.

Parameters:

props - the sequence properties

Returns:

returns a new dynamic sequence