Index (dotify.api 4.1.0 API)

A B C D E F G H I K L M N O P R S T U V W

A

add(TextAttribute) - Method in class org.daisy.dotify.api.translator.DefaultTextAttribute.Builder: Adds a text attribute to the list of attributes
add(int) - Method in class org.daisy.dotify.api.translator.DefaultTextAttribute.Builder: Adds a new attribute with the specified width
addChars(CharSequence, TextProperties) - Method in interface org.daisy.dotify.api.formatter.BlockContentBuilder: Add chars to the current block
addFactory(HyphenatorFactoryService) - Method in class org.daisy.dotify.api.hyphenator.HyphenatorFactoryMaker: Adds a factory (intended for use by the OSGi framework)
addFactory(Integer2TextFactoryService) - Method in class org.daisy.dotify.api.text.Integer2TextFactoryMaker: Adds a factory (intended for use by the OSGi framework)
addFactory(BrailleFilterFactoryService) - Method in class org.daisy.dotify.api.translator.BrailleFilterFactoryMaker: Adds a factory (intended for use by the OSGi framework)
addFactory(BrailleTranslatorFactoryService) - Method in class org.daisy.dotify.api.translator.BrailleTranslatorFactoryMaker: Adds a factory (intended for use by the OSGi framework)
addFactory(MarkerProcessorFactoryService) - Method in class org.daisy.dotify.api.translator.MarkerProcessorFactoryMaker: Adds a factory (intended for use by the OSGi framework)
addFactory(TextBorderFactoryService) - Method in class org.daisy.dotify.api.translator.TextBorderFactoryMaker: Adds a factory (intended for use by the OSGi framework)
addFactory(PagedMediaWriterFactoryService) - Method in class org.daisy.dotify.api.writer.PagedMediaWriterFactoryMaker: Adds a factory (intended for use by the OSGi framework)
addFallback(FallbackRule) - Method in class org.daisy.dotify.api.formatter.PageAreaProperties.Builder: Adds a fallback rule.
addIndicator(String, String) - Method in class org.daisy.dotify.api.formatter.MarkerIndicatorRegion.Builder: Adds a new marker indicator.
addToFooter(FieldList) - Method in interface org.daisy.dotify.api.formatter.PageTemplateBuilder: Adds a line to the header
addToHeader(FieldList) - Method in interface org.daisy.dotify.api.formatter.PageTemplateBuilder: Adds a line to the header
addToLeftMargin(MarginRegion) - Method in interface org.daisy.dotify.api.formatter.PageTemplateBuilder: Adds a column to the left margin of the page.
addToRightMargin(MarginRegion) - Method in interface org.daisy.dotify.api.formatter.PageTemplateBuilder: Adds a column to the right margin of the page.
align(BlockPosition.VerticalAlignment) - Method in class org.daisy.dotify.api.formatter.BlockPosition.Builder: Sets the vertical alignment of the block, that is to say the row within the block that will be at the specified position.
align(FormattingTypes.Alignment) - Method in class org.daisy.dotify.api.formatter.BlockProperties.Builder: Sets the alignment property for the block.
align(Leader.Alignment) - Method in class org.daisy.dotify.api.formatter.Leader.Builder: Set the Alignment for Leader instances created using this builder.
align(PageAreaProperties.Alignment) - Method in class org.daisy.dotify.api.formatter.PageAreaProperties.Builder: Sets the alignment of the page area on the page.
align(FormattingTypes.Alignment) - Method in class org.daisy.dotify.api.formatter.TextBlockProperties.Builder: Sets the alignment for the block.
align(BorderSpecification.Align) - Method in class org.daisy.dotify.api.translator.Border.Builder.BuilderView: Sets the border alignment for the active edge.
align(int) - Method in enum org.daisy.dotify.api.translator.BorderSpecification.Align: Returns the offset from the outer edge of the specified value.
align(BorderSpecification.Align) - Method in class org.daisy.dotify.api.translator.BorderSpecification.Builder: Sets the border alignment.
allowsEndingVolumeOnHyphen() - Method in class org.daisy.dotify.api.formatter.FormatterConfiguration: Returns true if the last line (of the main flow) in each volume may be hyphenated, if necessary.
allowsEndingVolumeOnHyphen(boolean) - Method in class org.daisy.dotify.api.formatter.FormatterConfiguration.Builder: Sets the hyphenation policy for the last line (of the main flow) in each volume.
allowsTextOverflowTrimming(boolean) - Method in class org.daisy.dotify.api.formatter.FormatterConfiguration.Builder: Sets the text overflow trimming policy.
applicationRange(TransitionBuilderProperties.ApplicationRange) - Method in class org.daisy.dotify.api.formatter.TransitionBuilderProperties.Builder: Sets the application range for this builder.
applyToCollection() - Method in interface org.daisy.dotify.api.formatter.FallbackRule: Gets the identifier of the collection that this rule should be applied to.
applyToCollection() - Method in class org.daisy.dotify.api.formatter.RenameFallbackRule
attribute(AttributeItem) - Method in class org.daisy.dotify.api.writer.MetaDataItem.Builder: Sets the item's attribute.
AttributeItem - Class in org.daisy.dotify.api.writer: Provides an attribute key/value combination for a meta data item.
AttributeItem(String, String) - Constructor for class org.daisy.dotify.api.writer.AttributeItem: Creates a new attribute item with the supplied parameters.
attributes(TextAttribute) - Method in class org.daisy.dotify.api.translator.Translatable.Builder: Sets the text attributes for this builder

B

beginsTableBody() - Method in interface org.daisy.dotify.api.formatter.FormatterCore: Starts the table body.
beginsTableCell(TableCellProperties) - Method in interface org.daisy.dotify.api.formatter.FormatterCore: Starts a table cell.
beginsTableHeader() - Method in interface org.daisy.dotify.api.formatter.FormatterCore: Marks the beginning of the table header part of a table.
beginsTableRow() - Method in interface org.daisy.dotify.api.formatter.FormatterCore: Starts a table row.
BlockBuilder - Interface in org.daisy.dotify.api.formatter
BlockContentBuilder - Interface in org.daisy.dotify.api.formatter
blockIndent(int) - Method in class org.daisy.dotify.api.formatter.BlockProperties.Builder: Set the block indent for the block, in characters.
BlockPosition - Class in org.daisy.dotify.api.formatter: Positions a block of text at a specified row.
BlockPosition.Builder - Class in org.daisy.dotify.api.formatter: Used when creating BlockPosition instances.
BlockPosition.VerticalAlignment - Enum in org.daisy.dotify.api.formatter: Block alignment
BlockProperties - Class in org.daisy.dotify.api.formatter: BlockProperties defines properties specific for a block of text
BlockProperties(BlockProperties.Builder) - Constructor for class org.daisy.dotify.api.formatter.BlockProperties
BlockProperties.Builder - Class in org.daisy.dotify.api.formatter: The Builder is used when creating a BlockProperties instance.
BlockSpacing - Class in org.daisy.dotify.api.formatter: Provides a spacing definition for blocks.
BlockSpacing.Builder - Class in org.daisy.dotify.api.formatter: Provides a builder for block spacing.
border(TextBorderStyle) - Method in class org.daisy.dotify.api.formatter.LayoutMasterProperties.Builder: Sets a border surrounding the entire page.
border(Border) - Method in class org.daisy.dotify.api.formatter.TableCellProperties.Builder: Sets the border
border(Border) - Method in class org.daisy.dotify.api.formatter.TableProperties.Builder: Sets the border
Border - Class in org.daisy.dotify.api.translator: Provides a border specification.
Border.Builder - Class in org.daisy.dotify.api.translator: Provides a builder for borders.
Border.Builder.BuilderView - Class in org.daisy.dotify.api.translator: Provides a view of the builder that has a specific edge selected for configuration.
BorderSpecification - Class in org.daisy.dotify.api.translator: Provides a specification for a border.
BorderSpecification.Align - Enum in org.daisy.dotify.api.translator: Defines border alignments
BorderSpecification.Builder - Class in org.daisy.dotify.api.translator: Provides a builder for a border specification.
BorderSpecification.Style - Enum in org.daisy.dotify.api.translator: Defines types of borders
bottomBorder(String) - Method in class org.daisy.dotify.api.translator.TextBorderStyle.Builder: Sets the bottom of the border
bottomLeftCorner(String) - Method in class org.daisy.dotify.api.translator.TextBorderStyle.Builder: Sets the bottom left corner
bottomMargin(int) - Method in class org.daisy.dotify.api.formatter.BlockProperties.Builder: Set the bottom margin for the block, in characters.
bottomPadding(int) - Method in class org.daisy.dotify.api.formatter.BlockProperties.Builder: Set the bottom padding for the block, in characters.
bottomRightCorner(String) - Method in class org.daisy.dotify.api.translator.TextBorderStyle.Builder: Sets the bottom right corner
bottomSpacing(int) - Method in class org.daisy.dotify.api.formatter.BlockSpacing.Builder: Set the bottom spacing for the block, in characters.
BrailleFilter - Interface in org.daisy.dotify.api.translator: Provides an interface for braille filter for a particular locale.
BrailleFilterFactory - Interface in org.daisy.dotify.api.translator: Provides a factory for braille filters.
BrailleFilterFactoryMaker - Class in org.daisy.dotify.api.translator: Provides a braille filter factory maker.
BrailleFilterFactoryMaker() - Constructor for class org.daisy.dotify.api.translator.BrailleFilterFactoryMaker: Creates a new braille filter factory maker.
BrailleFilterFactoryMakerService - Interface in org.daisy.dotify.api.translator: Provides an interface for a BrailleFilterFactoryMaker service.
BrailleFilterFactoryService - Interface in org.daisy.dotify.api.translator: Provides an interface for a BrailleFilterFactory service.
BrailleGraphics - Class in org.daisy.dotify.api.graphics: Provides basic braille graphics support using standard braille patterns.
BrailleGraphics(boolean) - Constructor for class org.daisy.dotify.api.graphics.BrailleGraphics: Creates a new instance of braille graphics, with either full 8-dot or 6-dot patterns.
BrailleTranslator - Interface in org.daisy.dotify.api.translator: Provides an interface for braille translation and hyphenation for a particular locale.
BrailleTranslatorFactory - Interface in org.daisy.dotify.api.translator: Provides a factory for braille translation and hyphenation.
BrailleTranslatorFactoryMaker - Class in org.daisy.dotify.api.translator: Provides a braille translator factory maker.
BrailleTranslatorFactoryMaker() - Constructor for class org.daisy.dotify.api.translator.BrailleTranslatorFactoryMaker: Creates a new braille translator factory maker.
BrailleTranslatorFactoryMakerService - Interface in org.daisy.dotify.api.translator: Provides an interface for a BrailleTranslatorFactoryMaker service.
BrailleTranslatorFactoryService - Interface in org.daisy.dotify.api.translator: Provides an interface for a BrailleTranslatorFactory service.
BrailleTranslatorResult - Interface in org.daisy.dotify.api.translator: Provides a braille translator result.
breakBefore(FormattingTypes.BreakBefore) - Method in class org.daisy.dotify.api.formatter.BlockProperties.Builder: Set the break before property for the block.
breakBefore(SequenceProperties.SequenceBreakBefore) - Method in class org.daisy.dotify.api.formatter.SequenceProperties.Builder: Set the break before property for the sequence.
build() - Method in class org.daisy.dotify.api.formatter.BlockPosition.Builder: Creates a new BlockPosition instance
build() - Method in class org.daisy.dotify.api.formatter.BlockProperties.Builder: Build BlockProperties using the current state of the Builder.
build() - Method in class org.daisy.dotify.api.formatter.BlockSpacing.Builder: Build BlockSpacing using the current state of the Builder.
build() - Method in class org.daisy.dotify.api.formatter.FieldList.Builder: Builds a new field list with the current configuration
build() - Method in class org.daisy.dotify.api.formatter.FormatterConfiguration.Builder: Creates new configuration
build() - Method in class org.daisy.dotify.api.formatter.ItemSequenceProperties.Builder: Builds a new item sequence properties.
build() - Method in class org.daisy.dotify.api.formatter.LayoutMasterProperties.Builder: Creates a new LayoutMasterProperties based on the current state of the builder.
build() - Method in class org.daisy.dotify.api.formatter.Leader.Builder: Build Leader using the current state of the Builder
build() - Method in class org.daisy.dotify.api.formatter.MarkerIndicatorRegion.Builder: Builds the builder into a marker indicator region.
build() - Method in class org.daisy.dotify.api.formatter.PageAreaProperties.Builder: Creates a new page area properties object
build() - Method in class org.daisy.dotify.api.formatter.SequenceProperties.Builder: Build SequenceProperties using the current state of the Builder
build() - Method in class org.daisy.dotify.api.formatter.TableCellProperties.Builder: Creates a new table cell properties using the current state of this builder.
build() - Method in class org.daisy.dotify.api.formatter.TableProperties.Builder: Creates new table properties based on the current state of this builder
build() - Method in class org.daisy.dotify.api.formatter.TextBlockProperties.Builder: Creates a new text block properties object
build() - Method in class org.daisy.dotify.api.formatter.TextProperties.Builder: Builds a new TextProperties object using the current status of this builder.
build() - Method in class org.daisy.dotify.api.formatter.TocProperties.Builder
build() - Method in class org.daisy.dotify.api.formatter.TransitionBuilderProperties.Builder: Builds TransitionBuilderProperties based on the current state of this builder.
build() - Method in class org.daisy.dotify.api.formatter.VolumeTemplateProperties.Builder: Creates a new VolumeTemplateProperties instance based on the current configuration.
build() - Method in class org.daisy.dotify.api.translator.Border.Builder: Creates a new border based on the current state of the builder.
build() - Method in class org.daisy.dotify.api.translator.Border.Builder.BuilderView: Creates a new border using the current state of the builder
build() - Method in class org.daisy.dotify.api.translator.BorderSpecification.Builder: Creates a new border specification.
build(BorderSpecification) - Method in class org.daisy.dotify.api.translator.BorderSpecification.Builder: Creates a new border specification with the supplied fallback border.
build(int) - Method in class org.daisy.dotify.api.translator.DefaultTextAttribute.Builder: Creates a new default text attribute based on the current state of the builder
build() - Method in class org.daisy.dotify.api.translator.TextBorderStyle.Builder: Creates a new text border style using the current state of the builder.
build() - Method in class org.daisy.dotify.api.translator.Translatable.Builder: Builds a new Translatable object using the current status of this builder.
build() - Method in class org.daisy.dotify.api.writer.MetaDataItem.Builder: Creates a new meta data item based on the current state of the builder.
Builder() - Constructor for class org.daisy.dotify.api.formatter.BlockPosition.Builder: Creates a new Builder with TOP alignment at the absolute position of 0.
Builder() - Constructor for class org.daisy.dotify.api.formatter.BlockProperties.Builder: Create a new Builder
Builder() - Constructor for class org.daisy.dotify.api.formatter.BlockSpacing.Builder
Builder(List<Field>) - Constructor for class org.daisy.dotify.api.formatter.FieldList.Builder: Creates a new builder with the specified fields
Builder(String, String) - Constructor for class org.daisy.dotify.api.formatter.FormatterConfiguration.Builder: Creates a new builder with the specified properties
Builder(String, ItemSequenceProperties.Range) - Constructor for class org.daisy.dotify.api.formatter.ItemSequenceProperties.Builder: Creates a new builder with the supplied arguments.
Builder(int, int) - Constructor for class org.daisy.dotify.api.formatter.LayoutMasterProperties.Builder: Creates a new builder for layout master properties with the specified width and height.
Builder() - Constructor for class org.daisy.dotify.api.formatter.Leader.Builder: Create a new Builder
Builder(int) - Constructor for class org.daisy.dotify.api.formatter.MarkerIndicatorRegion.Builder: Creates a new builder with the specified width.
Builder(String, int) - Constructor for class org.daisy.dotify.api.formatter.PageAreaProperties.Builder: Creates a new instance with the specified parameters
Builder(String) - Constructor for class org.daisy.dotify.api.formatter.SequenceProperties.Builder: Create a new Builder
Builder() - Constructor for class org.daisy.dotify.api.formatter.TableCellProperties.Builder: Creates a new builder
Builder() - Constructor for class org.daisy.dotify.api.formatter.TableProperties.Builder: Creates a new builder
Builder() - Constructor for class org.daisy.dotify.api.formatter.TextBlockProperties.Builder
Builder(String) - Constructor for class org.daisy.dotify.api.formatter.TextProperties.Builder: Creates a new builder with the specified locale
Builder(String, String, TocProperties.TocRange) - Constructor for class org.daisy.dotify.api.formatter.TocProperties.Builder: Creates a new builder with the supplied arguments.
Builder() - Constructor for class org.daisy.dotify.api.formatter.TransitionBuilderProperties.Builder
Builder(int) - Constructor for class org.daisy.dotify.api.formatter.VolumeTemplateProperties.Builder: Creates a new Builder.
Builder() - Constructor for class org.daisy.dotify.api.translator.Border.Builder: Creates a new builder.
Builder() - Constructor for class org.daisy.dotify.api.translator.BorderSpecification.Builder: Creates a new builder.
Builder() - Constructor for class org.daisy.dotify.api.translator.DefaultTextAttribute.Builder: Creates a new builder
Builder(String) - Constructor for class org.daisy.dotify.api.translator.DefaultTextAttribute.Builder: Creates a new builder with the specified attribute name
Builder() - Constructor for class org.daisy.dotify.api.translator.TextBorderStyle.Builder: Creates a new text border style builder.
Builder(QName, String) - Constructor for class org.daisy.dotify.api.writer.MetaDataItem.Builder: Creates a new meta data item builder

