org.daisy.dotify.api.formatter

Interface Formatter

public interface Formatter

Provides text-only formatting.

Method Summary

Modifier and Type	Method and Description
FormatterConfiguration	getConfiguration() Gets the formatter configuration
TransitionBuilder	getTransitionBuilder() Gets the transition builder.
ContentCollection	newCollection(String collectionIdentifier) Creates a new collection with the supplied identifier
LayoutMasterBuilder	newLayoutMaster(String name, LayoutMasterProperties properties) Creates a new LayoutMaster builder.
FormatterSequence	newSequence(SequenceProperties props) Start a new Sequence at the current position in the flow.
TableOfContents	newToc(String name) Creates a new table of contents with the supplied name
VolumeTemplateBuilder	newVolumeTemplate(VolumeTemplateProperties props) Creates a new empty volume template builder.
void	setConfiguration(FormatterConfiguration config) Sets the formatter configuration
void	write(PagedMediaWriter writer) Writes the current result to a paged media

Method Detail

getConfiguration

FormatterConfiguration getConfiguration()

Gets the formatter configuration

Returns:

returns the formatter configuration

setConfiguration

void setConfiguration(FormatterConfiguration config)

Sets the formatter configuration

Parameters:

config - the configuration

newSequence

FormatterSequence newSequence(SequenceProperties props)

Start a new Sequence at the current position in the flow.

Parameters:

props - the SequenceProperties for the new sequence

Returns:

returns a formatter core

newLayoutMaster

LayoutMasterBuilder newLayoutMaster(String name,
                                    LayoutMasterProperties properties)

Creates a new LayoutMaster builder.

Parameters:

name - The name of the LayoutMaster. This is the named used in when retrieving a master for a particular sequence from the SequenceProperties.

properties - the properties

Returns:

a layout master builder

newVolumeTemplate

VolumeTemplateBuilder newVolumeTemplate(VolumeTemplateProperties props)

Creates a new empty volume template builder.

Parameters:

props - properties

Returns:

returns a new volume template builder

getTransitionBuilder

TransitionBuilder getTransitionBuilder()

Gets the transition builder.

Returns:

returns the transition builder

newToc

TableOfContents newToc(String name)

Creates a new table of contents with the supplied name

Parameters:

name - the TOC identifier

Returns:

returns a new table of contents

newCollection

ContentCollection newCollection(String collectionIdentifier)

Creates a new collection with the supplied identifier

Parameters:

collectionIdentifier - the collection identifier

Returns:

returns a new collection

write

void write(PagedMediaWriter writer)

Writes the current result to a paged media

Parameters:

writer - the paged media writer to use