TableOfContents (dotify.api 5.0.0 API)

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

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`void`	`endEntry()`	Ends the current entry.
`void`	`startEntry(String refId, BlockProperties props)`	Starts a new entry with the supplied properties.

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
  - startEntry
```
void startEntry(String refId,
                BlockProperties props)
```
    Starts a new entry with the supplied properties.
    
    Parameters:
    
    refId - the element that this toc entry is connected to
    
    props - the properties
  - endEntry
```
void endEntry()
```
    Ends the current entry.