C

calculateCost(Map<String, Double>) - Method in interface org.daisy.dotify.api.formatter.RenderingScenario: Calculates the cost of this scenario with the supplied variables (which might, for example, include the total height of the rendered result).
clone() - Method in class org.daisy.dotify.api.formatter.BlockProperties
colSpan(int) - Method in class org.daisy.dotify.api.formatter.TableCellProperties.Builder: Sets the column span
combine(List<String>, List<String>, int, int) - Static method in class org.daisy.dotify.api.graphics.BrailleGraphics: Combines two braille images by combining characters from the two input images.
compareTo(TranslatorSpecification) - Method in class org.daisy.dotify.api.translator.TranslatorSpecification
CompoundField - Class in org.daisy.dotify.api.formatter: Provides a compound field object.
CompoundField() - Constructor for class org.daisy.dotify.api.formatter.CompoundField: Creates a new compound field.
CompoundField(String) - Constructor for class org.daisy.dotify.api.formatter.CompoundField: Creates a new compound field with the specified text style.
Condition - Interface in org.daisy.dotify.api.formatter: Provides an interface for a condition.
condition(Condition) - Method in class org.daisy.dotify.api.formatter.VolumeTemplateProperties.Builder: Sets the condition for applying the volume template.
ContentCollection - Interface in org.daisy.dotify.api.formatter: Provides methods needed to add a content collection to a formatter.
Context - Interface in org.daisy.dotify.api.formatter: Provides a formatter context that can be used to process context aware content.
convert(InputStream, OutputStream) - Method in interface org.daisy.dotify.api.engine.FormatterEngine: Converts the OBFL in the input stream and writes the result to the output stream.
copy() - Method in interface org.daisy.dotify.api.translator.BrailleTranslatorResult: Returns a copy of this result in the current state.
countRemaining() - Method in interface org.daisy.dotify.api.translator.BrailleTranslatorResult: Returns the number of characters remaining in the result.
CurrentPageField - Class in org.daisy.dotify.api.formatter: CurrentPageField is a reference to the current page in the final document.
CurrentPageField(NumeralStyle) - Constructor for class org.daisy.dotify.api.formatter.CurrentPageField: Creates a new current page field.
CurrentPageField(NumeralStyle, String) - Constructor for class org.daisy.dotify.api.formatter.CurrentPageField: Creates a new current page field.
CurrentPageField.PagenumType - Enum in org.daisy.dotify.api.formatter: Defines page number types

D

defaultListLabel(String) - Method in class org.daisy.dotify.api.formatter.BlockProperties.Builder: Sets the default label for list items in the block.
DefaultTextAttribute - Class in org.daisy.dotify.api.translator: Provides a default implementation of text attributes.
DefaultTextAttribute(int, DefaultTextAttribute.Builder) - Constructor for class org.daisy.dotify.api.translator.DefaultTextAttribute
DefaultTextAttribute.Builder - Class in org.daisy.dotify.api.translator: Provides a builder for a default text attribute
duplex(boolean) - Method in class org.daisy.dotify.api.formatter.LayoutMasterProperties.Builder: Sets the duplex property, in other words whether to use both sides of a sheet or not.
duplex() - Method in class org.daisy.dotify.api.formatter.LayoutMasterProperties: Gets the duplex value.
duplex() - Method in interface org.daisy.dotify.api.writer.SectionProperties: Returns true if output is intended on both sides of the sheets
DynamicContent - Interface in org.daisy.dotify.api.formatter: Provides an interface for dynamic text, in other words content that may change between renderings.
DynamicRenderer - Interface in org.daisy.dotify.api.formatter: Provides an interface for a dynamic renderer.
DynamicSequenceBuilder - Interface in org.daisy.dotify.api.formatter: Provides a dynamic sequence builder.

E

endBlock() - Method in interface org.daisy.dotify.api.formatter.BlockBuilder: End the current block.
endEntry() - Method in interface org.daisy.dotify.api.formatter.TableOfContents: Ends the current entry.
endItem() - Method in interface org.daisy.dotify.api.formatter.ContentCollection: Ends the current item.
endStyle() - Method in interface org.daisy.dotify.api.formatter.BlockContentBuilder: Ends a previously opened style section
endTable() - Method in interface org.daisy.dotify.api.formatter.FormatterCore: Ends the table.
equals(Object) - Method in class org.daisy.dotify.api.formatter.BlockPosition
equals(Object) - Method in class org.daisy.dotify.api.formatter.BlockProperties
equals(Object) - Method in class org.daisy.dotify.api.formatter.BlockSpacing
equals(Object) - Method in class org.daisy.dotify.api.formatter.MarkerIndicator
equals(Object) - Method in class org.daisy.dotify.api.formatter.MarkerIndicatorRegion
equals(Object) - Method in class org.daisy.dotify.api.formatter.Position
equals(Object) - Method in class org.daisy.dotify.api.formatter.TableCellProperties
equals(Object) - Method in class org.daisy.dotify.api.formatter.TableProperties
equals(Object) - Method in class org.daisy.dotify.api.formatter.TextBlockProperties
equals(Object) - Method in class org.daisy.dotify.api.formatter.TextProperties
equals(Object) - Method in class org.daisy.dotify.api.translator.TextBorderStyle
equals(Object) - Method in class org.daisy.dotify.api.translator.TranslatorSpecification
evaluate() - Method in interface org.daisy.dotify.api.formatter.Condition: Evaluates the condition without supplying any variables.
evaluate(Context) - Method in interface org.daisy.dotify.api.formatter.Condition: Evaluates the condition in the supplied context.
evaluate(String) - Method in interface org.daisy.dotify.api.obfl.Expression: Evaluate is the method to use when evaluating an expression.
Expression - Interface in org.daisy.dotify.api.obfl: Provides an interface for OBFL-expressions.
ExpressionFactory - Interface in org.daisy.dotify.api.obfl: Provides a factory for expressions.
ExpressionFactoryMaker - Class in org.daisy.dotify.api.obfl: Like all maker classes in the api, this class is only used directly in SPI context.
ExpressionFactoryMaker() - Constructor for class org.daisy.dotify.api.obfl.ExpressionFactoryMaker: Creates a new expression factory maker

F

FallbackRule - Interface in org.daisy.dotify.api.formatter: Provides a common interface for fallback rules.
FEATURE_HYPHENATION_ACCURACY - Static variable in interface org.daisy.dotify.api.hyphenator.HyphenatorFactory: Defines hyphenation accuracy on a scale from 1 to 5 (integer):
FEATURE_MODE - Static variable in interface org.daisy.dotify.api.translator.TextBorderFactory: Mode feature.
Field - Interface in org.daisy.dotify.api.formatter: Provides a field for page headers/footers
FieldList - Class in org.daisy.dotify.api.formatter: Provides a list of fields, typically used with headers and footers.
FieldList.Builder - Class in org.daisy.dotify.api.formatter: Provides a field list builder
filter(Translatable) - Method in interface org.daisy.dotify.api.translator.BrailleFilter: Translates the string into braille using the specification.
firstLineIndent(int) - Method in class org.daisy.dotify.api.formatter.BlockProperties.Builder: Set the first line indent for the block, in characters.
firstLineIndent(int) - Method in class org.daisy.dotify.api.formatter.TextBlockProperties.Builder: Set the first line indent for the block, in characters.
format(int) - Method in enum org.daisy.dotify.api.formatter.NumeralStyle: Formats the numeral with the given style
Formatter - Interface in org.daisy.dotify.api.formatter: Provides text-only formatting.
FormatterConfiguration - Class in org.daisy.dotify.api.formatter: Provides global settings for a formatter.
FormatterConfiguration.Builder - Class in org.daisy.dotify.api.formatter: Provides a builder for formatter configuration
FormatterCore - Interface in org.daisy.dotify.api.formatter: Provides core formatter tasks.
FormatterEngine - Interface in org.daisy.dotify.api.engine: Provides a formatter engine.
FormatterEngineFactoryService - Interface in org.daisy.dotify.api.engine: Provides an interface for a FormatterEngineFactory service.
FormatterEngineMaker - Class in org.daisy.dotify.api.engine: Like all maker classes in the api, this class is only used directly in SPI context.
FormatterEngineMaker() - Constructor for class org.daisy.dotify.api.engine.FormatterEngineMaker: Creates a new formatter engine maker.
FormatterException - Exception in org.daisy.dotify.api.formatter: Provides an exception for conditions in a formatter.
FormatterException() - Constructor for exception org.daisy.dotify.api.formatter.FormatterException: Constructs a new exception with null as its detail message.
FormatterException(String) - Constructor for exception org.daisy.dotify.api.formatter.FormatterException: Constructs a new exception with the specified detail message.
FormatterException(Throwable) - Constructor for exception org.daisy.dotify.api.formatter.FormatterException: Constructs a new exception with the specified cause and a detail message of (cause==null ? null : cause.toString()) (which typically contains the class and detail message of cause).
FormatterException(String, Throwable) - Constructor for exception org.daisy.dotify.api.formatter.FormatterException: Constructs a new exception with the specified detail message and cause.
FormatterException(String, Throwable, boolean, boolean) - Constructor for exception org.daisy.dotify.api.formatter.FormatterException: Constructs a new exception with the specified detail message, cause, suppression enabled or disabled, and writable stack trace enabled or disabled.
FormatterFactory - Interface in org.daisy.dotify.api.formatter: Provides a proxy for creating a formatter implementation.
FormatterFactoryMaker - Class in org.daisy.dotify.api.formatter: Provides a factory for formatters.
FormatterFactoryMaker() - Constructor for class org.daisy.dotify.api.formatter.FormatterFactoryMaker: Creates a new formatter factory maker
FormatterSequence - Interface in org.daisy.dotify.api.formatter: Provides an interface for a formatter sequence
FormattingTypes - Interface in org.daisy.dotify.api.formatter: Provides common formatting types.
FormattingTypes.Alignment - Enum in org.daisy.dotify.api.formatter: Defines alignment options.
FormattingTypes.BreakBefore - Enum in org.daisy.dotify.api.formatter: Defines break before types.
FormattingTypes.Keep - Enum in org.daisy.dotify.api.formatter: Defines rows in block keep types.
FormattingTypes.ListStyle - Enum in org.daisy.dotify.api.formatter: Defines list styles.

G

