All Classes

Class	Description
AbstractFactory	Provides an abstract class for Factories.
AbstractPageFormat	Provides an abstract page format
AbstractPaper	Provides a default implementation for Paper.
Area
AttributeItem	Provides an attribute key/value combination for a meta data item.
AttributeWithContext	Provides an attribute for a list of items.
BlockBuilder	Provides methods that supply content in a hierarchy of blocks.
BlockContentBuilder	Provides methods that supply content to a block.
BlockPosition	Positions a block of text at a specified row.
BlockPosition.Builder	Used when creating BlockPosition instances.
BlockPosition.VerticalAlignment	Block alignment
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.
Border	Provides a border specification.
Border.Builder	Provides a builder for borders.
BorderSpecification	Provides a specification for a border.
BorderSpecification.Align	Defines border alignments
BorderSpecification.Builder	Provides a builder for a border specification.
BorderSpecification.Style	Defines types of borders
BrailleConstants	Provides constants for braille.
BrailleConverter	Provides an interface for converting from text to braille and vice verca.
BrailleFilter	Provides an interface for braille filter for a particular locale.
BrailleFilterFactory	Provides a factory for braille filters.
BrailleFilterFactoryMaker	Provides a braille filter factory maker.
BrailleFilterFactoryMakerService	Provides an interface for a BrailleFilterFactoryMaker service.
BrailleFilterFactoryService	Provides an interface for a BrailleFilterFactory service.
BrailleGraphics	Provides basic braille graphics support using standard braille patterns.
BrailleTranslator	Provides an interface for braille translation and hyphenation for a particular locale.
BrailleTranslatorFactory	Provides a factory for braille translation and hyphenation.
BrailleTranslatorFactoryMaker	Provides a braille translator factory maker.
BrailleTranslatorFactoryMakerService	Provides an interface for a BrailleTranslatorFactoryMaker service.
BrailleTranslatorFactoryService	Provides an interface for a BrailleTranslatorFactory service.
BrailleTranslatorResult	Provides a braille translator result.
CompoundField	Provides a compound field object.
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.
CurrentPageField	CurrentPageField is a reference to the current page in the final document.
CurrentPageField.PagenumType	Defines page number types
DefaultAttributeWithContext	Provides a default implementation of attributes with context.
DefaultAttributeWithContext.Builder	Provides a builder for a default text attribute
DefaultTextAttribute	Provides a default implementation of text attributes.
DefaultTextAttribute.Builder	Provides a builder for a default text attribute
Device	Provides an interface to transmit a file to a device, typically a printer.
Dimensions	Provides two dimensional measurements in millimeters
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.
EightDotFallbackMethod	Defines the fallback action when a character in the range 0x2840-0x28FF is encountered.
Embosser	Provides an interface for common properties of an Embosser.
EmbosserCatalog	Provides a catalog of Embosser factories.
EmbosserCatalogService	Provides an interface for an EmbosserCatalog service.
EmbosserFactoryException	Provides an EmbosserFactory exception
EmbosserFactoryProperties	Extends FactoryProperties with embosser specific information.
EmbosserFeatures	Provides common embosser features to be used when configuring an Embosser factory.
EmbosserFilter	Provides an interface for filtering a collection of Embossers.
EmbosserProperties	Provides an interface for common embosser related properties.
EmbosserProperties.PrintMode	Regular printing or multi-page printing
EmbosserProvider	Provides an interface for a collection of Embossers.
EmbosserWriter	Provides an embosser communication interface.
EmbosserWriterProperties	Provides information about the embosser.
Expression	Provides an interface for OBFL-expressions.
ExpressionFactory	Provides a factory for expressions.
ExpressionFactoryMaker	Like all maker classes in the api, this class is only used directly in SPI context.
Factory	Provides an interface for common properties of a Factory.
FactoryCatalog<T extends Factory>	Provides an interface for factory catalogs.
FactoryFilter	Provides an interface for filtering a collection of Factories.
FactoryProperties	Provides factory properties.
FactoryProperties.ComparatorBuilder	Provides a comparator builder for factory properties.
FactoryProperties.ComparatorBuilder.SortOrder	Defines the sort order.
FactoryProperties.ComparatorBuilder.SortProperty	Defines the item to sort by.
FallbackRule	Provides a common interface for fallback rules.
Field	Provides a field for page headers/footers
FieldList	Provides a list of fields, typically used with headers and footers.
FieldList.Builder	Provides a field list builder
FileFormat
FileFormatProperties
FileFormatProvider
FollowingText	Provides information about an item that comes after the items being translated.
Formatter	Provides text-only formatting.
FormatterConfiguration	Provides global settings for a formatter.
FormatterConfiguration.Builder	Provides a builder for formatter configuration
FormatterCore	Provides core formatter tasks.
FormatterEngine	Provides a formatter engine.
FormatterEngineFactoryService	Provides an interface for a FormatterEngineFactory service.
FormatterEngineMaker	Like all maker classes in the api, this class is only used directly in SPI context.
FormatterException	Provides an exception for conditions in a formatter.
FormatterFactory	Provides a proxy for creating a formatter implementation.
FormatterFactoryMaker	Provides a factory for formatters.
FormatterSequence	Provides an interface for a formatter sequence
FormattingTypes	Provides common formatting 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.
HyphenatorConfigurationException	Provides an exception that indicates that a feature is not supported.
HyphenatorFactory	Provides a hyphenation factory interface.
HyphenatorFactoryMaker	Provides a hyphenator factory maker.
HyphenatorFactoryMakerService	Provides an interface for a HyphenatorFactoryMaker service.
HyphenatorFactoryService	Provides an interface for a HyphenatorFactory service.
HyphenatorInterface	Provides a hyphenator.
Integer2Text	Provides an integer2text.
Integer2TextConfigurationException	Provides an exception to indicate problems when configuring an integer to text factory or instance.
Integer2TextFactory	Provides a integer2text factory interface.
Integer2TextFactoryMaker	Provides a integer2text factory maker.
Integer2TextFactoryMakerService	Provides an interface for a Integer2TextFactoryMaker service.
Integer2TextFactoryService	Provides an interface for a Integer2TextFactory service.
IntegerOutOfRange	Thrown to indicate that an integer cannot be converted to text because it is out of range of the capabilities of the implementation.
ItemSequenceProperties	Defines properties specific for an item sequence.
ItemSequenceProperties.Builder	Provides a builder for creating ItemSequenceProperties instances.
ItemSequenceProperties.Range	Defines ranges.
LayoutEngineException	Provides an exception for the FormatterEngine.
LayoutMasterBuilder	Provides a builder for a layout master.
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.Alignment	Alignment values for leaders
Leader.Builder	The Builder is used when creating a Leader instance
Length	Provides a length measurement that can be expressed using the preferred units of length.
Length.UnitsOfLength	Defines possible units to be used when expressing a length value
LineBreaks	Provides an interface for line breaks
MarginRegion	Provides a vertical margin region.
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.
MarkerReferenceField.MarkerSearchDirection	Defines marker search directions.
MarkerReferenceField.MarkerSearchScope	Defines marker search scopes.
MediaTypes	Provides internet media types for some types.
MetaDataItem	Provides a simple meta data item.
MetaDataItem.Builder	Provides a meta data item builder.
NoField	NoField represents the absence of a field in a header or footer.
NumeralField	Provides a numeral field.
NumeralStyle	Defines numeral styles
ObflParser	Provides an OBFL-parser.
ObflParserException	Provides an exception for conditions occuring when parsing an OBFL-file.
ObflParserFactoryMaker	Like all maker classes in the api, this class is only used directly in SPI context.
ObflParserFactoryService	Provides an interface for a ObflParserFactory service.
PageAreaBuilder	Provides a page area builder.
PageAreaProperties	Specifies an area of the page where collection items can be placed.
PageAreaProperties.Alignment	Specifies the alignment of the page area.
PageAreaProperties.Builder	Creates a new page area properties builder
PagedMediaWriter	PagedMediaWriter is an interface for writing to a paged media.
PagedMediaWriterConfigurationException	Provides an exception that indicates a problem configuring a paged media writer instance.
PagedMediaWriterException	A PagedMediaWriterException is an exception that indicates conditions in a PagedMediaWriter that a reasonable application might want to catch.
PagedMediaWriterFactory	Provides a PagedMediaWriter factory interface.
PagedMediaWriterFactoryMaker	Provides a PagedMediaWriter factory maker.
PagedMediaWriterFactoryMakerService	Provides an interface for a PagedMediaWriterFactoryMaker service.
PagedMediaWriterFactoryService	Provides an interface for a PagedMediaWriterFactory service.
PageFormat	PageFormat extends a Paper with options selected by a user (if applicable).
PageFormat.Type	Defines page format types
PagenumField	Provides a reference to some property of the physical pages in the final document.
PageTemplateBuilder	Provides a page template builder.
Paper	Provides an interface for a physical paper media.
Paper.Type	Defines paper types.
PaperCatalog	Provides a catalog of Paper factories.
PaperCatalogService	Provides an interface for a PaperCatalog service.
PaperFilter	Provides an interface for filtering a collection of Papers.
PaperProvider	Provides an interface for a collection of Papers.
Position	Position is a data object for an integer position.
PrecedingText	Provides information about an already processed item.
PrintPage
PrintPage.PrintDirection	Direction of print
PrintPage.Shape	The shape of the paper
Provider<T extends FactoryProperties>	Provides an interface for a collection of Factories.
ReferenceListBuilder	Provides a method to add a reference list.
RenameFallbackRule	Provides a fallback rule that indicates that the collection should be reassigned to another identifier.
RenderingScenario	Provides a rendering scenario.
ResolvableText	Provides an interface for texts that may change during the translation process.
RollPaper	Provides a paper object for paper in rolls.
RollPaperFormat	Provides a paper format for paper in rolls.
Row	Defines a row of braille.
SectionProperties	Specifies the configuration properties for a section of pages in a paged media.
SequenceProperties	SequenceProperties stores properties that are specific for a sequence of blocks
SequenceProperties.Builder	The Builder is used when creating a SequenceProperites instance
SequenceProperties.SequenceBreakBefore	Provides types of "break before" rules for sequences
SheetPaper	Provides a paper object for cut-sheet paper.
SheetPaperFormat	Provides a paper format for cut-sheet paper.
SheetPaperFormat.Orientation	The width/height orientation of the page
SpanProperties	Provides span properties.
SpanProperties.Builder	Provides a builder for span properties.
StandardLineBreaks	Provides standard line break definitions
StandardLineBreaks.Type	Defines standard line break types
StringField	Provides a static string field.
Table	Provides an interface for common properties of a Table.
TableCatalog	Provides a catalog of Table factories.
TableCatalogService	Provides an interface for a TableCatalog service.
TableCellProperties	Provides properties needed for a table cell.
TableCellProperties.Builder	Provides a builder for creating table properties
TableFilter	Provides an interface for filtering a collection of Tables.
TableOfContents	Provides methods needed to add a TOC to a formatter.
TableProperties	Provides properties needed for a table.
TableProperties	Provides common table features.
TableProperties.Builder	Provides a builder for creating table properties
TableProvider	Provides an interface for a Table service.
TextAttribute	Provides an interface for text attributes.
TextBlockProperties	Provides text block properties.
TextBlockProperties.Builder	Provides a builder for text block properties
TextBorderConfigurationException	Provides an exception that indicates a problem configuring a new text border instance.
TextBorderFactory	Provides a factory for text borders.
TextBorderFactoryMaker	Provides a text border factory maker.
TextBorderFactoryMakerService	Provides an interface for a TextBorderFactoryMaker service.
TextBorderFactoryService	Provides an interface for a TextBorderFactory service.
TextBorderStyle	Defines a text border.
TextBorderStyle.Builder	Provides a builder for text borders.
TextProperties	Defines properties for a chunk of text.
TextProperties.Builder	Provides a builder for creating text properties instances.
TextWithContext	Provides a translatable text including context.
TocProperties	Defines properties specific for a TOC sequence.
TocProperties.Builder	Provides a builder for creating TOC properties instances.
TocProperties.TocRange	Defines TOC ranges.
TractorPaper	Provides a paper object for perforated paper with paper guides.
TractorPaperFormat	Provides a paper format for tractor paper.
TransitionBuilder	Provides a definition for volume transitions.
TransitionBuilderProperties	Provides properties for a transition builder.
TransitionBuilderProperties.ApplicationRange	Defines the application range starting from the end of the volume.
TransitionBuilderProperties.Builder	Provides a builder for transition builder properties.
Translatable	Provides a specification for a text to translate.
Translatable.Builder	Provides a builder for translatable objects
TranslatableWithContext	Provides a specification for a list of texts to translate.
TranslatableWithContext.Builder	Provides a builder for translatable objects
TranslationException	Provides an exception indicating a translation problem.
TranslatorConfigurationException	Provides an exception that indicates a problem configuring a new translator instance.
TranslatorMode	Provides information about a translator mode.
TranslatorMode.Builder	Provides a translator mode builder.
TranslatorMode.DotsPerCell	Provides a definition of the number of dots in a braille cell.
TranslatorSpecification	Provides a translator specification.
TranslatorType	Provides braille translator types, see also TranslatorMode.
UnsupportedMetricException	Provides a runtime exception for unsupported metrics.
UnsupportedPaperException	Provides an unsupported paper exception
VolumeContentBuilder	Provides methods needed to build volume anchored content, such as cover pages and TOC.
VolumeTemplateBuilder	Provides methods for building a volume template.
VolumeTemplateProperties	Defines properties for a volume template.
VolumeTemplateProperties.Builder	Provides a builder for creating volume template properties instances.