org.daisy.dotify.api.formatter

Interface ReferenceListBuilder

public interface ReferenceListBuilder

Provides a method to add a reference list.

Method Summary

Modifier and Type	Method and Description
FormatterCore	newOnCollectionEnd() Creates a new on collection end block.
FormatterCore	newOnCollectionStart() Creates a new on collection start block.
FormatterCore	newOnPageEnd() Creates a new on page end block.
FormatterCore	newOnPageStart() Creates a new on page start block.
FormatterCore	newOnVolumeEnd() Creates a new on volume end block.
FormatterCore	newOnVolumeStart() Creates a new on volume start block.

Method Detail

newOnCollectionStart

FormatterCore newOnCollectionStart()

Creates a new on collection start block.

Calling this method is only valid within an item sequence.

Returns:

a formatter core

Throws:

IllegalStateException - if not in an item sequence

newOnCollectionEnd

FormatterCore newOnCollectionEnd()

Creates a new on collection end block.

Calling this method is only valid within an item sequence.

Returns:

a formatter core

newOnVolumeStart

FormatterCore newOnVolumeStart()

Creates a new on volume start block.

Calling this method is only valid within an item sequence.

Returns:

a formatter core

newOnVolumeEnd

FormatterCore newOnVolumeEnd()

Creates a new on volume end block.

Calling this method is only valid within an item sequence.

Returns:

a formatter core

newOnPageStart

FormatterCore newOnPageStart()

Creates a new on page start block.

Calling this method is only valid within an item sequence.

Returns:

a formatter core

newOnPageEnd

FormatterCore newOnPageEnd()

Creates a new on page end block.

Calling this method is only valid within an item sequence.

Returns:

a formatter core