getAfterArea() - Method in interface org.daisy.dotify.api.formatter.PageAreaBuilder: Gets a formatter core for the area after the page area.
getAlign() - Method in class org.daisy.dotify.api.translator.BorderSpecification: Gets the alignment of this border
getAlignment() - Method in class org.daisy.dotify.api.formatter.BlockPosition: Get the alignment center for the block that this object positions
getAlignment() - Method in class org.daisy.dotify.api.formatter.Leader: Get the Alignment for this Leader.
getAlignment() - Method in class org.daisy.dotify.api.formatter.PageAreaProperties: Gets the alignment of the page area.
getAlignment() - Method in class org.daisy.dotify.api.formatter.TextBlockProperties: Gets the alignment
getApplicationRange() - Method in class org.daisy.dotify.api.formatter.TransitionBuilderProperties: Gets the application range starting from the end of the volume.
getAttribute() - Method in class org.daisy.dotify.api.writer.MetaDataItem: Gets the attribute, if specified or null
getAttributes() - Method in class org.daisy.dotify.api.translator.Translatable: Gets the text attributes for the text
getBeforeArea() - Method in interface org.daisy.dotify.api.formatter.PageAreaBuilder: Gets a formatter core for the area before the page area.
getBeginLimit() - Method in interface org.daisy.dotify.api.hyphenator.HyphenatorInterface: Gets the begin limit.
getBlockIndent() - Method in class org.daisy.dotify.api.formatter.BlockProperties: Get block indent, in characters
getBlockInterruptedBuilder() - Method in interface org.daisy.dotify.api.formatter.TransitionBuilder: Gets the builder for contents to add when a block is interrupted before a volume break.
getBlockResumedBuilder() - Method in interface org.daisy.dotify.api.formatter.TransitionBuilder: Gets the builder for contents to add when a block is resumed after a volume break.
getBorder() - Method in class org.daisy.dotify.api.formatter.LayoutMasterProperties: Gets the page border to use
getBorder() - Method in class org.daisy.dotify.api.formatter.TableCellProperties: Gets the border, or null if not set
getBorder() - Method in class org.daisy.dotify.api.formatter.TableProperties: Gets the border, or null if not set
getBottom() - Method in class org.daisy.dotify.api.translator.Border.Builder.BuilderView: Gets the bottom edge view of the builder.
getBottom() - Method in class org.daisy.dotify.api.translator.Border.Builder: Gets the bottom builder view.
getBottom() - Method in class org.daisy.dotify.api.translator.Border: Gets the specification for this border's bottom edge.
getBottomBorder() - Method in class org.daisy.dotify.api.translator.TextBorderStyle: Gets the bottom component pattern.
getBottomLeftCorner() - Method in class org.daisy.dotify.api.translator.TextBorderStyle: Gets the bottom left corner component.
getBottomRightCorner() - Method in class org.daisy.dotify.api.translator.TextBorderStyle: Gets the bottom right corner component.
getBottomSpacing() - Method in class org.daisy.dotify.api.formatter.BlockSpacing: Get bottom spacing, in characters
getBreakBeforeType() - Method in class org.daisy.dotify.api.formatter.BlockProperties: Get break before type
getBreakBeforeType() - Method in class org.daisy.dotify.api.formatter.SequenceProperties: Get break before type
getChars() - Method in interface org.daisy.dotify.api.writer.Row: Gets the characters
getCollectionID() - Method in class org.daisy.dotify.api.formatter.ItemSequenceProperties: Gets the collection identifier.
getCollectionId() - Method in class org.daisy.dotify.api.formatter.PageAreaProperties: Gets the id of the associated collection.
getColSpan() - Method in class org.daisy.dotify.api.formatter.TableCellProperties: Gets the column span, in other words, the number of columns that this cell spans.
getCondition() - Method in class org.daisy.dotify.api.formatter.VolumeTemplateProperties: Gets the condition for applying the volume template
getConfiguration() - Method in interface org.daisy.dotify.api.formatter.Formatter: Gets the formatter configuration
getCurrentPage() - Method in interface org.daisy.dotify.api.formatter.Context: Gets the current page number (one based) or null if not known.
getCurrentVolume() - Method in interface org.daisy.dotify.api.formatter.Context: Gets the current volume number (one based) or null if not known.
getDefault() - Method in class org.daisy.dotify.api.translator.Border.Builder.BuilderView: Gets the default edge view of the builder.
getDefault() - Method in class org.daisy.dotify.api.translator.Border.Builder: Gets the default builder view.
getDefaultListLabel() - Method in class org.daisy.dotify.api.formatter.BlockProperties: Gets the default list label for this list
getDictionaryIdentifier() - Method in class org.daisy.dotify.api.translator.DefaultTextAttribute
getDictionaryIdentifier() - Method in interface org.daisy.dotify.api.translator.TextAttribute: Gets the dictionary identifier that applies to this text attribute.
getEndLimit() - Method in interface org.daisy.dotify.api.hyphenator.HyphenatorInterface: Gets the end limit.
getFactory() - Method in class org.daisy.dotify.api.engine.FormatterEngineMaker: Gets a formatter engine factory service.
getFactory() - Method in class org.daisy.dotify.api.formatter.FormatterFactoryMaker: Gets a formatter factory
getFactory() - Method in class org.daisy.dotify.api.obfl.ExpressionFactoryMaker: Gets an expression factory.
getFactory() - Method in class org.daisy.dotify.api.obfl.ObflParserFactoryMaker: Gets the OBFL parser factory service.
getFactory(String) - Method in class org.daisy.dotify.api.text.Integer2TextFactoryMaker
getFactory(String) - Method in interface org.daisy.dotify.api.text.Integer2TextFactoryMakerService: Gets a Integer2TextFactory that supports the specified locale
getFactory(String) - Method in class org.daisy.dotify.api.writer.PagedMediaWriterFactoryMaker
getFactory(String) - Method in interface org.daisy.dotify.api.writer.PagedMediaWriterFactoryMakerService: Gets a PagedMediaWriterFactory that supports the specified media type
getFallbackRules() - Method in class org.daisy.dotify.api.formatter.PageAreaProperties: Gets the fallback rules.
getFeature(String) - Method in interface org.daisy.dotify.api.hyphenator.HyphenatorFactory: Gets the value of a hyphenation feature.
getFeature(String) - Method in interface org.daisy.dotify.api.text.Integer2TextFactory: Gets the value of a integer2text feature.
getFeature(String) - Method in interface org.daisy.dotify.api.translator.TextBorderFactory: Gets the value for the specified feature key.
getFeature(String) - Method in interface org.daisy.dotify.api.writer.PagedMediaWriterFactory: Gets the value of a PagedMediaWriter feature.
getFields() - Method in class org.daisy.dotify.api.formatter.FieldList: Gets the list of fields.
getFirstLineIndent() - Method in class org.daisy.dotify.api.formatter.TextBlockProperties: Get first line indent, in characters
getFlowWidth() - Method in class org.daisy.dotify.api.formatter.LayoutMasterProperties: Gets the width available for the text body.
getIdentifier() - Method in class org.daisy.dotify.api.formatter.TextBlockProperties: Gets the identifier
getIgnoredStyles() - Method in class org.daisy.dotify.api.formatter.FormatterConfiguration: Gets a set of ignored styles
getIndicator() - Method in class org.daisy.dotify.api.formatter.MarkerIndicator: Gets the occurrence indicator string
getIndicators() - Method in class org.daisy.dotify.api.formatter.MarkerIndicatorRegion: Gets the list of indicators.
getInitialPageNumber() - Method in class org.daisy.dotify.api.formatter.SequenceProperties: Get the initial page number, i.e.
getInnerMargin() - Method in class org.daisy.dotify.api.formatter.LayoutMasterProperties: Gets the width of the inner margin, in characters.
getInstance() - Static method in class org.daisy.dotify.api.formatter.NoField: Gets the singleton instance.
getKeepType() - Method in class org.daisy.dotify.api.formatter.BlockProperties: Get keep type
getKeepWithNext() - Method in class org.daisy.dotify.api.formatter.BlockProperties: Get the number of rows containing text in the next block that must be on the same page as this block
getKeepWithNextSheets() - Method in class org.daisy.dotify.api.formatter.BlockProperties: Gets the number of next sheets to keep in the same volume as this block
getKeepWithPreviousSheets() - Method in class org.daisy.dotify.api.formatter.BlockProperties: Gets the number of previous sheets to keep in the same volume as this block
getKey() - Method in class org.daisy.dotify.api.writer.MetaDataItem: Gets the element name
getLeft() - Method in class org.daisy.dotify.api.translator.Border.Builder.BuilderView: Gets the left edge view of the builder.
getLeft() - Method in class org.daisy.dotify.api.translator.Border.Builder: Gets the left builder view.
getLeft() - Method in class org.daisy.dotify.api.translator.Border: Gets the specification for this border's left edge.
getLeftBorder() - Method in class org.daisy.dotify.api.translator.TextBorderStyle: Gets the left border component.
getLeftSpacing() - Method in class org.daisy.dotify.api.formatter.BlockSpacing: Get left spacing, in characters
getListItemLabel() - Method in class org.daisy.dotify.api.formatter.BlockProperties: Gets the list item label
getListNumberFormat() - Method in class org.daisy.dotify.api.formatter.BlockProperties: Gets the number format for this list
getListType() - Method in class org.daisy.dotify.api.formatter.BlockProperties: Get list type
getLocale() - Method in class org.daisy.dotify.api.formatter.FormatterConfiguration: Gets the locale
getLocale() - Method in class org.daisy.dotify.api.formatter.TextProperties: Gets the locale of this text properties
getLocale() - Method in class org.daisy.dotify.api.translator.Translatable: Gets the locale for the text
getLocale() - Method in class org.daisy.dotify.api.translator.TranslatorSpecification: Gets the locale.
getMargin() - Method in class org.daisy.dotify.api.formatter.BlockProperties: Gets the margin
getMargin() - Method in class org.daisy.dotify.api.formatter.TableProperties: Gets the margin
getMasterName() - Method in class org.daisy.dotify.api.formatter.SequenceProperties: Get the name for the LayoutMaster
getMaxHeight() - Method in class org.daisy.dotify.api.formatter.PageAreaProperties: Gets the maximum height allowed to be used by the page area, in rows.
getMetaData() - Method in interface org.daisy.dotify.api.obfl.ObflParser: Gets a list of meta data items collected by the latest call to ObflParser.parse(XMLEventReader, Formatter).
getMetaPage() - Method in interface org.daisy.dotify.api.formatter.Context: Gets the page number (one based) of the context described the current context, or null if not available.
getMetaVolume() - Method in interface org.daisy.dotify.api.formatter.Context: Gets the volume number (one based) of the context described in the current context, or null if not available.
getMetric(String) - Method in interface org.daisy.dotify.api.translator.BrailleTranslatorResult: Gets the value of a given metric.
getMode() - Method in class org.daisy.dotify.api.translator.TranslatorSpecification: Gets the translator mode.
getName() - Method in class org.daisy.dotify.api.formatter.Marker: Get the name of this Marker.
getName() - Method in class org.daisy.dotify.api.formatter.MarkerIndicator: Gets the name of the markers to indicate
getName() - Method in class org.daisy.dotify.api.formatter.MarkerReferenceField: Gets the name of this marker reference field
getName() - Method in class org.daisy.dotify.api.writer.AttributeItem: Gets the attribute name
getNumeralStyle() - Method in class org.daisy.dotify.api.formatter.NumeralField: Gets the numeral style.
getOffset(int) - Method in enum org.daisy.dotify.api.formatter.FormattingTypes.Alignment: Gets the alignment offset based on available space.
getOffset() - Method in class org.daisy.dotify.api.formatter.MarkerReferenceField: Gets the page offset where to start the search
getOrphans() - Method in class org.daisy.dotify.api.formatter.BlockProperties: Gets the minimum number of lines of a paragraph that must be left at the bottom of a page.
getOuterMargin() - Method in class org.daisy.dotify.api.formatter.LayoutMasterProperties: Gets the width of the outer margin, in characters.
getPadding() - Method in class org.daisy.dotify.api.formatter.BlockProperties: Gets the padding
getPadding() - Method in class org.daisy.dotify.api.formatter.TableCellProperties: Gets the padding
getPadding() - Method in class org.daisy.dotify.api.formatter.TableProperties: Gets the padding
getPageCounterName() - Method in class org.daisy.dotify.api.formatter.SequenceProperties: Gets the page counter name.
getPageHeight() - Method in class org.daisy.dotify.api.formatter.LayoutMasterProperties: Gets the page height, in characters.
getPageHeight() - Method in interface org.daisy.dotify.api.writer.SectionProperties: Gets the page height.
getPagesInDocument() - Method in interface org.daisy.dotify.api.formatter.Context: Gets the total number of pages contained in the document, or null if not known.
getPagesInVolume() - Method in interface org.daisy.dotify.api.formatter.Context: Gets the total number of pages contained in the current volume, or null if not known.
getPageWidth() - Method in class org.daisy.dotify.api.formatter.LayoutMasterProperties: Gets the page width, in characters.
getPageWidth() - Method in interface org.daisy.dotify.api.writer.SectionProperties: Gets the page width.
getPattern() - Method in class org.daisy.dotify.api.formatter.Leader: Get the pattern for this Leader.
getPosition() - Method in class org.daisy.dotify.api.formatter.BlockPosition: Gets the row for the block that this object positions.
getPosition() - Method in class org.daisy.dotify.api.formatter.Leader: Get the Position for this Leader.
getPostVolumeContentBuilder() - Method in interface org.daisy.dotify.api.formatter.VolumeTemplateBuilder: Gets the post volume content builder.
getPreferredEmtpySpace() - Method in class org.daisy.dotify.api.formatter.TableProperties: Gets the preferred empty space in table cells when the text content is shorter than the available maximum column width
getPreVolumeContentBuilder() - Method in interface org.daisy.dotify.api.formatter.VolumeTemplateBuilder: Gets the pre volume content builder.
getProperties() - Method in interface org.daisy.dotify.api.formatter.TransitionBuilder: Gets the properties for this transition builder.
getRange() - Method in class org.daisy.dotify.api.formatter.ItemSequenceProperties: Gets the range of this item sequence
getRange() - Method in class org.daisy.dotify.api.formatter.TocProperties: Gets the toc range.
getRight() - Method in class org.daisy.dotify.api.translator.Border.Builder.BuilderView: Gets the right edge view of the builder.
getRight() - Method in class org.daisy.dotify.api.translator.Border.Builder: Gets the right builder view.
getRight() - Method in class org.daisy.dotify.api.translator.Border: Gets the specification for this border's right edge.
getRightBorder() - Method in class org.daisy.dotify.api.translator.TextBorderStyle: Gets the right border component.
getRightSpacing() - Method in class org.daisy.dotify.api.formatter.BlockSpacing: Get right spacing, in characters
getRowSpacing() - Method in class org.daisy.dotify.api.formatter.FieldList: Gets the row-spacing following this field list.
getRowSpacing() - Method in class org.daisy.dotify.api.formatter.LayoutMasterProperties: Gets the row spacing, in character heights.
getRowSpacing() - Method in class org.daisy.dotify.api.formatter.TableProperties: Gets the row spacing, or null if not set.
getRowSpacing() - Method in class org.daisy.dotify.api.formatter.TextBlockProperties: Gets the row spacing, or null if not set
getRowSpacing() - Method in interface org.daisy.dotify.api.writer.Row: Gets the row spacing, in rows
getRowSpacing() - Method in interface org.daisy.dotify.api.writer.SectionProperties: Gets row spacing, in row heights.
getRowSpan() - Method in class org.daisy.dotify.api.formatter.TableCellProperties: Gets the row span, in other words, the number of rows that this cell spans.
getScenarios() - Method in interface org.daisy.dotify.api.formatter.DynamicRenderer: Gets the rendering scenarios in this renderer.
getSearchDirection() - Method in class org.daisy.dotify.api.formatter.MarkerReferenceField: Gets the direction of the search
getSearchScope() - Method in class org.daisy.dotify.api.formatter.MarkerReferenceField: Gets the scope of the search
getSequenceInterruptedBuilder() - Method in interface org.daisy.dotify.api.formatter.TransitionBuilder: Gets the builder for contents to add when a sequence is interrupted before a volume break.
getSequenceResumedBuilder() - Method in interface org.daisy.dotify.api.formatter.TransitionBuilder: Gets the builder for contents to add when a sequence is resumed after a volume break.
getSheetsInDocument() - Method in interface org.daisy.dotify.api.formatter.Context: Gets the total number of sheets contained in the document, or null if not known.
getSheetsInVolume() - Method in interface org.daisy.dotify.api.formatter.Context: Gets the total number of sheets contained in the current volume, or null if not known.
getSplitterMax() - Method in class org.daisy.dotify.api.formatter.VolumeTemplateProperties: Gets the maximum number of sheets allowed in a volume that uses this template.
getStyle() - Method in class org.daisy.dotify.api.translator.BorderSpecification: Gets the style of this border
getTableColSpacing() - Method in class org.daisy.dotify.api.formatter.TableProperties: Gets the table column spacing, in other words the horizontal spacing between two columns of table cells.
getTableRowSpacing() - Method in class org.daisy.dotify.api.formatter.TableProperties: Gets the table row spacing, in other words the vertical spacing between two rows of table cells.
getText() - Method in class org.daisy.dotify.api.translator.Translatable: Gets the text
getTextBlockProperties() - Method in class org.daisy.dotify.api.formatter.BlockProperties: Gets the text block properties for this block
getTextBlockProperties() - Method in class org.daisy.dotify.api.formatter.TableCellProperties: Gets the text block properties
getTextBorderStyle() - Method in class org.daisy.dotify.api.formatter.BlockProperties: Gets the text border style for this block
getTextIndent() - Method in class org.daisy.dotify.api.formatter.TextBlockProperties: Get text indent, in characters
getTextStyle() - Method in class org.daisy.dotify.api.formatter.CompoundField
getTextStyle() - Method in interface org.daisy.dotify.api.formatter.Field: The text style of the field, or null if no special style is used.
getTextStyle() - Method in class org.daisy.dotify.api.formatter.MarkerReferenceField
getTextStyle() - Method in class org.daisy.dotify.api.formatter.NoField
getTextStyle() - Method in class org.daisy.dotify.api.formatter.NumeralField
getTextStyle() - Method in class org.daisy.dotify.api.formatter.StringField
getTocName() - Method in class org.daisy.dotify.api.formatter.TocProperties: Gets the toc identifier.
getToCollection() - Method in class org.daisy.dotify.api.formatter.RenameFallbackRule: Gets the new identifier for this collection
getTop() - Method in class org.daisy.dotify.api.translator.Border.Builder.BuilderView: Gets the top edge view of the builder.
getTop() - Method in class org.daisy.dotify.api.translator.Border.Builder: Gets the top builder view.
getTop() - Method in class org.daisy.dotify.api.translator.Border: Gets the specification for this border's top edge.
getTopBorder() - Method in class org.daisy.dotify.api.translator.TextBorderStyle: Gets the top component pattern.
getTopLeftCorner() - Method in class org.daisy.dotify.api.translator.TextBorderStyle: Gets the top left corner component.
getTopRightCorner() - Method in class org.daisy.dotify.api.translator.TextBorderStyle: Gets the top right corner component.
getTopSpacing() - Method in class org.daisy.dotify.api.formatter.BlockSpacing: Get top spacing, in characters
getTransitionBuilder() - Method in interface org.daisy.dotify.api.formatter.Formatter: Gets the transition builder.
getTranslatedRemainder() - Method in interface org.daisy.dotify.api.translator.BrailleTranslatorResult: Gets the translated remainder, in other words the characters not yet extracted with nextTranslatedRow.
getTranslationMode() - Method in class org.daisy.dotify.api.formatter.FormatterConfiguration: Gets the translation mode
getTranslationMode() - Method in class org.daisy.dotify.api.formatter.TextProperties: Gets the translation mode
getTranslatorMode() - Method in interface org.daisy.dotify.api.translator.BrailleTranslator: Gets the translator mode of this translator.
getUnderlineStyle() - Method in class org.daisy.dotify.api.formatter.BlockProperties: Gets the underline pattern for this block
getValue() - Method in class org.daisy.dotify.api.formatter.Marker: Get the value of this Marker
getValue() - Method in class org.daisy.dotify.api.formatter.Position: Gets the position value
getValue() - Method in class org.daisy.dotify.api.writer.AttributeItem: Gets the attribute value
getValue() - Method in class org.daisy.dotify.api.writer.MetaDataItem: Gets the text contents of this meta data item
getVerticalPosition() - Method in class org.daisy.dotify.api.formatter.BlockProperties: Gets the vertical position for this block
getVolumeCount() - Method in interface org.daisy.dotify.api.formatter.Context: Gets the volume count or null if not known.
getVolumeKeepPriority() - Method in class org.daisy.dotify.api.formatter.BlockProperties: Gets volume keep priority
getWidows() - Method in class org.daisy.dotify.api.formatter.BlockProperties: Gets the minimum number of lines of a paragraph that must be left at the top of a page.
getWidth() - Method in interface org.daisy.dotify.api.formatter.MarginRegion: Gets the width of the region, in columns.
getWidth() - Method in class org.daisy.dotify.api.formatter.MarkerIndicatorRegion
getWidth() - Method in class org.daisy.dotify.api.translator.BorderSpecification: Gets the width of this border
getWidth() - Method in class org.daisy.dotify.api.translator.DefaultTextAttribute
getWidth() - Method in interface org.daisy.dotify.api.translator.TextAttribute: Gets the width of this object

