Package org.daisy.dotify.api.formatter

Provides a text only layout engine.

The entry point for using this package is the FormatterFactoryMaker (SPI) and FormatterFactory (OSGi). To add additional implementations, use the FormatterFactory interface.

Interface Summary

Interface	Description
BlockBuilder	Provides methods that supply content in a hierarchy of blocks.
BlockContentBuilder	Provides methods that supply content to a block.
Condition	Provides an interface for a condition.
ContentCollection	Provides methods needed to add a content collection to a formatter.
Context	Provides a formatter context that can be used to process context aware content.
DynamicContent	Provides an interface for dynamic text, in other words content that may change between renderings.
DynamicRenderer	Provides an interface for a dynamic renderer.
DynamicSequenceBuilder	Provides a dynamic sequence builder.
FallbackRule	Provides a common interface for fallback rules.
Field	Provides a field for page headers/footers
Formatter	Provides text-only formatting.
FormatterCore	Provides core formatter tasks.
FormatterFactory	Provides a proxy for creating a formatter implementation.
FormatterSequence	Provides an interface for a formatter sequence
FormattingTypes	Provides common formatting types.
LayoutMasterBuilder	Provides a builder for a layout master.
MarginRegion	Provides a vertical margin region.
PageAreaBuilder	Provides a page area builder.
PageTemplateBuilder	Provides a page template builder.
ReferenceListBuilder	Provides a method to add a reference list.
RenderingScenario	Provides a rendering scenario.
TableOfContents	Provides methods needed to add a TOC to a formatter.
TransitionBuilder	Provides a definition for volume transitions.
VolumeContentBuilder	Provides methods needed to build volume anchored content, such as cover pages and TOC.
VolumeTemplateBuilder	Provides methods for building a volume template.

Class Summary

Class	Description
BlockPosition	Positions a block of text at a specified row.
BlockPosition.Builder	Used when creating BlockPosition instances.
BlockProperties	BlockProperties defines properties specific for a block of text
BlockProperties.Builder	The Builder is used when creating a BlockProperties instance.
BlockSpacing	Provides a spacing definition for blocks.
BlockSpacing.Builder	Provides a builder for block spacing.
CompoundField	Provides a compound field object.
CurrentPageField	CurrentPageField is a reference to the current page in the final document.
FieldList	Provides a list of fields, typically used with headers and footers.
FieldList.Builder	Provides a field list builder
FormatterConfiguration	Provides global settings for a formatter.
FormatterConfiguration.Builder	Provides a builder for formatter configuration
FormatterFactoryMaker	Provides a factory for formatters.
ItemSequenceProperties	Defines properties specific for an item sequence.
ItemSequenceProperties.Builder	Provides a builder for creating ItemSequenceProperties instances.
LayoutMasterProperties	Provides properties for a LayoutMaster.
LayoutMasterProperties.Builder	Configuration class for a ConfigurableLayoutMaster
Leader	Leader is a data object used when separating two chunks of text within a single row.
Leader.Builder	The Builder is used when creating a Leader instance
Marker	A Marker is a reference data inserted at some point in the flow.
MarkerIndicator	Provides a marker indicator
MarkerIndicatorRegion	Provides an marker indicator region.
MarkerIndicatorRegion.Builder	Creates a new marker indicator region builder
MarkerReferenceField	A MarkerReferenceField is a place holder for a marker's value.
NoField	NoField represents the absence of a field in a header or footer.
NumeralField	Provides a numeral field.
PageAreaProperties	Specifies an area of the page where collection items can be placed.
PageAreaProperties.Builder	Creates a new page area properties builder
PagenumField	Provides a reference to some property of the physical pages in the final document.
Position	Position is a data object for an integer position.
RenameFallbackRule	Provides a fallback rule that indicates that the collection should be reassigned to another identifier.
SequenceProperties	SequenceProperties stores properties that are specific for a sequence of blocks
SequenceProperties.Builder	The Builder is used when creating a SequenceProperites instance
SpanProperties	Provides span properties.
SpanProperties.Builder	Provides a builder for span properties.
StringField	Provides a static string field.
TableCellProperties	Provides properties needed for a table cell.
TableCellProperties.Builder	Provides a builder for creating table properties
TableProperties	Provides properties needed for a table.
TableProperties.Builder	Provides a builder for creating table properties
TextBlockProperties	Provides text block properties.
TextBlockProperties.Builder	Provides a builder for text block properties
TextProperties	Defines properties for a chunk of text.
TextProperties.Builder	Provides a builder for creating text properties instances.
TocProperties	Defines properties specific for a TOC sequence.
TocProperties.Builder	Provides a builder for creating TOC properties instances.
TransitionBuilderProperties	Provides properties for a transition builder.
TransitionBuilderProperties.Builder	Provides a builder for transition builder properties.
VolumeTemplateProperties	Defines properties for a volume template.
VolumeTemplateProperties.Builder	Provides a builder for creating volume template properties instances.

Enum Summary

Enum	Description
BlockPosition.VerticalAlignment	Block alignment
CurrentPageField.PagenumType	Defines page number types
FormattingTypes.Alignment	Defines alignment options.
FormattingTypes.BreakBefore	Defines break before types.
FormattingTypes.Keep	Defines rows in block keep types.
FormattingTypes.ListStyle	Defines list styles.
ItemSequenceProperties.Range	Defines ranges.
Leader.Alignment	Alignment values for leaders
MarkerReferenceField.MarkerSearchDirection	Defines marker search directions.
MarkerReferenceField.MarkerSearchScope	Defines marker search scopes.
NumeralStyle	Defines numeral styles
PageAreaProperties.Alignment	Specifies the alignment of the page area.
SequenceProperties.SequenceBreakBefore	Provides types of "break before" rules for sequences
TocProperties.TocRange	Defines TOC ranges.
TransitionBuilderProperties.ApplicationRange	Defines the application range starting from the end of the volume.

Exception Summary

Exception	Description
FormatterException	Provides an exception for conditions in a formatter.