org.daisy.dotify.api.formatter

Interface TableOfContents

All Superinterfaces:

BlockBuilder, BlockContentBuilder, FormatterCore

public interface TableOfContents
extends FormatterCore

Provides methods needed to add a TOC to a formatter. Note that adding contents outside of entries has no specified meaning and may be ignored by a formatter.

Method Summary

Modifier and Type	Method and Description
void	endEntry() Ends the current entry.
void	startEntry(String refId) Starts a new entry with the supplied properties.
void	startEntryOnResumed(TocEntryOnResumedRange range) Starts a new entry-on-resumed with the supplied properties.

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

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

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, insertExternalReference, insertLeader, insertMarker, insertMarkerReference, insertPageReference, newLine, startSpan, startStyle

Method Detail

startEntry

void startEntry(String refId)

Starts a new entry with the supplied properties.

Parameters:

refId - the element that this toc entry is connected to

startEntryOnResumed

void startEntryOnResumed(TocEntryOnResumedRange range)

Starts a new entry-on-resumed with the supplied properties.

Parameters:

range - the range of this entry on resumed

endEntry

void endEntry()

Ends the current entry.