H

hasChildren() - Method in class org.daisy.dotify.api.translator.DefaultTextAttribute
hasChildren() - Method in interface org.daisy.dotify.api.translator.TextAttribute: Returns true if this object has text attribute children.
hashCode() - Method in class org.daisy.dotify.api.formatter.BlockPosition
hashCode() - Method in class org.daisy.dotify.api.formatter.BlockProperties
hashCode() - Method in class org.daisy.dotify.api.formatter.BlockSpacing
hashCode() - Method in class org.daisy.dotify.api.formatter.MarkerIndicator
hashCode() - Method in class org.daisy.dotify.api.formatter.MarkerIndicatorRegion
hashCode() - Method in class org.daisy.dotify.api.formatter.Position
hashCode() - Method in class org.daisy.dotify.api.formatter.TableCellProperties
hashCode() - Method in class org.daisy.dotify.api.formatter.TableProperties
hashCode() - Method in class org.daisy.dotify.api.formatter.TextBlockProperties
hashCode() - Method in class org.daisy.dotify.api.formatter.TextProperties
hashCode() - Method in class org.daisy.dotify.api.translator.TextBorderStyle
hashCode() - Method in class org.daisy.dotify.api.translator.TranslatorSpecification
hasNext() - Method in interface org.daisy.dotify.api.translator.BrailleTranslatorResult: Returns true if there are characters remaining in the result, in other words of there are characters not yet extracted with nextTranslatedRow.
hyphenate(boolean) - Method in class org.daisy.dotify.api.formatter.FormatterConfiguration.Builder: Sets the global hyphenation policy
hyphenate(boolean) - Method in class org.daisy.dotify.api.formatter.TextProperties.Builder: Sets the hyphenate value for this builder
hyphenate(String) - Method in interface org.daisy.dotify.api.hyphenator.HyphenatorInterface: Hyphenates the phrase, inserting soft hyphens at all possible breakpoints.
hyphenate(boolean) - Method in class org.daisy.dotify.api.translator.Translatable.Builder: Sets the hyphenate property for this builder
HyphenatorConfigurationException - Exception in org.daisy.dotify.api.hyphenator: Provides an exception that indicates that a feature is not supported.
HyphenatorConfigurationException() - Constructor for exception org.daisy.dotify.api.hyphenator.HyphenatorConfigurationException
HyphenatorConfigurationException(String) - Constructor for exception org.daisy.dotify.api.hyphenator.HyphenatorConfigurationException
HyphenatorConfigurationException(Throwable) - Constructor for exception org.daisy.dotify.api.hyphenator.HyphenatorConfigurationException
HyphenatorConfigurationException(String, Throwable) - Constructor for exception org.daisy.dotify.api.hyphenator.HyphenatorConfigurationException
HyphenatorFactory - Interface in org.daisy.dotify.api.hyphenator: Provides a hyphenation factory interface.
HyphenatorFactoryMaker - Class in org.daisy.dotify.api.hyphenator: Provides a hyphenator factory maker.
HyphenatorFactoryMaker() - Constructor for class org.daisy.dotify.api.hyphenator.HyphenatorFactoryMaker: Creates a new formatter factory maker.
HyphenatorFactoryMakerService - Interface in org.daisy.dotify.api.hyphenator: Provides an interface for a HyphenatorFactoryMaker service.
HyphenatorFactoryService - Interface in org.daisy.dotify.api.hyphenator: Provides an interface for a HyphenatorFactory service.
HyphenatorInterface - Interface in org.daisy.dotify.api.hyphenator: Provides a hyphenator.

I

identifier(String) - Method in class org.daisy.dotify.api.formatter.BlockProperties.Builder: Sets the identifier for the block
identifier(String) - Method in class org.daisy.dotify.api.formatter.TextBlockProperties.Builder: Sets the identifier for the block.
ignoreStyle(String) - Method in class org.daisy.dotify.api.formatter.FormatterConfiguration.Builder: Adds a style to ignore
initialPageNumber(int) - Method in class org.daisy.dotify.api.formatter.SequenceProperties.Builder: Set the initialPageNumber for the SequenceProperties instances created using this Builder
innerMargin(int) - Method in class org.daisy.dotify.api.formatter.LayoutMasterProperties.Builder: Sets the inner margin, that is to say the margin closest to the binding edge of the page.
insertAnchor(String) - Method in interface org.daisy.dotify.api.formatter.BlockContentBuilder: Insert an anchor at the current position in the flow
insertDynamicLayout(DynamicRenderer) - Method in interface org.daisy.dotify.api.formatter.FormatterCore: Inserts a dynamic layout processor
insertEvaluate(DynamicContent, TextProperties) - Method in interface org.daisy.dotify.api.formatter.BlockContentBuilder: Inserts an expression to evaluate.
insertLeader(Leader) - Method in interface org.daisy.dotify.api.formatter.BlockContentBuilder: Insert a leader at the current position in the flow
insertMarker(Marker) - Method in interface org.daisy.dotify.api.formatter.BlockContentBuilder: Insert a marker at the current position in the flow
insertReference(String, NumeralStyle) - Method in interface org.daisy.dotify.api.formatter.BlockContentBuilder: Adds the page number of a reference.
Integer2Text - Interface in org.daisy.dotify.api.text: Provides an integer2text.
Integer2TextConfigurationException - Exception in org.daisy.dotify.api.text: Provides an exception to indicate problems when configuring an integer to text factory or instance.
Integer2TextConfigurationException() - Constructor for exception org.daisy.dotify.api.text.Integer2TextConfigurationException
Integer2TextConfigurationException(String) - Constructor for exception org.daisy.dotify.api.text.Integer2TextConfigurationException
Integer2TextConfigurationException(Throwable) - Constructor for exception org.daisy.dotify.api.text.Integer2TextConfigurationException
Integer2TextConfigurationException(String, Throwable) - Constructor for exception org.daisy.dotify.api.text.Integer2TextConfigurationException
Integer2TextFactory - Interface in org.daisy.dotify.api.text: Provides a integer2text factory interface.
Integer2TextFactoryMaker - Class in org.daisy.dotify.api.text: Provides a integer2text factory maker.
Integer2TextFactoryMaker() - Constructor for class org.daisy.dotify.api.text.Integer2TextFactoryMaker: Creates a new integer to text factory maker.
Integer2TextFactoryMakerService - Interface in org.daisy.dotify.api.text: Provides an interface for a Integer2TextFactoryMaker service.
Integer2TextFactoryService - Interface in org.daisy.dotify.api.text: Provides an interface for a Integer2TextFactory service.
IntegerOutOfRange - Exception in org.daisy.dotify.api.text: Thrown to indicate that an integer cannot be converted to text because it is out of range of the capabilities of the implementation.
IntegerOutOfRange() - Constructor for exception org.daisy.dotify.api.text.IntegerOutOfRange: Constructs an IntegerOutOfRange with no detail message.
IntegerOutOfRange(String) - Constructor for exception org.daisy.dotify.api.text.IntegerOutOfRange: Constructs an IntegerOutOfRange class with the specified detail message.
IntegerOutOfRange(Throwable) - Constructor for exception org.daisy.dotify.api.text.IntegerOutOfRange
IntegerOutOfRange(String, Throwable) - Constructor for exception org.daisy.dotify.api.text.IntegerOutOfRange
intToText(int) - Method in interface org.daisy.dotify.api.text.Integer2Text: Converts the integer to text.
isAllowingTextOverflowTrimming() - Method in class org.daisy.dotify.api.formatter.FormatterConfiguration: Returns true if text that overflows is allowed to be truncated, false otherwise.
isHyphenating() - Method in class org.daisy.dotify.api.formatter.FormatterConfiguration: Returns true if the formatter is hyphenating
isHyphenating() - Method in class org.daisy.dotify.api.formatter.TextProperties: Returns true if the hyphenating property is true, false otherwise
isHyphenating() - Method in class org.daisy.dotify.api.translator.Translatable: Returns true if the text should be hyphenated.
isMarkingCapitalLetters() - Method in class org.daisy.dotify.api.formatter.FormatterConfiguration: Returns true if capital letters should be marked, false otherwise
isRelative() - Method in class org.daisy.dotify.api.formatter.Position: Returns true if this Position is relative, false otherwise
ItemSequenceProperties - Class in org.daisy.dotify.api.formatter: Defines properties specific for an item sequence.
ItemSequenceProperties.Builder - Class in org.daisy.dotify.api.formatter: Provides a builder for creating ItemSequenceProperties instances.
ItemSequenceProperties.Range - Enum in org.daisy.dotify.api.formatter: Defines ranges.
iterator() - Method in class org.daisy.dotify.api.translator.DefaultTextAttribute

