Package org.daisy.dotify.formatter.impl

Class FormatterImpl

java.lang.Object

org.daisy.dotify.formatter.impl.FormatterImpl

All Implemented Interfaces:

Formatter

public class FormatterImpl
extends Object
implements Formatter

Provides an implementation of the Formatter API.

Is used for creating a paged document. Uses VolumeProvider to produce Volume objects from a list of BlockSequence, which are provided through newSequence(SequenceProperties), and populated through methods like FormatterCoreImpl.startBlock(BlockProperties), FormatterCoreImpl.addChars(CharSequence, TextProperties), etc. The resuling paged document is collected through a PagedMediaWriter.

Method Summary

Modifier and Type	Method	Description
FormatterConfiguration	getConfiguration()	Gets the formatter configuration.
TransitionBuilder	getTransitionBuilder()	Gets the transition builder.
Iterable<? extends Volume>	getVolumes()
ContentCollection	newCollection(String collectionId)	Creates a new collection with the supplied identifier.
LayoutMasterBuilder	newLayoutMaster(String name, LayoutMasterProperties properties)	Creates a new LayoutMaster builder.
FormatterSequence	newSequence(SequenceProperties p)	Start a new Sequence at the current position in the flow.
TableOfContents	newToc(String tocName)	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.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getConfiguration

public FormatterConfiguration getConfiguration()

Description copied from interface: Formatter

Gets the formatter configuration.

Specified by:

getConfiguration in interface Formatter

Returns:

returns the formatter configuration

setConfiguration

public void setConfiguration(FormatterConfiguration config)

Description copied from interface: Formatter

Sets the formatter configuration.

Specified by:

setConfiguration in interface Formatter

Parameters:

config - the configuration

newSequence

public FormatterSequence newSequence(SequenceProperties p)

Description copied from interface: Formatter

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

Specified by:

newSequence in interface Formatter

Parameters:

p - the SequenceProperties for the new sequence

Returns:

returns a formatter core

newLayoutMaster

public LayoutMasterBuilder newLayoutMaster(String name,
                                           LayoutMasterProperties properties)

Description copied from interface: Formatter

Creates a new LayoutMaster builder.

Specified by:

newLayoutMaster in interface Formatter

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

public VolumeTemplateBuilder newVolumeTemplate(VolumeTemplateProperties props)

Description copied from interface: Formatter

Creates a new empty volume template builder.

Specified by:

newVolumeTemplate in interface Formatter

Parameters:

props - properties

Returns:

returns a new volume template builder

newToc

public TableOfContents newToc(String tocName)

Description copied from interface: Formatter

Creates a new table of contents with the supplied name.

Specified by:

newToc in interface Formatter

Parameters:

tocName - the TOC identifier

Returns:

returns a new table of contents

newCollection

public ContentCollection newCollection(String collectionId)

Description copied from interface: Formatter

Creates a new collection with the supplied identifier.

Specified by:

newCollection in interface Formatter

Parameters:

collectionId - the collection identifier

Returns:

returns a new collection

write

public void write(PagedMediaWriter writer)

Description copied from interface: Formatter

Writes the current result to a paged media.

Specified by:

write in interface Formatter

Parameters:

writer - the paged media writer to use

getVolumes

public Iterable<? extends Volume> getVolumes()

getTransitionBuilder

public TransitionBuilder getTransitionBuilder()

Description copied from interface: Formatter

Gets the transition builder.

Specified by:

getTransitionBuilder in interface Formatter

Returns:

returns the transition builder