K

keep(FormattingTypes.Keep) - Method in class org.daisy.dotify.api.formatter.BlockProperties.Builder: Set the keep property for the block.
keepWithNext(int) - Method in class org.daisy.dotify.api.formatter.BlockProperties.Builder: Set the keep with next property for the block.
keepWithNextSheets(int) - Method in class org.daisy.dotify.api.formatter.BlockProperties.Builder: Sets the keep with next sheets property for the block.
keepWithPreviousSheets(int) - Method in class org.daisy.dotify.api.formatter.BlockProperties.Builder: Sets the keep with previous sheets property for the block.

L

LayoutEngineException - Exception in org.daisy.dotify.api.engine: Provides an exception for the FormatterEngine.
LayoutEngineException() - Constructor for exception org.daisy.dotify.api.engine.LayoutEngineException: Constructs a new exception with null as its detail message.
LayoutEngineException(String) - Constructor for exception org.daisy.dotify.api.engine.LayoutEngineException: Constructs a new exception with the specified detail message.
LayoutEngineException(Throwable) - Constructor for exception org.daisy.dotify.api.engine.LayoutEngineException: Constructs a new exception with the specified cause and a detail message of (cause==null ? null : cause.toString()) (which typically contains the class and detail message of cause).
LayoutEngineException(String, Throwable) - Constructor for exception org.daisy.dotify.api.engine.LayoutEngineException: Constructs a new exception with the specified detail message and cause.
LayoutMasterBuilder - Interface in org.daisy.dotify.api.formatter: Provides a builder for a layout master.
LayoutMasterProperties - Class in org.daisy.dotify.api.formatter: Provides properties for a LayoutMaster.
LayoutMasterProperties.Builder - Class in org.daisy.dotify.api.formatter: Configuration class for a ConfigurableLayoutMaster
Leader - Class in org.daisy.dotify.api.formatter: Leader is a data object used when separating two chunks of text within a single row.
Leader(Leader.Builder) - Constructor for class org.daisy.dotify.api.formatter.Leader
Leader(Leader) - Constructor for class org.daisy.dotify.api.formatter.Leader
Leader.Alignment - Enum in org.daisy.dotify.api.formatter: Alignment values for leaders
Leader.Builder - Class in org.daisy.dotify.api.formatter: The Builder is used when creating a Leader instance
leftBorder(String) - Method in class org.daisy.dotify.api.translator.TextBorderStyle.Builder: Sets the left border pattern
leftMargin(int) - Method in class org.daisy.dotify.api.formatter.BlockProperties.Builder: Set the left margin for the block, in characters.
leftPadding(int) - Method in class org.daisy.dotify.api.formatter.BlockProperties.Builder: Set the left padding for the block, in characters.
leftSpacing(int) - Method in class org.daisy.dotify.api.formatter.BlockSpacing.Builder: Set the left spacing for the block, in characters.
length - Variable in class org.daisy.dotify.api.translator.DefaultTextAttribute
listItemLabel(String) - Method in class org.daisy.dotify.api.formatter.BlockProperties.Builder: Sets the list item label for the block.
listLocales() - Method in class org.daisy.dotify.api.hyphenator.HyphenatorFactoryMaker
listLocales() - Method in interface org.daisy.dotify.api.hyphenator.HyphenatorFactoryMakerService: Returns a list of supported locales as defined by IETF RFC 3066.
listLocales() - Method in interface org.daisy.dotify.api.hyphenator.HyphenatorFactoryService: Returns a list of supported locales as defined by IETF RFC 3066.
listLocales() - Method in class org.daisy.dotify.api.text.Integer2TextFactoryMaker
listLocales() - Method in interface org.daisy.dotify.api.text.Integer2TextFactoryMakerService: Returns a list of supported locales as defined by IETF RFC 3066.
listLocales() - Method in interface org.daisy.dotify.api.text.Integer2TextFactoryService: Returns a list of supported locales as defined by IETF RFC 3066.
listMediaTypes() - Method in class org.daisy.dotify.api.writer.PagedMediaWriterFactoryMaker
listMediaTypes() - Method in interface org.daisy.dotify.api.writer.PagedMediaWriterFactoryMakerService: Returns a list of supported Internet media types.
listMediaTypes() - Method in interface org.daisy.dotify.api.writer.PagedMediaWriterFactoryService: Lists supported media types.
listNumberFormat(NumeralStyle) - Method in class org.daisy.dotify.api.formatter.BlockProperties.Builder: Sets the number format for the block.
listSpecifications() - Method in class org.daisy.dotify.api.translator.BrailleFilterFactoryMaker
listSpecifications() - Method in interface org.daisy.dotify.api.translator.BrailleFilterFactoryMakerService: Returns a list of supported specifications.
listSpecifications() - Method in interface org.daisy.dotify.api.translator.BrailleFilterFactoryService: Returns a list of supported specifications.
listSpecifications() - Method in class org.daisy.dotify.api.translator.BrailleTranslatorFactoryMaker
listSpecifications() - Method in interface org.daisy.dotify.api.translator.BrailleTranslatorFactoryMakerService: Returns a list of supported specifications.
listSpecifications() - Method in interface org.daisy.dotify.api.translator.BrailleTranslatorFactoryService: Returns a list of supported specifications.
listType(FormattingTypes.ListStyle) - Method in class org.daisy.dotify.api.formatter.BlockProperties.Builder: Set the list type for the block.
locale(String) - Method in class org.daisy.dotify.api.translator.Translatable.Builder: Sets the locale for this builder

M

makeAbsolute(int) - Method in class org.daisy.dotify.api.formatter.Position: Gets the absolute value for this Position by multiplying with the given width.
margin(BlockSpacing) - Method in class org.daisy.dotify.api.formatter.TableProperties.Builder: Sets the margin
MarginRegion - Interface in org.daisy.dotify.api.formatter: Provides a vertical margin region.
markCapitalLetters(boolean) - Method in class org.daisy.dotify.api.formatter.FormatterConfiguration.Builder: Sets the global capital letter policy
Marker - Class in org.daisy.dotify.api.formatter: A Marker is a reference data inserted at some point in the flow.
Marker(String, String) - Constructor for class org.daisy.dotify.api.formatter.Marker: Create a new Marker with the given name and value.
MarkerIndicator - Class in org.daisy.dotify.api.formatter: Provides a marker indicator
MarkerIndicator(String, String) - Constructor for class org.daisy.dotify.api.formatter.MarkerIndicator: Creates a new marker indicator with the specified parameters
MarkerIndicatorRegion - Class in org.daisy.dotify.api.formatter: Provides an marker indicator region.
MarkerIndicatorRegion.Builder - Class in org.daisy.dotify.api.formatter: Creates a new marker indicator region builder
MarkerProcessor - Interface in org.daisy.dotify.api.translator: Provides an interface to a marker processor.
MarkerProcessorConfigurationException - Exception in org.daisy.dotify.api.translator: Provides an exception that indicates a problem configuring a new marker processor instance.
MarkerProcessorConfigurationException() - Constructor for exception org.daisy.dotify.api.translator.MarkerProcessorConfigurationException
MarkerProcessorConfigurationException(String) - Constructor for exception org.daisy.dotify.api.translator.MarkerProcessorConfigurationException
MarkerProcessorConfigurationException(Throwable) - Constructor for exception org.daisy.dotify.api.translator.MarkerProcessorConfigurationException
MarkerProcessorConfigurationException(String, Throwable) - Constructor for exception org.daisy.dotify.api.translator.MarkerProcessorConfigurationException
MarkerProcessorFactory - Interface in org.daisy.dotify.api.translator: Provides a factory for braille markers.
MarkerProcessorFactoryMaker - Class in org.daisy.dotify.api.translator: Provides a marker processor factory maker.
MarkerProcessorFactoryMaker() - Constructor for class org.daisy.dotify.api.translator.MarkerProcessorFactoryMaker: Creates a new marker processor factory maker.
MarkerProcessorFactoryMakerService - Interface in org.daisy.dotify.api.translator: Provides an interface for a MarkerProcessorFactoryMaker service.
MarkerProcessorFactoryService - Interface in org.daisy.dotify.api.translator: Provides an interface for a MarkerProcessorFactory service.
MarkerReferenceField - Class in org.daisy.dotify.api.formatter: A MarkerReferenceField is a place holder for a marker's value.
MarkerReferenceField(String, MarkerReferenceField.MarkerSearchDirection, MarkerReferenceField.MarkerSearchScope) - Constructor for class org.daisy.dotify.api.formatter.MarkerReferenceField: Creates a new instance with the specified parameters
MarkerReferenceField(String, MarkerReferenceField.MarkerSearchDirection, MarkerReferenceField.MarkerSearchScope, String) - Constructor for class org.daisy.dotify.api.formatter.MarkerReferenceField: Creates a new instance with the specified parameters
MarkerReferenceField(String, MarkerReferenceField.MarkerSearchDirection, MarkerReferenceField.MarkerSearchScope, String, int) - Constructor for class org.daisy.dotify.api.formatter.MarkerReferenceField: Creates a new instance with the specified parameters
MarkerReferenceField.MarkerSearchDirection - Enum in org.daisy.dotify.api.formatter: Defines marker search directions.
MarkerReferenceField.MarkerSearchScope - Enum in org.daisy.dotify.api.formatter: Defines marker search scopes.
MediaTypes - Interface in org.daisy.dotify.api.writer: Provides internet media types for some types.
MetaDataItem - Class in org.daisy.dotify.api.writer: Provides a simple meta data item.
MetaDataItem(QName, String) - Constructor for class org.daisy.dotify.api.writer.MetaDataItem: Creates a new meta data item with the specified parameters.
MetaDataItem.Builder - Class in org.daisy.dotify.api.writer: Provides a meta data item builder.
METRIC_FORCED_BREAK - Static variable in interface org.daisy.dotify.api.translator.BrailleTranslatorResult: Metric identifier representing the total number of forced breaks applied on the instance up to this point.
METRIC_HYPHEN_COUNT - Static variable in interface org.daisy.dotify.api.translator.BrailleTranslatorResult: Metric identifier representing the total number of breaks applied at break points inside words on the instance up to this point.
MODE_BYPASS - Static variable in interface org.daisy.dotify.api.translator.BrailleTranslatorFactory: Defines bypass mode
MODE_UNCONTRACTED - Static variable in interface org.daisy.dotify.api.translator.BrailleTranslatorFactory: Defines uncontracted mode
mustBeContextCollection() - Method in interface org.daisy.dotify.api.formatter.FallbackRule: Returns true of the rule can only be applied to the context collection, in other words the collection that triggers the fallback actions.
mustBeContextCollection() - Method in class org.daisy.dotify.api.formatter.RenameFallbackRule

N

newCollection(String) - Method in interface org.daisy.dotify.api.formatter.Formatter: Creates a new collection with the supplied identifier
newDynamicSequence(SequenceProperties) - Method in interface org.daisy.dotify.api.formatter.VolumeContentBuilder: Creates a new dynamic sequence.
newExpression() - Method in interface org.daisy.dotify.api.obfl.ExpressionFactory: Creates a new expression implementation.
newFactory(String) - Method in class org.daisy.dotify.api.hyphenator.HyphenatorFactoryMaker
newFactory(String) - Method in interface org.daisy.dotify.api.hyphenator.HyphenatorFactoryMakerService: Gets a HyphenatorFactory that supports the specified locale
newFactory() - Method in interface org.daisy.dotify.api.hyphenator.HyphenatorFactoryService: Creates a new hyphenator factory.
newFactory() - Method in interface org.daisy.dotify.api.text.Integer2TextFactoryService: Creates a new integer to text factory.
newFactory(String, String) - Method in class org.daisy.dotify.api.translator.BrailleFilterFactoryMaker: Gets a factory for the given specification.
newFactory(String, String) - Method in interface org.daisy.dotify.api.translator.BrailleFilterFactoryMakerService: Gets a factory for the given specification.
newFactory() - Method in interface org.daisy.dotify.api.translator.BrailleFilterFactoryService: Creates a new braille filter factory.
newFactory(String, String) - Method in class org.daisy.dotify.api.translator.BrailleTranslatorFactoryMaker: Gets a factory for the given specification.
newFactory(String, String) - Method in interface org.daisy.dotify.api.translator.BrailleTranslatorFactoryMakerService: Gets a factory for the given specification.
newFactory() - Method in interface org.daisy.dotify.api.translator.BrailleTranslatorFactoryService: Creates a new braille translator factory.
newFactory(String, String) - Method in class org.daisy.dotify.api.translator.MarkerProcessorFactoryMaker
newFactory(String, String) - Method in interface org.daisy.dotify.api.translator.MarkerProcessorFactoryMakerService: Gets a factory for the given specification.
newFactory() - Method in interface org.daisy.dotify.api.translator.MarkerProcessorFactoryService: Creates a new marker processor factory
newFactory() - Method in interface org.daisy.dotify.api.translator.TextBorderFactoryService: Creates a new text border factory
newFactory(String) - Method in interface org.daisy.dotify.api.writer.PagedMediaWriterFactoryService: Creates a new paged media writer factory for the specified media type.
newFilter(String, String) - Method in interface org.daisy.dotify.api.translator.BrailleFilterFactory: Creates a new filter with the given specification
newFilter(String, String) - Method in class org.daisy.dotify.api.translator.BrailleFilterFactoryMaker
newFilter(String, String) - Method in interface org.daisy.dotify.api.translator.BrailleFilterFactoryMakerService: Gets a filter for the given specification
newFormatter(String, String) - Method in interface org.daisy.dotify.api.formatter.FormatterFactory: Creates a new formatter.
newFormatter(String, String) - Method in class org.daisy.dotify.api.formatter.FormatterFactoryMaker: Creates a new formatter with the specified options.
newFormatterEngine(String, String, PagedMediaWriter) - Method in interface org.daisy.dotify.api.engine.FormatterEngineFactoryService: Returns a new FormatterEngine configured for the specified locale, mode and output writer.
newFormatterEngine(FormatterConfiguration, PagedMediaWriter) - Method in interface org.daisy.dotify.api.engine.FormatterEngineFactoryService: Returns a new FormatterEngine configured with the specified configuration and output writer
newFormatterEngine(String, String, PagedMediaWriter) - Method in class org.daisy.dotify.api.engine.FormatterEngineMaker: Creates a new formatter engine
newHyphenator(String) - Method in interface org.daisy.dotify.api.hyphenator.HyphenatorFactory: Returns a new hyphenator configured for the specified locale.
newHyphenator(String) - Method in class org.daisy.dotify.api.hyphenator.HyphenatorFactoryMaker
newHyphenator(String) - Method in interface org.daisy.dotify.api.hyphenator.HyphenatorFactoryMakerService: Creates a new hyphenator.
newInstance() - Static method in class org.daisy.dotify.api.engine.FormatterEngineMaker: Creates a new formatter engine maker instance.
newInstance() - Static method in class org.daisy.dotify.api.formatter.FormatterFactoryMaker: Creates a new instance of a formatter factory maker
newInstance() - Static method in class org.daisy.dotify.api.hyphenator.HyphenatorFactoryMaker: Creates a new HyphenatorFactoryMaker and populates it using the SPI (java service provider interface).
newInstance() - Static method in class org.daisy.dotify.api.obfl.ExpressionFactoryMaker: Creates a new expression factory maker instance
newInstance() - Static method in class org.daisy.dotify.api.obfl.ObflParserFactoryMaker: Creates a new OBFL parser factory maker instance.
newInstance() - Static method in class org.daisy.dotify.api.text.Integer2TextFactoryMaker: Creates a new Integer2TextFactoryMaker and populates it using the SPI (java service provider interface).
newInstance() - Static method in class org.daisy.dotify.api.translator.BrailleFilterFactoryMaker: Creates a new BrailleFilterFactoryMaker and populates it using the SPI (java service provider interface).
newInstance() - Static method in class org.daisy.dotify.api.translator.BrailleTranslatorFactoryMaker: Creates a new BrailleTranslatorFactoryMaker and populates it using the SPI (java service provider interface).
newInstance() - Static method in class org.daisy.dotify.api.translator.MarkerProcessorFactoryMaker: Creates a new MarkerProcessorFactoryMaker and populates it using the SPI (java service provider interface).
newInstance() - Static method in class org.daisy.dotify.api.translator.TextBorderFactoryMaker: Creates a new TextBorderFactoryMaker and populates it using the SPI (java service provider interface).
newInstance() - Static method in class org.daisy.dotify.api.writer.PagedMediaWriterFactoryMaker: Creates a new PagedMediaWriterFactoryMaker and populates it using the SPI (java service provider interface).
newInteger2Text(String) - Method in interface org.daisy.dotify.api.text.Integer2TextFactory: Returns a new integer2text configured for the specified locale.
newInteger2Text(String) - Method in class org.daisy.dotify.api.text.Integer2TextFactoryMaker
newInteger2Text(String) - Method in interface org.daisy.dotify.api.text.Integer2TextFactoryMakerService: Creates a new integer2text.
newLayoutMaster(String, LayoutMasterProperties) - Method in interface org.daisy.dotify.api.formatter.Formatter: Creates a new LayoutMaster builder.
newLine() - Method in interface org.daisy.dotify.api.formatter.BlockContentBuilder: Explicitly break the current line, even if the line has space left for more characters.
newMarkerProcessor(String, String) - Method in interface org.daisy.dotify.api.translator.MarkerProcessorFactory: Creates a new marker processor with the given specification
newMarkerProcessor(String, String) - Method in class org.daisy.dotify.api.translator.MarkerProcessorFactoryMaker
newMarkerProcessor(String, String) - Method in interface org.daisy.dotify.api.translator.MarkerProcessorFactoryMakerService: Creates a new marker processor with the suppled specification.
newObflParser() - Method in interface org.daisy.dotify.api.obfl.ObflParserFactoryService: Creates a new ObflParser.
newOnCollectionEnd() - Method in interface org.daisy.dotify.api.formatter.ReferenceListBuilder: Creates a new on collection end block.
newOnCollectionStart() - Method in interface org.daisy.dotify.api.formatter.ReferenceListBuilder: Creates a new on collection start block.
newOnPageEnd() - Method in interface org.daisy.dotify.api.formatter.ReferenceListBuilder: Creates a new on page end block.
newOnPageStart() - Method in interface org.daisy.dotify.api.formatter.ReferenceListBuilder: Creates a new on page start block.
newOnTocEnd(Condition) - Method in interface org.daisy.dotify.api.formatter.VolumeContentBuilder: Creates a new on toc end block.
newOnTocEnd() - Method in interface org.daisy.dotify.api.formatter.VolumeContentBuilder: Creates a new on toc end block that always apply.
newOnTocStart(Condition) - Method in interface org.daisy.dotify.api.formatter.VolumeContentBuilder: Creates a new on toc start block.
newOnTocStart() - Method in interface org.daisy.dotify.api.formatter.VolumeContentBuilder: Creates a new on toc start block that always apply.
newOnVolumeEnd() - Method in interface org.daisy.dotify.api.formatter.ReferenceListBuilder: Creates a new on volume end block.
newOnVolumeEnd(Condition) - Method in interface org.daisy.dotify.api.formatter.VolumeContentBuilder: Creates a new on volume end block.
newOnVolumeEnd() - Method in interface org.daisy.dotify.api.formatter.VolumeContentBuilder: Creates a new on volume end block that always apply.
newOnVolumeStart() - Method in interface org.daisy.dotify.api.formatter.ReferenceListBuilder: Creates a new on volume start block.
newOnVolumeStart(Condition) - Method in interface org.daisy.dotify.api.formatter.VolumeContentBuilder: Creates a new on volume start block.
newOnVolumeStart() - Method in interface org.daisy.dotify.api.formatter.VolumeContentBuilder: Creates a new on volume start block that always apply.
newPage() - Method in interface org.daisy.dotify.api.writer.PagedMediaWriter: Inserts a new page in the output format, if applicable
newPagedMediaWriter() - Method in interface org.daisy.dotify.api.writer.PagedMediaWriterFactory: Returns a new PagedMediaWriter
newPagedMediaWriter(String) - Method in class org.daisy.dotify.api.writer.PagedMediaWriterFactoryMaker
newPagedMediaWriter(String) - Method in interface org.daisy.dotify.api.writer.PagedMediaWriterFactoryMakerService: Creates a new PagedMediaWriter.
newReferencesListContext(ItemSequenceProperties) - Method in interface org.daisy.dotify.api.formatter.DynamicSequenceBuilder: Creates a new reference list builder at the current position.
newRow(Row) - Method in interface org.daisy.dotify.api.writer.PagedMediaWriter: Add a new row to the current page
newRow() - Method in interface org.daisy.dotify.api.writer.PagedMediaWriter: Add a new empty row to the current page
newSection(SectionProperties) - Method in interface org.daisy.dotify.api.writer.PagedMediaWriter: Insert a new section in the output format, if applicable
newSequence(SequenceProperties) - Method in interface org.daisy.dotify.api.formatter.Formatter: Start a new Sequence at the current position in the flow.
newSequence(SequenceProperties) - Method in interface org.daisy.dotify.api.formatter.VolumeContentBuilder: Creates a new sequence at the current position.
newStaticContext() - Method in interface org.daisy.dotify.api.formatter.DynamicSequenceBuilder: Creates a new formatter core at the current position.
newTemplate(Condition) - Method in interface org.daisy.dotify.api.formatter.LayoutMasterBuilder: Adds a new template to the builder.
newTextBorderStyle() - Method in interface org.daisy.dotify.api.translator.TextBorderFactory: Creates a new TextBorderStyle based on the current features.
newTextBorderStyle(Map<String, Object>) - Method in class org.daisy.dotify.api.translator.TextBorderFactoryMaker
newTextBorderStyle(Map<String, Object>) - Method in interface org.daisy.dotify.api.translator.TextBorderFactoryMakerService: Creates a new text border style with the suppled specifications
newToc(String) - Method in interface org.daisy.dotify.api.formatter.Formatter: Creates a new table of contents with the supplied name
newTocSequence(TocProperties) - Method in interface org.daisy.dotify.api.formatter.VolumeContentBuilder: Creates a new toc sequence at the current position.
newTranslator(String, String) - Method in interface org.daisy.dotify.api.translator.BrailleTranslatorFactory: Creates a new translator with the given specification
newTranslator(String, String) - Method in class org.daisy.dotify.api.translator.BrailleTranslatorFactoryMaker
newTranslator(String, String) - Method in interface org.daisy.dotify.api.translator.BrailleTranslatorFactoryMakerService: Gets a translator for the given specification
newVolume(SectionProperties) - Method in interface org.daisy.dotify.api.writer.PagedMediaWriter: Inserts a new volume in the output format, if applicable
newVolumeTemplate(VolumeTemplateProperties) - Method in interface org.daisy.dotify.api.formatter.Formatter: Creates a new empty volume template builder.
nextTranslatedRow(int, boolean) - Method in interface org.daisy.dotify.api.translator.BrailleTranslatorResult: Gets the translated string preceding the row break, including a translated hyphen at the end, if needed.
nextTranslatedRow(int, boolean, boolean) - Method in interface org.daisy.dotify.api.translator.BrailleTranslatorResult: Gets the translated string preceding the row break, including a translated hyphen at the end, if needed.
NoField - Class in org.daisy.dotify.api.formatter: NoField represents the absence of a field in a header or footer.
NONE - Static variable in class org.daisy.dotify.api.translator.TextBorderStyle: Loaded on first access
NumeralField - Class in org.daisy.dotify.api.formatter: Provides a numeral field.
NumeralField(NumeralStyle) - Constructor for class org.daisy.dotify.api.formatter.NumeralField: Creates a new numeral field with the supplied style.
NumeralField(NumeralStyle, String) - Constructor for class org.daisy.dotify.api.formatter.NumeralField: Creates a new numeral field with the supplied numeral and text styles
NumeralStyle - Enum in org.daisy.dotify.api.formatter: Defines numeral styles

O

ObflParser - Interface in org.daisy.dotify.api.obfl: Provides an OBFL-parser.
ObflParserException - Exception in org.daisy.dotify.api.obfl: Provides an exception for conditions occuring when parsing an OBFL-file.
ObflParserException() - Constructor for exception org.daisy.dotify.api.obfl.ObflParserException: Constructs a new exception with null as its detail message.
ObflParserException(String) - Constructor for exception org.daisy.dotify.api.obfl.ObflParserException: Constructs a new exception with the specified detail message.
ObflParserException(Throwable) - Constructor for exception org.daisy.dotify.api.obfl.ObflParserException: Constructs a new exception with the specified cause and a detail message of (cause==null ? null : cause.toString()) (which typically contains the class and detail message of cause).
ObflParserException(String, Throwable) - Constructor for exception org.daisy.dotify.api.obfl.ObflParserException: Constructs a new exception with the specified detail message and cause.
ObflParserFactoryMaker - Class in org.daisy.dotify.api.obfl: Like all maker classes in the api, this class is only used directly in SPI context.
ObflParserFactoryMaker() - Constructor for class org.daisy.dotify.api.obfl.ObflParserFactoryMaker: Creates a new instance.
ObflParserFactoryService - Interface in org.daisy.dotify.api.obfl: Provides an interface for a ObflParserFactory service.
ofWidth(int) - Static method in class org.daisy.dotify.api.formatter.MarkerIndicatorRegion: Creates a new builder of the specified width.
open(OutputStream) - Method in interface org.daisy.dotify.api.writer.PagedMediaWriter: Open the PagedMediaWriter for writing.
org.daisy.dotify.api.engine - package org.daisy.dotify.api.engine: Provides a formatter engine API.
org.daisy.dotify.api.formatter - package org.daisy.dotify.api.formatter: Provides a text only layout engine.
org.daisy.dotify.api.graphics - package org.daisy.dotify.api.graphics: Provides braille graphics tools.
org.daisy.dotify.api.hyphenator - package org.daisy.dotify.api.hyphenator: Provides a hyphenation API.
org.daisy.dotify.api.obfl - package org.daisy.dotify.api.obfl: Provides an API for OBFL.
org.daisy.dotify.api.text - package org.daisy.dotify.api.text: Provides a text API.
org.daisy.dotify.api.translator - package org.daisy.dotify.api.translator: Provides a braille translation API.
org.daisy.dotify.api.writer - package org.daisy.dotify.api.writer: Provides a paged media writer API.
orphans(int) - Method in class org.daisy.dotify.api.formatter.BlockProperties.Builder: Sets the orphans property
outerMargin(int) - Method in class org.daisy.dotify.api.formatter.LayoutMasterProperties.Builder: Sets the outer margin, that is to say the margin opposite to the binding edge of the page.

P

padding(BlockSpacing) - Method in class org.daisy.dotify.api.formatter.TableCellProperties.Builder: Sets the padding
padding(BlockSpacing) - Method in class org.daisy.dotify.api.formatter.TableProperties.Builder: Sets the padding
PageAreaBuilder - Interface in org.daisy.dotify.api.formatter: Provides a page area builder.
PageAreaProperties - Class in org.daisy.dotify.api.formatter: Specifies an area of the page where collection items can be placed.
PageAreaProperties.Alignment - Enum in org.daisy.dotify.api.formatter: Specifies the alignment of the page area.
PageAreaProperties.Builder - Class in org.daisy.dotify.api.formatter: Creates a new page area properties builder
pageCounterName(String) - Method in class org.daisy.dotify.api.formatter.SequenceProperties.Builder: Sets the page counter name for the sequence.
PagedMediaWriter - Interface in org.daisy.dotify.api.writer: PagedMediaWriter is an interface for writing to a paged media.
PagedMediaWriterConfigurationException - Exception in org.daisy.dotify.api.writer: Provides an exception that indicates a problem configuring a paged media writer instance.
PagedMediaWriterConfigurationException() - Constructor for exception org.daisy.dotify.api.writer.PagedMediaWriterConfigurationException: Constructs a new exception with null as its detail message.
PagedMediaWriterConfigurationException(String) - Constructor for exception org.daisy.dotify.api.writer.PagedMediaWriterConfigurationException: Constructs a new exception with the specified detail message.
PagedMediaWriterConfigurationException(Throwable) - Constructor for exception org.daisy.dotify.api.writer.PagedMediaWriterConfigurationException: Constructs a new exception with the specified cause and a detail message of (cause==null ? null : cause.toString()) (which typically contains the class and detail message of cause).
PagedMediaWriterConfigurationException(String, Throwable) - Constructor for exception org.daisy.dotify.api.writer.PagedMediaWriterConfigurationException: Constructs a new exception with the specified detail message and cause.
PagedMediaWriterException - Exception in org.daisy.dotify.api.writer: A PagedMediaWriterException is an exception that indicates conditions in a PagedMediaWriter that a reasonable application might want to catch.
PagedMediaWriterException() - Constructor for exception org.daisy.dotify.api.writer.PagedMediaWriterException: Constructs a new exception with null as its detail message.
PagedMediaWriterException(String) - Constructor for exception org.daisy.dotify.api.writer.PagedMediaWriterException: Constructs a new exception with the specified detail message.
PagedMediaWriterException(Throwable) - Constructor for exception org.daisy.dotify.api.writer.PagedMediaWriterException: Constructs a new exception with the specified cause
PagedMediaWriterException(String, Throwable) - Constructor for exception org.daisy.dotify.api.writer.PagedMediaWriterException: Constructs a new exception with the specified detail message and cause.
PagedMediaWriterFactory - Interface in org.daisy.dotify.api.writer: Provides a PagedMediaWriter factory interface.
PagedMediaWriterFactoryMaker - Class in org.daisy.dotify.api.writer: Provides a PagedMediaWriter factory maker.
PagedMediaWriterFactoryMaker() - Constructor for class org.daisy.dotify.api.writer.PagedMediaWriterFactoryMaker: Creates a new paged media writer factory maker.
PagedMediaWriterFactoryMakerService - Interface in org.daisy.dotify.api.writer: Provides an interface for a PagedMediaWriterFactoryMaker service.
PagedMediaWriterFactoryService - Interface in org.daisy.dotify.api.writer: Provides an interface for a PagedMediaWriterFactory service.
PagenumField - Class in org.daisy.dotify.api.formatter: Provides a reference to some property of the physical pages in the final document.
PagenumField(NumeralStyle) - Constructor for class org.daisy.dotify.api.formatter.PagenumField: Creates a new page number field with the specified numeral style
PagenumField(NumeralStyle, String) - Constructor for class org.daisy.dotify.api.formatter.PagenumField: Creates a new page number field with the specified numeral and text styles
PageTemplateBuilder - Interface in org.daisy.dotify.api.formatter: Provides a page template builder.
parse(String) - Static method in enum org.daisy.dotify.api.formatter.TransitionBuilderProperties.ApplicationRange: Parses a string as a TransitionBuilderProperties.ApplicationRange.
parse(XMLEventReader, Formatter) - Method in interface org.daisy.dotify.api.obfl.ObflParser: Parses the input places its contents in the supplied formatter.
parsePosition(String) - Static method in class org.daisy.dotify.api.formatter.Position: Parses the supplied String as a Position.
pattern(String) - Method in class org.daisy.dotify.api.formatter.Leader.Builder: Set the pattern for Leader instances created using this builder.
PEF_MEDIA_TYPE - Static variable in interface org.daisy.dotify.api.writer.MediaTypes: PEF (portable embosser format) media type
position(Position) - Method in class org.daisy.dotify.api.formatter.BlockPosition.Builder: Sets the vertical position of the block, 0 is the first row.
position(Position) - Method in class org.daisy.dotify.api.formatter.Leader.Builder: Set the Position for Leader instances created using this builder.
Position - Class in org.daisy.dotify.api.formatter: Position is a data object for an integer position.
Position(double, boolean) - Constructor for class org.daisy.dotify.api.formatter.Position: Create a new Position with the supplied value
preferredEmptySpace(int) - Method in class org.daisy.dotify.api.formatter.TableProperties.Builder: Sets the preferred empty space of the table when the text content of cells are shorter than the largest possible column width
prepare(List<MetaDataItem>) - Method in interface org.daisy.dotify.api.writer.PagedMediaWriter: Adds additional metadata items.
processAttributes(TextAttribute, String...) - Method in interface org.daisy.dotify.api.translator.MarkerProcessor: Processes the input text and attributes into a text containing markers at the appropriate positions.
processAttributesRetain(TextAttribute, String[]) - Method in interface org.daisy.dotify.api.translator.MarkerProcessor: Processes the input text chunks and attributes into a text containing markers at the appropriate positions while retaining the text partition as specified by the input array.

R

ReferenceListBuilder - Interface in org.daisy.dotify.api.formatter: Provides a method to add a reference list.
removeAllVariables() - Method in interface org.daisy.dotify.api.obfl.Expression: Removes all global variables
removeFactory(HyphenatorFactoryService) - Method in class org.daisy.dotify.api.hyphenator.HyphenatorFactoryMaker: Removes a factory (intended for use by the OSGi framework)
removeFactory(Integer2TextFactoryService) - Method in class org.daisy.dotify.api.text.Integer2TextFactoryMaker: Removes a factory (intended for use by the OSGi framework)
removeFactory(BrailleFilterFactoryService) - Method in class org.daisy.dotify.api.translator.BrailleFilterFactoryMaker: Removes a factory (intended for use by the OSGi framework)
removeFactory(BrailleTranslatorFactoryService) - Method in class org.daisy.dotify.api.translator.BrailleTranslatorFactoryMaker: Removes a factory (intended for use by the OSGi framework)
removeFactory(MarkerProcessorFactoryService) - Method in class org.daisy.dotify.api.translator.MarkerProcessorFactoryMaker: Removes a factory (intended for use by the OSGi framework)
removeFactory(TextBorderFactoryService) - Method in class org.daisy.dotify.api.translator.TextBorderFactoryMaker: Removes a factory (intended for use by the OSGi framework)
removeFactory(PagedMediaWriterFactoryService) - Method in class org.daisy.dotify.api.writer.PagedMediaWriterFactoryMaker: Removes a factory (intended for use by the OSGi framework)
removeVariable(String) - Method in interface org.daisy.dotify.api.obfl.Expression: Removes a previously set variable
RenameFallbackRule - Class in org.daisy.dotify.api.formatter: Provides a fallback rule that indicates that the collection should be reassigned to another identifier.
RenameFallbackRule(String, String) - Constructor for class org.daisy.dotify.api.formatter.RenameFallbackRule: Creates a new instance with the specified parameters
render() - Method in interface org.daisy.dotify.api.formatter.DynamicContent: Renders the content without supplying any variables.
render(Context) - Method in interface org.daisy.dotify.api.formatter.DynamicContent: Renders the content in the supplied context.
renderGraphics(Raster) - Method in class org.daisy.dotify.api.graphics.BrailleGraphics: Renders the raster using braille characters.
RenderingScenario - Interface in org.daisy.dotify.api.formatter: Provides a rendering scenario.
renderScenario(FormatterCore) - Method in interface org.daisy.dotify.api.formatter.RenderingScenario: Renders the scenario into the supplied formatter.
rightBorder(String) - Method in class org.daisy.dotify.api.translator.TextBorderStyle.Builder: Sets the right border pattern
rightMargin(int) - Method in class org.daisy.dotify.api.formatter.BlockProperties.Builder: Set the right margin for the block, in characters.
rightPadding(int) - Method in class org.daisy.dotify.api.formatter.BlockProperties.Builder: Set the right padding for the block, in characters.
rightSpacing(int) - Method in class org.daisy.dotify.api.formatter.BlockSpacing.Builder: Set the right spacing for the block, in characters.
Row - Interface in org.daisy.dotify.api.writer: Defines a row of braille.
rowSpacing(float) - Method in class org.daisy.dotify.api.formatter.BlockProperties.Builder: Sets the row spacing for the block
rowSpacing(Float) - Method in class org.daisy.dotify.api.formatter.FieldList.Builder: Sets the row spacing for this field list
rowSpacing(float) - Method in class org.daisy.dotify.api.formatter.LayoutMasterProperties.Builder: Sets the row spacing, that is to say the distance between two consecutive rows of text.
rowSpacing(float) - Method in class org.daisy.dotify.api.formatter.TableProperties.Builder: Sets the row spacing for the resulting rows of text, that the table is made up of
rowSpacing(float) - Method in class org.daisy.dotify.api.formatter.TextBlockProperties.Builder: Sets the row spacing for the block.
rowSpan(int) - Method in class org.daisy.dotify.api.formatter.TableCellProperties.Builder: Sets the row span

S

SectionProperties - Interface in org.daisy.dotify.api.writer: Specifies the configuration properties for a section of pages in a paged media.
SequenceProperties - Class in org.daisy.dotify.api.formatter: SequenceProperties stores properties that are specific for a sequence of blocks
SequenceProperties(SequenceProperties.Builder) - Constructor for class org.daisy.dotify.api.formatter.SequenceProperties
SequenceProperties.Builder - Class in org.daisy.dotify.api.formatter: The Builder is used when creating a SequenceProperites instance
SequenceProperties.SequenceBreakBefore - Enum in org.daisy.dotify.api.formatter: Provides types of "break before" rules for sequences
setBeginLimit(int) - Method in interface org.daisy.dotify.api.hyphenator.HyphenatorInterface: Sets the begin limit.
setConfiguration(FormatterConfiguration) - Method in interface org.daisy.dotify.api.formatter.Formatter: Sets the formatter configuration
setCreatedWithSPI() - Method in interface org.daisy.dotify.api.engine.FormatterEngineFactoryService: Informs the implementation that it was discovered and instantiated using information collected from a file within the META-INF/services directory.
setCreatedWithSPI() - Method in interface org.daisy.dotify.api.formatter.FormatterFactory: Informs the implementation that it was discovered and instantiated using information collected from a file within the META-INF/services directory.
setCreatedWithSPI() - Method in interface org.daisy.dotify.api.hyphenator.HyphenatorFactoryService: Informs the implementation that it was discovered and instantiated using information collected from a file within the META-INF/services directory.
setCreatedWithSPI() - Method in interface org.daisy.dotify.api.obfl.ExpressionFactory: Informs the implementation that it was discovered and instantiated using information collected from a file within the META-INF/services directory.
setCreatedWithSPI() - Method in interface org.daisy.dotify.api.obfl.ObflParserFactoryService: Informs the implementation that it was discovered and instantiated using information collected from a file within the META-INF/services directory.
setCreatedWithSPI() - Method in interface org.daisy.dotify.api.text.Integer2TextFactoryService: Informs the implementation that it was discovered and instantiated using information collected from a file within the META-INF/services directory.
setCreatedWithSPI() - Method in interface org.daisy.dotify.api.translator.BrailleFilterFactoryService: Informs the implementation that it was discovered and instantiated using information collected from a file within the META-INF/services directory.
setCreatedWithSPI() - Method in interface org.daisy.dotify.api.translator.BrailleTranslatorFactoryService: Informs the implementation that it was discovered and instantiated using information collected from a file within the META-INF/services directory.
setCreatedWithSPI() - Method in interface org.daisy.dotify.api.translator.MarkerProcessorFactoryService: Informs the implementation that it was discovered and instantiated using information collected from a file within the META-INF/services directory.
setCreatedWithSPI() - Method in interface org.daisy.dotify.api.translator.TextBorderFactoryService: Informs the implementation that it was discovered and instantiated using information collected from a file within the META-INF/services directory.
setCreatedWithSPI() - Method in interface org.daisy.dotify.api.writer.PagedMediaWriterFactoryService: Informs the implementation that it was discovered and instantiated using information collected from a file within the META-INF/services directory.
setEndLimit(int) - Method in interface org.daisy.dotify.api.hyphenator.HyphenatorInterface: Sets the end limit.
setFeature(String, Object) - Method in interface org.daisy.dotify.api.hyphenator.HyphenatorFactory: Sets the value of a hyphenation feature.
setFeature(String, Object) - Method in interface org.daisy.dotify.api.text.Integer2TextFactory: Sets the value of a integer2text feature.
setFeature(String, Object) - Method in interface org.daisy.dotify.api.translator.TextBorderFactory: Sets a feature.
setFeature(String, Object) - Method in interface org.daisy.dotify.api.writer.PagedMediaWriterFactory: Sets the value of a PagedMediaWriter feature.
setPageArea(PageAreaProperties) - Method in interface org.daisy.dotify.api.formatter.LayoutMasterBuilder: Sets the page area.
setProperties(TransitionBuilderProperties) - Method in interface org.daisy.dotify.api.formatter.TransitionBuilder: Sets the properties for this transition builder.
setVariable(String, Object) - Method in interface org.daisy.dotify.api.obfl.Expression: Sets a globally accessible variable for this instance
sixDotFilter(List<String>) - Static method in class org.daisy.dotify.api.graphics.BrailleGraphics: Filters the input braille image by discarding dots 7 and 8.
startBlock(BlockProperties) - Method in interface org.daisy.dotify.api.formatter.BlockBuilder: Start a new block with the supplied BlockProperties.
startBlock(BlockProperties, String) - Method in interface org.daisy.dotify.api.formatter.BlockBuilder: Start a new block with the supplied BlockProperties.
startEntry(String, BlockProperties) - Method in interface org.daisy.dotify.api.formatter.TableOfContents: Starts a new entry with the supplied properties.
startItem(BlockProperties) - Method in interface org.daisy.dotify.api.formatter.ContentCollection: Starts a new item with the supplied properties.
startStyle(String) - Method in interface org.daisy.dotify.api.formatter.BlockContentBuilder: Starts a style section
startTable(TableProperties) - Method in interface org.daisy.dotify.api.formatter.FormatterCore: Starts a new table with the supplied properties.
StringField - Class in org.daisy.dotify.api.formatter: Provides a static string field.
StringField(Object) - Constructor for class org.daisy.dotify.api.formatter.StringField: Creates a new string field using the specified object.
StringField(String) - Constructor for class org.daisy.dotify.api.formatter.StringField: Creates a new string field using the specified string.
StringField(Object, String) - Constructor for class org.daisy.dotify.api.formatter.StringField: Creates a new string field using the specified object and text style.
StringField(String, String) - Constructor for class org.daisy.dotify.api.formatter.StringField: Creates a new string field using the specified object and text style.
style(BorderSpecification.Style) - Method in class org.daisy.dotify.api.translator.Border.Builder.BuilderView: Sets the border style for the active edge.
style(BorderSpecification.Style) - Method in class org.daisy.dotify.api.translator.BorderSpecification.Builder: Sets the border style.
supportsLocale(String) - Method in interface org.daisy.dotify.api.hyphenator.HyphenatorFactoryService: Returns true if this instance can create instances for the specified locale.
supportsLocale(String) - Method in interface org.daisy.dotify.api.text.Integer2TextFactoryService: Returns true if this instance can create instances for the specified locale.
supportsMediaType(String) - Method in interface org.daisy.dotify.api.writer.PagedMediaWriterFactoryService: Returns true if this instance can create instances for the specified mediaType.
supportsMetric(String) - Method in interface org.daisy.dotify.api.translator.BrailleTranslatorResult: Returns true if this result supports the given metric, false otherwise.
supportsSpecification(String, String) - Method in class org.daisy.dotify.api.translator.BrailleFilterFactoryMaker
supportsSpecification(String, String) - Method in interface org.daisy.dotify.api.translator.BrailleFilterFactoryMakerService: Returns true if the filter factory supports the given specification.
supportsSpecification(String, String) - Method in interface org.daisy.dotify.api.translator.BrailleFilterFactoryService: Returns true if the filter factory supports the given specification.
supportsSpecification(String, String) - Method in class org.daisy.dotify.api.translator.BrailleTranslatorFactoryMaker
supportsSpecification(String, String) - Method in interface org.daisy.dotify.api.translator.BrailleTranslatorFactoryMakerService: Returns true if the translator factory supports the given specification.
supportsSpecification(String, String) - Method in interface org.daisy.dotify.api.translator.BrailleTranslatorFactoryService: Returns true if the translator factory supports the given specification.
supportsSpecification(String, String) - Method in class org.daisy.dotify.api.translator.MarkerProcessorFactoryMaker
supportsSpecification(String, String) - Method in interface org.daisy.dotify.api.translator.MarkerProcessorFactoryMakerService: Returns true if the specification is supported, false otherwise
supportsSpecification(String, String) - Method in interface org.daisy.dotify.api.translator.MarkerProcessorFactoryService: Returns true if the marker processor factory supports the given specification.

T

TableCellProperties - Class in org.daisy.dotify.api.formatter: Provides properties needed for a table cell.
TableCellProperties.Builder - Class in org.daisy.dotify.api.formatter: Provides a builder for creating table properties
tableColSpacing(int) - Method in class org.daisy.dotify.api.formatter.TableProperties.Builder: Sets the table column spacing
TableOfContents - Interface in org.daisy.dotify.api.formatter: Provides methods needed to add a TOC to a formatter.
TableProperties - Class in org.daisy.dotify.api.formatter: Provides properties needed for a table.
TableProperties.Builder - Class in org.daisy.dotify.api.formatter: Provides a builder for creating table properties
tableRowSpacing(int) - Method in class org.daisy.dotify.api.formatter.TableProperties.Builder: Sets the table row spacing
text(String) - Static method in class org.daisy.dotify.api.translator.Translatable: Creates a new Translatable.Builder with the specified text.
TEXT_MEDIA_TYPE - Static variable in interface org.daisy.dotify.api.writer.MediaTypes: Plain text media type.
TextAttribute - Interface in org.daisy.dotify.api.translator: Provides an interface for text attributes.
textBlockProperties(TextBlockProperties) - Method in class org.daisy.dotify.api.formatter.TableCellProperties.Builder: Gets the text block properties builder
TextBlockProperties - Class in org.daisy.dotify.api.formatter: Provides text block properties.
TextBlockProperties.Builder - Class in org.daisy.dotify.api.formatter: Provides a builder for text block properties
TextBorderConfigurationException - Exception in org.daisy.dotify.api.translator: Provides an exception that indicates a problem configuring a new text border instance.
TextBorderConfigurationException() - Constructor for exception org.daisy.dotify.api.translator.TextBorderConfigurationException
TextBorderConfigurationException(String) - Constructor for exception org.daisy.dotify.api.translator.TextBorderConfigurationException
TextBorderConfigurationException(Throwable) - Constructor for exception org.daisy.dotify.api.translator.TextBorderConfigurationException
TextBorderConfigurationException(String, Throwable) - Constructor for exception org.daisy.dotify.api.translator.TextBorderConfigurationException
TextBorderFactory - Interface in org.daisy.dotify.api.translator: Provides a factory for text borders.
TextBorderFactoryMaker - Class in org.daisy.dotify.api.translator: Provides a text border factory maker.
TextBorderFactoryMaker() - Constructor for class org.daisy.dotify.api.translator.TextBorderFactoryMaker: Creates a new text border factory maker.
TextBorderFactoryMakerService - Interface in org.daisy.dotify.api.translator: Provides an interface for a TextBorderFactoryMaker service.
TextBorderFactoryService - Interface in org.daisy.dotify.api.translator: Provides an interface for a TextBorderFactory service.
textBorderStyle(TextBorderStyle) - Method in class org.daisy.dotify.api.formatter.BlockProperties.Builder: Sets the text border style for the block.
TextBorderStyle - Class in org.daisy.dotify.api.translator: Defines a text border.
TextBorderStyle.Builder - Class in org.daisy.dotify.api.translator: Provides a builder for text borders.
textIndent(int) - Method in class org.daisy.dotify.api.formatter.BlockProperties.Builder: Set the text indent for the block, in characters.
textIndent(int) - Method in class org.daisy.dotify.api.formatter.TextBlockProperties.Builder: Set the text indent for the block, in characters.
TextProperties - Class in org.daisy.dotify.api.formatter: Defines properties specific for a span of text.
TextProperties.Builder - Class in org.daisy.dotify.api.formatter: Provides a builder for creating text properties instances.
TocProperties - Class in org.daisy.dotify.api.formatter: Defines properties specific for a TOC sequence.
TocProperties.Builder - Class in org.daisy.dotify.api.formatter: Provides a builder for creating TOC properties instances.
TocProperties.TocRange - Enum in org.daisy.dotify.api.formatter: Defines TOC ranges.
topBorder(String) - Method in class org.daisy.dotify.api.translator.TextBorderStyle.Builder: Sets the top of the border
topLeftCorner(String) - Method in class org.daisy.dotify.api.translator.TextBorderStyle.Builder: Sets the top left corner for the border
topMargin(int) - Method in class org.daisy.dotify.api.formatter.BlockProperties.Builder: Set the top margin for the block, in characters.
topPadding(int) - Method in class org.daisy.dotify.api.formatter.BlockProperties.Builder: Set the top padding for the block, in characters.
topRightCorner(String) - Method in class org.daisy.dotify.api.translator.TextBorderStyle.Builder: Sets the top right corner for the border
topSpacing(int) - Method in class org.daisy.dotify.api.formatter.BlockSpacing.Builder: Set the top spacing for the block, in characters.
toString() - Method in class org.daisy.dotify.api.formatter.StringField
toString() - Method in class org.daisy.dotify.api.translator.DefaultTextAttribute
TransitionBuilder - Interface in org.daisy.dotify.api.formatter: Provides a definition for volume transitions.
TransitionBuilderProperties - Class in org.daisy.dotify.api.formatter: Provides properties for a transition builder.
TransitionBuilderProperties.ApplicationRange - Enum in org.daisy.dotify.api.formatter: Defines the application range starting from the end of the volume.
TransitionBuilderProperties.Builder - Class in org.daisy.dotify.api.formatter: Provides a builder for transition builder properties.
Translatable - Class in org.daisy.dotify.api.translator: Provides a specification for a text to translate
Translatable.Builder - Class in org.daisy.dotify.api.translator: Provides a builder for translatable objects
translate(Translatable) - Method in interface org.daisy.dotify.api.translator.BrailleTranslator: Translates a text into braille using the supplied specification.
TranslationException - Exception in org.daisy.dotify.api.translator: Provides an exception indicating a translation problem.
TranslationException() - Constructor for exception org.daisy.dotify.api.translator.TranslationException
TranslationException(String, Throwable) - Constructor for exception org.daisy.dotify.api.translator.TranslationException
TranslationException(String) - Constructor for exception org.daisy.dotify.api.translator.TranslationException
TranslationException(Throwable) - Constructor for exception org.daisy.dotify.api.translator.TranslationException
translationMode(String) - Method in class org.daisy.dotify.api.formatter.TextProperties.Builder: Sets the translation mode for the builder
TranslatorConfigurationException - Exception in org.daisy.dotify.api.translator: Provides an exception that indicates a problem configuring a new translator instance.
TranslatorConfigurationException() - Constructor for exception org.daisy.dotify.api.translator.TranslatorConfigurationException: Constructs a new exception with null as its detail message.
TranslatorConfigurationException(String, Throwable) - Constructor for exception org.daisy.dotify.api.translator.TranslatorConfigurationException: Constructs a new exception with the specified detail message and cause.
TranslatorConfigurationException(String) - Constructor for exception org.daisy.dotify.api.translator.TranslatorConfigurationException: Constructs a new exception with the specified detail message.
TranslatorConfigurationException(Throwable) - Constructor for exception org.daisy.dotify.api.translator.TranslatorConfigurationException: Constructs a new exception with the specified cause and a detail message of (cause==null ? null : cause.toString()) (which typically contains the class and detail message of cause).
TranslatorSpecification - Class in org.daisy.dotify.api.translator: Provides a translator specification.
TranslatorSpecification(String, String) - Constructor for class org.daisy.dotify.api.translator.TranslatorSpecification: Creates a new translator specification with the supplied values.

U

underlineStyle(String) - Method in class org.daisy.dotify.api.formatter.BlockProperties.Builder: Sets the underline pattern for the block.
UnsupportedMetricException - Exception in org.daisy.dotify.api.translator: Provides a runtime exception for unsupported metrics.
UnsupportedMetricException() - Constructor for exception org.daisy.dotify.api.translator.UnsupportedMetricException: Constructs an UnsupportedMetricException with no detail message.
UnsupportedMetricException(String) - Constructor for exception org.daisy.dotify.api.translator.UnsupportedMetricException: Constructs an UnsupportedMetricException with the specified detail message.
UnsupportedMetricException(Throwable) - Constructor for exception org.daisy.dotify.api.translator.UnsupportedMetricException: Constructs a new exception with the specified cause and a detail message of (cause==null ? null : cause.toString()) (which typically contains the class and detail message of cause).
UnsupportedMetricException(String, Throwable) - Constructor for exception org.daisy.dotify.api.translator.UnsupportedMetricException: Constructs a new exception with the specified detail message and cause.

V

valueOf(String) - Static method in enum org.daisy.dotify.api.formatter.BlockPosition.VerticalAlignment: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.daisy.dotify.api.formatter.CurrentPageField.PagenumType: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.daisy.dotify.api.formatter.FormattingTypes.Alignment: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.daisy.dotify.api.formatter.FormattingTypes.BreakBefore: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.daisy.dotify.api.formatter.FormattingTypes.Keep: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.daisy.dotify.api.formatter.FormattingTypes.ListStyle: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.daisy.dotify.api.formatter.ItemSequenceProperties.Range: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.daisy.dotify.api.formatter.Leader.Alignment: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.daisy.dotify.api.formatter.MarkerReferenceField.MarkerSearchDirection: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.daisy.dotify.api.formatter.MarkerReferenceField.MarkerSearchScope: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.daisy.dotify.api.formatter.NumeralStyle: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.daisy.dotify.api.formatter.PageAreaProperties.Alignment: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.daisy.dotify.api.formatter.SequenceProperties.SequenceBreakBefore: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.daisy.dotify.api.formatter.TocProperties.TocRange: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.daisy.dotify.api.formatter.TransitionBuilderProperties.ApplicationRange: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.daisy.dotify.api.translator.BorderSpecification.Align: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.daisy.dotify.api.translator.BorderSpecification.Style: Returns the enum constant of this type with the specified name.
values() - Static method in enum org.daisy.dotify.api.formatter.BlockPosition.VerticalAlignment: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.daisy.dotify.api.formatter.CurrentPageField.PagenumType: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.daisy.dotify.api.formatter.FormattingTypes.Alignment: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.daisy.dotify.api.formatter.FormattingTypes.BreakBefore: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.daisy.dotify.api.formatter.FormattingTypes.Keep: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.daisy.dotify.api.formatter.FormattingTypes.ListStyle: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.daisy.dotify.api.formatter.ItemSequenceProperties.Range: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.daisy.dotify.api.formatter.Leader.Alignment: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.daisy.dotify.api.formatter.MarkerReferenceField.MarkerSearchDirection: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.daisy.dotify.api.formatter.MarkerReferenceField.MarkerSearchScope: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.daisy.dotify.api.formatter.NumeralStyle: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.daisy.dotify.api.formatter.PageAreaProperties.Alignment: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.daisy.dotify.api.formatter.SequenceProperties.SequenceBreakBefore: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.daisy.dotify.api.formatter.TocProperties.TocRange: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.daisy.dotify.api.formatter.TransitionBuilderProperties.ApplicationRange: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.daisy.dotify.api.translator.BorderSpecification.Align: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.daisy.dotify.api.translator.BorderSpecification.Style: Returns an array containing the constants of this enum type, in the order they are declared.
verticalAlignment(BlockPosition.VerticalAlignment) - Method in class org.daisy.dotify.api.formatter.BlockProperties.Builder: Sets the vertical alignment for this block.
verticalPosition(Position) - Method in class org.daisy.dotify.api.formatter.BlockProperties.Builder: Sets the vertical position for this block.
VolumeContentBuilder - Interface in org.daisy.dotify.api.formatter: Provides methods needed to build volume anchored content, such as cover pages and TOC.
volumeKeepPriority(Integer) - Method in class org.daisy.dotify.api.formatter.BlockProperties.Builder: Sets the volume keep priority for the block.
VolumeTemplateBuilder - Interface in org.daisy.dotify.api.formatter: Provides methods for building a volume template.
VolumeTemplateProperties - Class in org.daisy.dotify.api.formatter: Defines properties for a volume template.
VolumeTemplateProperties(VolumeTemplateProperties.Builder) - Constructor for class org.daisy.dotify.api.formatter.VolumeTemplateProperties
VolumeTemplateProperties.Builder - Class in org.daisy.dotify.api.formatter: Provides a builder for creating volume template properties instances.

W

widows(int) - Method in class org.daisy.dotify.api.formatter.BlockProperties.Builder: Sets the widows property
width(Integer) - Method in class org.daisy.dotify.api.translator.Border.Builder.BuilderView: Sets the border width for the active edge.
width(Integer) - Method in class org.daisy.dotify.api.translator.BorderSpecification.Builder: Sets the width of the border.
with(String, String) - Static method in class org.daisy.dotify.api.formatter.FormatterConfiguration: Creates a new builder with the specified properties
with(TransitionBuilderProperties) - Static method in class org.daisy.dotify.api.formatter.TransitionBuilderProperties.Builder: Creates a new builder based on the supplied configuration.
write(PagedMediaWriter) - Method in interface org.daisy.dotify.api.formatter.Formatter: Writes the current result to a paged media

A B C D E F G H I K L M N O P R S T U V W