Index (Catalan API Documentation)

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV NEXT

FRAMES NO FRAMES

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

A

ABOVE_AT_MASK - Static variable in class org.writersforge.catalan.layout.Relation: Vertically above the attractor, at exactly distance
ABOVE_MASK - Static variable in class org.writersforge.catalan.layout.Relation: Vertically above the attractor, with no comparison operator specified
ABOVE_MAX_MASK - Static variable in class org.writersforge.catalan.layout.Relation: Vertically above the attractor, no further than distance
ABOVE_MIN_MASK - Static variable in class org.writersforge.catalan.layout.Relation: Vertically above the attractor, no closer than distance
AbstractLayoutEngine - class org.writersforge.catalan.layout.AbstractLayoutEngine.
AbstractLayoutEngine() - Constructor for class org.writersforge.catalan.layout.AbstractLayoutEngine
acceptArea(LayoutArea) - Method in interface org.writersforge.catalan.layout.LayoutEngine: Adds the area to the layout queue.
acceptArea(LayoutArea) - Method in class org.writersforge.catalan.layout.LayoutContext: Adds an area to the list of renderable areas for the current page.
acceptArea(LayoutArea) - Method in class org.writersforge.catalan.layout.AbstractLayoutEngine: Adds the area to the layout queue.
acceptArea(LayoutArea, LayoutContext, List) - Method in class org.writersforge.catalan.layout.SimpleFlowLayout: Accept the entire contents of this area; if this is a group area, accept all child elements.
addAllStyle(AllStyle) - Method in class org.writersforge.catalan.layout.style.StyleChain: Adds an AllStyle to the front of the lookup chain.
addArea(LayoutArea) - Method in class org.writersforge.catalan.layout.Page: Appends a new LayoutArea object into the Page.
addAreas(LayoutArea[]) - Method in class org.writersforge.catalan.layout.Page: Appends an array of LayoutArea objects into the Page.
addAreaStyle(AreaStyle) - Method in class org.writersforge.catalan.layout.style.StyleChain: Adds a AreaStyle to the front of the lookup chain.
addChildren(LayoutArea) - Method in class org.writersforge.catalan.layout.LayoutGroup: Appends a new child LayoutArea object into this area.
addChildren(LayoutArea) - Method in class org.writersforge.catalan.layout.LayoutArea: Appends a new child LayoutArea object into this area.
addChildren(LayoutArea[]) - Method in class org.writersforge.catalan.layout.LayoutGroup: Appends an array of child LayoutArea objects into this area.
addChildren(LayoutArea[]) - Method in class org.writersforge.catalan.layout.LayoutArea: Appends an array of child LayoutArea objects into this area.
addDirective(DirectiveStack.Directive) - Method in class org.writersforge.catalan.transform.DirectiveStack: Adds a formatting Directive to the end of the stack.
addExclusion(String, String) - Method in class org.writersforge.catalan.transform.Normalizer: Adds an exclusion region, for example quoted data that should not be normalized.
addFontStyle(FontStyle) - Method in class org.writersforge.catalan.layout.style.StyleChain: Adds a FontStyle to the front of the lookup chain.
addLeftover(Object) - Method in class org.writersforge.catalan.transform.BaseNodeProcessor: Add a node to the list of unprocessed nodes.
addMarkup(FontStyle, int, int) - Method in class org.writersforge.catalan.layout.StyledText: Adds Style markup across a given range.
addPage(Page) - Method in class org.writersforge.catalan.layout.Book: Appends a new Page object into the Book.
addRelations(Relation) - Method in class org.writersforge.catalan.layout.Constraint: Appends a new Relation object into the Constraint.
addRule(Rule) - Method in class org.writersforge.catalan.transform.rule.RuleCollection: Adds another child Rule to the collection.
addText(String) - Method in class org.writersforge.catalan.layout.StyledText: Appends the given text to the current text using the default style.
addText(String, FontStyle) - Method in class org.writersforge.catalan.layout.StyledText: Appends the given text to the current text using the given Style.
addTextStyle(TextStyle) - Method in class org.writersforge.catalan.layout.style.StyleChain: Adds a TextStyle to the front of the lookup chain.
addToPage(Page, LayoutArea) - Method in class org.writersforge.catalan.layout.AsciiLayout: Attempts to add a single area to the Page.
ALIGN_BOTTOM - Static variable in interface org.writersforge.catalan.layout.style.AlignStyle: Text should be aligned to the bottom
ALIGN_CENTER - Static variable in interface org.writersforge.catalan.layout.style.AlignStyle: Text should be aligned to the center
ALIGN_ENUM - Static variable in interface org.writersforge.catalan.layout.style.AlignStyle: Enumeration of text alignment
ALIGN_LEFT - Static variable in interface org.writersforge.catalan.layout.style.AlignStyle: Text should be aligned to the left
ALIGN_RIGHT - Static variable in interface org.writersforge.catalan.layout.style.AlignStyle: Text should be aligned to the right
ALIGN_TOP - Static variable in interface org.writersforge.catalan.layout.style.AlignStyle: Text should be aligned to the top
AlignStyle - interface org.writersforge.catalan.layout.style.AlignStyle.: The directional orientation of the given area.
AllStyle - interface org.writersforge.catalan.layout.style.AllStyle.: Composite style all known style interfaces.
AreaStyle - interface org.writersforge.catalan.layout.style.AreaStyle.: Composite style for layout area objects.
ASCII_ENGINE - Static variable in class org.writersforge.catalan.layout.LayoutFactory: The factory name for the AsciiLayout engine.
AsciiConverter - class org.writersforge.catalan.transform.AsciiConverter.: A packed ASCII field processor which explodes a packed ASCII data node into a collection of Java objects, or vice versa.
AsciiConverter(String, boolean) - Constructor for class org.writersforge.catalan.transform.AsciiConverter: Creates a new instance of AsciiConverter.
AsciiFieldManager - class org.writersforge.catalan.transform.AsciiFieldManager.: A field-level manager for packing and unpacking ASCII data.
AsciiFieldManager(String) - Constructor for class org.writersforge.catalan.transform.AsciiFieldManager: Creates a new instance of AsciiFieldManager.
AsciiLayout - class org.writersforge.catalan.layout.AsciiLayout.: Ascii art-style layout engine, a starting point for the TextRenderer
AsciiLayout() - Constructor for class org.writersforge.catalan.layout.AsciiLayout

B

BaseNodeProcessor - class org.writersforge.catalan.transform.BaseNodeProcessor.: A common base implementation for NodeProcessor.
BaseNodeProcessor() - Constructor for class org.writersforge.catalan.transform.BaseNodeProcessor: Creates a new instance of TextProcessor.
BeanToXml - class org.writersforge.catalan.transform.BeanToXml.: A processor which converts each input node into an XML tree.
BeanToXml() - Constructor for class org.writersforge.catalan.transform.BeanToXml: Creates a new instance of BeanToXml.
BeanToXml(boolean, PropertyName.PropertyStyle) - Constructor for class org.writersforge.catalan.transform.BeanToXml: Creates a new instance of BeanToXml with the specified collapse and naming style.
BELOW_AT_MASK - Static variable in class org.writersforge.catalan.layout.Relation: Vertically below the attractor, at exactly distance
BELOW_MASK - Static variable in class org.writersforge.catalan.layout.Relation: Vertically below the attractor, at exactly distance
BELOW_MAX_MASK - Static variable in class org.writersforge.catalan.layout.Relation: Vertically below the attractor, no further than distance
BELOW_MIN_MASK - Static variable in class org.writersforge.catalan.layout.Relation: Vertically below the attractor, no closer than distance
Book - class org.writersforge.catalan.layout.Book.: A collection of Page objects, to be passed on to a Renderer.
Book(ListDatum) - Constructor for class org.writersforge.catalan.layout.Book: Creates a new instance of Book
BorderStyle - interface org.writersforge.catalan.layout.style.BorderStyle.: Hints on how to draw the outline border of an area.
buildFlowLayout(Section, String, Book) - Method in class org.writersforge.catalan.templates.RenderTemplate: Renders a single flow region in the current section, using the data in the Book as an input source.
buildFlowLayout(Section, String, Book) - Method in class org.writersforge.catalan.templates.GenericTemplate: Renders a single flow region in the current section, using the data in the Book as an input source.
buildFlowLayout(Section, String, Book) - Method in class org.writersforge.catalan.templates.DTDTemplate: Renders a single flow region in the current section, using the data in the Book as an input source.
buildStaticLayout(Section, String, Book) - Method in class org.writersforge.catalan.templates.RenderTemplate: Renders a single static region in the current section, using the data in the Book as an input source.
buildStaticLayout(Section, String, Book) - Method in class org.writersforge.catalan.templates.GenericTemplate: Renders a single static region in the current section, using the data in the Book as an input source.
buildStaticLayout(Section, String, Book) - Method in class org.writersforge.catalan.templates.DTDTemplate: Renders a single static region in the current section, using the data in the Book as an input source.

C

calculateFinalExtents(LayoutArea, LayoutContext) - Method in class org.writersforge.catalan.layout.SimpleFlowLayout: Creates an extent for placing the area in its final position in the layout.
canBreakAt(int) - Method in class org.writersforge.catalan.layout.LayoutArea: Determines if this area can be broken at the given height, measured from the top of the area.
charWidth(char) - Method in class org.writersforge.catalan.layout.style.FontStyleMetrics: Estimates the width of the given character in this style.
clear() - Method in class org.writersforge.catalan.layout.StyledText: Removes all text and markup.
clearPages() - Method in class org.writersforge.catalan.layout.Book: Removes all current pages.
clearQueue() - Method in interface org.writersforge.catalan.layout.LayoutEngine: Empties out the layout queue.
clearQueue() - Method in class org.writersforge.catalan.layout.AbstractLayoutEngine: Empties out the layout queue.
clearRules() - Method in class org.writersforge.catalan.transform.rule.RuleCollection: Removes all Rule objects from this collection.
CommandOp - class org.writersforge.catalan.templates.generic.CommandOp.: Common base class for all template ops that represent processing commands.
CommandOp(Datum, StyleMap) - Constructor for class org.writersforge.catalan.templates.generic.CommandOp: Creates a new instance of CommandOp.
CommandOp(Datum, StyleMap, StyleChain) - Constructor for class org.writersforge.catalan.templates.generic.CommandOp: Creates a new instance of CommandOp with an optional StyleChain fallback.
Concatenator - class org.writersforge.catalan.transform.Concatenator.: A processor which converts all input nodes into String formats and concatenates them into a single output String node.
Concatenator() - Constructor for class org.writersforge.catalan.transform.Concatenator: Creates a new instance of Concatenator.
Concatenator(int) - Constructor for class org.writersforge.catalan.transform.Concatenator: Creates a new instance of Concatenator with a maximum node count.
Concatenator(int, String) - Constructor for class org.writersforge.catalan.transform.Concatenator: Creates a new instance of Concatenator with a maximum node count and a separator.
Concatenator(String) - Constructor for class org.writersforge.catalan.transform.Concatenator: Creates a new instance of Concatenator with a separator.
Constraint - class org.writersforge.catalan.layout.Constraint.: Geometrical constraints for a single LayoutArea object.
Constraint() - Constructor for class org.writersforge.catalan.layout.Constraint: Creates a new instance of Constraint.
Constraint(Dimension) - Constructor for class org.writersforge.catalan.layout.Constraint: Creates a new instance of Constraint.
Constraint(Dimension, boolean) - Constructor for class org.writersforge.catalan.layout.Constraint: Creates a new instance of Constraint.
Constraint(Dimension, Dimension, Dimension, boolean) - Constructor for class org.writersforge.catalan.layout.Constraint: Creates a new instance of Constraint.
ContentOp - class org.writersforge.catalan.templates.generic.ContentOp.: Common base class for all template ops that produce renderable content.
ContentOp(Datum, StyleMap) - Constructor for class org.writersforge.catalan.templates.generic.ContentOp: Creates a new instance of ContentOp.
ContentOp(Datum, StyleMap, StyleChain) - Constructor for class org.writersforge.catalan.templates.generic.ContentOp: Creates a new instance of ContentOp with an optional StyleChain fallback.
ConvertRule - class org.writersforge.catalan.transform.rule.ConvertRule.: Common base class for all query-based rules that convert existing content into some other format.
ConvertRule(String, String) - Constructor for class org.writersforge.catalan.transform.rule.ConvertRule: Creates a new instance of ConvertRule for Datum or Datum property operations.
CopyProcessor - class org.writersforge.catalan.transform.xform.CopyProcessor.: A Datum-only NodeProcessor for duplicating existing XML content to other parts of the same XML tree.
CopyProcessor(String, String, String) - Constructor for class org.writersforge.catalan.transform.xform.CopyProcessor: Creates a new instance of CopyProcessor.
CopyRule - class org.writersforge.catalan.transform.rule.CopyRule.: A query-based Rule for duplicating elements or attributes to other parts of a Datum tree.
createBorder(int, Color) - Static method in class org.writersforge.catalan.layout.LayoutShape: Creates a border shape area.
createNewPage(Book) - Method in class org.writersforge.catalan.templates.RenderTemplate: Creates a new Page object, initialized with width, height, and margins appropriate to this template and Book.
createNewPage(Book) - Method in class org.writersforge.catalan.templates.GenericTemplate: Creates a new Page object, initialized with width, height, and margins appropriate to this template and Book.
createOp(Datum, StyleMap) - Static method in class org.writersforge.catalan.templates.generic.GenericOp: Factory method for creating new ops.
createOp(Datum, StyleMap, StyleChain) - Static method in class org.writersforge.catalan.templates.generic.GenericOp: Factory method for creating new ops initialized with an optional StyleChain fallback.
createPadding(int, int) - Static method in class org.writersforge.catalan.layout.LayoutPadding: Creates a new instance of LayoutPadding with the given preferred size.
createPadding(int, int, int, int) - Static method in class org.writersforge.catalan.layout.LayoutPadding: Creates a new instance of LayoutPadding with the given preferred size.
createProcessor(Datum) - Method in class org.writersforge.catalan.transform.ProcessorFactory: Creates a NodeProcessor implementation, based on the content of the Datum input instruction.
CreateRule - class org.writersforge.catalan.transform.rule.CreateRule.: A query-based Rule to create new Datum content or a Datum property at the target location(s).
CustomNodeProcessor - class org.writersforge.catalan.transform.CustomNodeProcessor.: Base class for all user-defined NodeProcessors.
CustomNodeProcessor(Datum) - Constructor for class org.writersforge.catalan.transform.CustomNodeProcessor: Creates a new instance of CustomNodeProcessor.

D

DatumStyleMap - class org.writersforge.catalan.layout.style.DatumStyleMap.: StyleMap wrapper around a <style-map> Datum tree.
DatumStyleMap(Datum) - Constructor for class org.writersforge.catalan.layout.style.DatumStyleMap: Creates a new instance of DatumStyleMap.
DatumStyleWrapper - class org.writersforge.catalan.layout.style.DatumStyleWrapper.: Convenience wrapper that exports all known style interfaces from a single Datum object.
DatumStyleWrapper() - Constructor for class org.writersforge.catalan.layout.style.DatumStyleWrapper: Creates a new instance of DatumStyleWrapper with all default values.
DatumStyleWrapper(Datum) - Constructor for class org.writersforge.catalan.layout.style.DatumStyleWrapper: Creates a new instance of DatumStyleWrapper with given datum.
DatumStyleWrapper(Datum, boolean) - Constructor for class org.writersforge.catalan.layout.style.DatumStyleWrapper: Creates a new instance of DatumStyleWrapper with given datum, StyleMap, and inheritance flag.
DatumToObject - class org.writersforge.catalan.transform.DatumToObject.: A text processor which converts Datum content into a List of java objects.
DatumToObject(ListDatum[]) - Constructor for class org.writersforge.catalan.transform.DatumToObject: Creates a new instance of DatumToObject.
debugPrint() - Method in class org.writersforge.catalan.layout.Page: Creates a debug string which represents this Page object
DEFAULT_STYLE - Static variable in class org.writersforge.catalan.layout.style.DefaultStyle: Sole public instance of DefaultStyle
DefaultStyle - class org.writersforge.catalan.layout.style.DefaultStyle.: An implementation of the FontStyle, TextStyle, and AreaStyle interfaces with all hardcoded defaults.
DeleteProcessor - class org.writersforge.catalan.transform.xform.DeleteProcessor.: A Datum-only NodeProcessor for deleting existing XML content to other parts of the same XML tree.
DeleteProcessor(String, String) - Constructor for class org.writersforge.catalan.transform.xform.DeleteProcessor: Creates a new instance of DeleteProcessor.
DirectiveStack - class org.writersforge.catalan.transform.DirectiveStack.: Format specification for placing Java Objects into a Datum tree.
DirectiveStack.Attribute - class org.writersforge.catalan.transform.DirectiveStack.Attribute.: A Directive to create a new attribute (Datum property) inside the current element.
DirectiveStack.Attribute(String, Object) - Constructor for class org.writersforge.catalan.transform.DirectiveStack.Attribute: Creates a new instance of AttributeName.
DirectiveStack.Directive - class org.writersforge.catalan.transform.DirectiveStack.Directive.: A single operation to perform on a node while creating a Bellows Datum tree from a list of nodes.
DirectiveStack.Directive(Object) - Constructor for class org.writersforge.catalan.transform.DirectiveStack.Directive: Creates a new instance of Directive.
DirectiveStack.EndElement - class org.writersforge.catalan.transform.DirectiveStack.EndElement.: A Directive to close the current element.
DirectiveStack.EndElement() - Constructor for class org.writersforge.catalan.transform.DirectiveStack.EndElement: Creates a new instance of EndElement.
DirectiveStack.Pcdata - class org.writersforge.catalan.transform.DirectiveStack.Pcdata.: A Directive to insert PCDATA content into the current element.
DirectiveStack.Pcdata() - Constructor for class org.writersforge.catalan.transform.DirectiveStack.Pcdata: Creates a new instance of Pcdata.
DirectiveStack.Pcdata(String) - Constructor for class org.writersforge.catalan.transform.DirectiveStack.Pcdata: Creates a new instance of Pcdata.
DirectiveStack.Repeat - class org.writersforge.catalan.transform.DirectiveStack.Repeat.: A Directive to repeat an embedded stack of directives until a certain condition is met.
DirectiveStack.Repeat(DirectiveStack) - Constructor for class org.writersforge.catalan.transform.DirectiveStack.Repeat: Creates a new instance of Repeat.
DirectiveStack.StartElement - class org.writersforge.catalan.transform.DirectiveStack.StartElement.: A Directive to start a new Datum element.
DirectiveStack.StartElement() - Constructor for class org.writersforge.catalan.transform.DirectiveStack.StartElement: Creates a new instance of StartElement.
DirectiveStack.StartElement(String) - Constructor for class org.writersforge.catalan.transform.DirectiveStack.StartElement: Creates a new instance of StartElement.
DirectiveStack() - Constructor for class org.writersforge.catalan.transform.DirectiveStack: Creates a new instance of DirectiveStack.
DirectiveStack(int, Object) - Constructor for class org.writersforge.catalan.transform.DirectiveStack: Creates a new instance of DirectiveStack with optional maximum iterations and an input node to trigger a premature bailout.
DTDGenerator - class org.writersforge.catalan.DTDGenerator.: Command-line utility to generate an XML DTD from DataModel XML.
DTDGenerator() - Constructor for class org.writersforge.catalan.DTDGenerator
DTDTemplate - class org.writersforge.catalan.templates.DTDTemplate.: Template for creating a DTD text file from a data-model XML description.
DTDTemplate() - Constructor for class org.writersforge.catalan.templates.DTDTemplate: Creates a new instance of DTDTemplate

E

end(List) - Method in class org.writersforge.catalan.transform.Concatenator: Ends the current traversal.
end(List) - Method in class org.writersforge.catalan.transform.AsciiConverter: Ends the current traversal.
end(List) - Method in class org.writersforge.catalan.transform.ObjectToDatum: Ends the current traversal.
end(List) - Method in class org.writersforge.catalan.transform.BaseNodeProcessor: Ends the current traversal.
endBook(Book) - Method in class org.writersforge.catalan.renderers.TextRenderer: Performs any cleanup that the Renderer must do at the end of the rendering process.
endBook(Book) - Method in class org.writersforge.catalan.renderers.Renderer: Performs any cleanup that the Renderer must do at the end of the rendering process.
endBook(Book) - Method in class org.writersforge.catalan.renderers.PdfRenderer: Performs any cleanup that the Renderer must do at the end of the rendering process
endPage(Page) - Method in class org.writersforge.catalan.renderers.Renderer: Performs any cleanup that the Renderer must do after every Page.
endPage(Page) - Method in class org.writersforge.catalan.renderers.PdfRenderer: Performs any cleanup that the Renderer must do after every Page.
EQUAL_MASK - Static variable in class org.writersforge.catalan.layout.Relation: Require equal to distance
ExtentStyle - interface org.writersforge.catalan.layout.style.ExtentStyle.: The requested geometrical size of an area.
extractValue(int, String) - Method in class org.writersforge.catalan.transform.AsciiFieldManager: Parses the asciiData input data and pulls out the data corresponding to the given field index, then converts that data to the correct Java data type.

F

findColor(String) - Method in interface org.writersforge.catalan.layout.style.StyleMap: Returns a Color object corresponding to the given name.
findColor(String) - Method in class org.writersforge.catalan.layout.style.DefaultStyle: Returns a Color object corresponding to the given name.
findColor(String) - Method in class org.writersforge.catalan.layout.style.DatumStyleMap: Returns a Color object corresponding to the given name.
findRelation(Class) - Method in class org.writersforge.catalan.layout.Constraint: Searches this Constraint for a Relation object of the given class.
findRelation(Class, int) - Method in class org.writersforge.catalan.layout.Constraint: Searches this Constraint for a Relation object of the given class.
fitsInRegion(LayoutArea) - Method in interface org.writersforge.catalan.layout.LayoutEngine: Checks to see if the given area will fit anywhere in the current layout region.
fitsInRegion(LayoutArea) - Method in class org.writersforge.catalan.layout.AbstractLayoutEngine: Checks to see if the given area will fit anywhere in the current layout region.
fitsInRegion(LayoutArea, Rectangle, List) - Method in class org.writersforge.catalan.layout.SimpleFlowLayout: Checks to see if the area will fit in the given region.
fitsInRegion(LayoutArea, Rectangle, List) - Method in interface org.writersforge.catalan.layout.LayoutEngine: Deprecated.
fitsInRegion(LayoutArea, Rectangle, List) - Method in class org.writersforge.catalan.layout.AsciiLayout: Checks to see if the area will fit in the given region.
fitsOnPage(Page, LayoutArea) - Method in class org.writersforge.catalan.layout.AsciiLayout: Checks to see if the area will fit on the given Page.
FIXED_CHAR_MULT - Static variable in class org.writersforge.catalan.layout.style.FontStyleMetrics: Default multiplier for converting font point size into character width.
flush() - Method in class org.writersforge.catalan.layout.LayoutContext: Removes all renderable areas from the queue.
FONT_STYLE_BOLD - Static variable in interface org.writersforge.catalan.layout.style.FontStyle: Enumeration value for specifying bold font style
FONT_STYLE_ITALIC - Static variable in interface org.writersforge.catalan.layout.style.FontStyle: Enumeration value for specifying italic font style
FONT_STYLE_PLAIN - Static variable in interface org.writersforge.catalan.layout.style.FontStyle: Enumeration value for specifying plain font style
FontStyle - interface org.writersforge.catalan.layout.style.FontStyle.: The font style for a span of text.
FontStyleMetrics - class org.writersforge.catalan.layout.style.FontStyleMetrics.: Wrapper class to calculate font metrics based on a FontStyle object.
FontStyleMetrics(FontStyle) - Constructor for class org.writersforge.catalan.layout.style.FontStyleMetrics: Creates a new instance of FontStyleMetrics from the FontStyle.
FontStyleMetrics(String, int, int) - Constructor for class org.writersforge.catalan.layout.style.FontStyleMetrics: Creates a new instance of FontStyleMetrics with the explicit font parameters and a calculated font height.
FontStyleMetrics(String, int, int, int) - Constructor for class org.writersforge.catalan.layout.style.FontStyleMetrics: Creates a new instance of FontStyleMetrics with the explicit font parameters.
ForEachOp - class org.writersforge.catalan.templates.generic.ForEachOp.: A template op wrapper for <for-each>.
ForEachOp(Datum, StyleMap) - Constructor for class org.writersforge.catalan.templates.generic.ForEachOp: Creates a new instance of ForEachOp.
ForEachOp(Datum, StyleMap, StyleChain) - Constructor for class org.writersforge.catalan.templates.generic.ForEachOp: Creates a new instance of ForEachOp with an optional StyleChain fallback.

G

GenericGenerator - class org.writersforge.catalan.GenericGenerator.: Content generator for creating PDFs, HTML, and ASCII text files from arbitrary XML data formats, using a layout-template XML file to filter and position the data in the output medium.
GenericGenerator() - Constructor for class org.writersforge.catalan.GenericGenerator
GenericOp - class org.writersforge.catalan.templates.generic.GenericOp.: Base class for all template ops.
GenericOp(Datum, StyleMap) - Constructor for class org.writersforge.catalan.templates.generic.GenericOp: Creates a new instance of GenericOp.
GenericOp(Datum, StyleMap, StyleChain) - Constructor for class org.writersforge.catalan.templates.generic.GenericOp: Creates a new instance of GenericOp with an optional StyleChain argument.
GenericRegionMap - class org.writersforge.catalan.templates.generic.GenericRegionMap.: A RegionMap that is backed by a Generic XML <region-map> element.
GenericRegionMap(ListDatum) - Constructor for class org.writersforge.catalan.templates.generic.GenericRegionMap: Creates a new instance of GenericRegionMap.
GenericTemplate - class org.writersforge.catalan.templates.GenericTemplate.: A configurable template driven by an XML layout template which can transform arbitrary XML inputs into layouts.
GenericTemplate() - Constructor for class org.writersforge.catalan.templates.GenericTemplate
getAcceptedAreas() - Method in class org.writersforge.catalan.layout.LayoutContext: Returns an array of areas ready to be rendered onto a Page.
getAreas() - Method in class org.writersforge.catalan.layout.Page: Getter for property areas, the layout areas associated with this Page.
getAreas(int) - Method in class org.writersforge.catalan.layout.Page: Indexed getter for property areas, the layout areas associated with this Page.
getAreaStyle(String) - Method in interface org.writersforge.catalan.layout.style.StyleMap: Returns the named area style from this map.
getAreaStyle(String) - Method in class org.writersforge.catalan.layout.style.DefaultStyle: Returns the named area style from this map.
getAreaStyle(String) - Method in class org.writersforge.catalan.layout.style.DatumStyleMap: Returns the named area style from this map.
getAreaStyles() - Method in class org.writersforge.catalan.layout.style.StyleChain: Returns an array of all AreaStyle objects in this chain.
getAscent() - Method in class org.writersforge.catalan.layout.style.FontStyleMetrics: Returns the ascent for this font.
getBackgroundColor() - Method in class org.writersforge.catalan.layout.style.StyleChain: Returns the background color of this area.
getBackgroundColor() - Method in class org.writersforge.catalan.layout.style.DefaultStyle: Returns the background color of this area.
getBackgroundColor() - Method in class org.writersforge.catalan.layout.style.DatumStyleWrapper: Returns the background color of this area.
getBackgroundColor() - Method in interface org.writersforge.catalan.layout.style.AreaStyle: Returns the background color of this area.
getBook() - Method in class org.writersforge.catalan.layout.Page: Getter for property book, the owning Book for this Page.
getBorderColor() - Method in class org.writersforge.catalan.layout.style.StyleChain: Returns the color of the border enclosing this area.
getBorderColor() - Method in class org.writersforge.catalan.layout.style.DefaultStyle: Returns the color of the border enclosing this area.
getBorderColor() - Method in class org.writersforge.catalan.layout.style.DatumStyleWrapper: Returns the color of the border enclosing this area.
getBorderColor() - Method in interface org.writersforge.catalan.layout.style.BorderStyle: Returns the color of the border enclosing this area.
getBorderWidth() - Method in class org.writersforge.catalan.layout.style.StyleChain: Returns the width of the border enclosing this area.
getBorderWidth() - Method in class org.writersforge.catalan.layout.style.DefaultStyle: Returns the width of the border enclosing this area.
getBorderWidth() - Method in class org.writersforge.catalan.layout.style.DatumStyleWrapper: Returns the width of the border enclosing this area.
getBorderWidth() - Method in interface org.writersforge.catalan.layout.style.BorderStyle: Returns the width of the border enclosing this area.
getChain() - Method in class org.writersforge.catalan.templates.generic.GenericOp: Returns the StyleChain for this op.
getChildren() - Method in class org.writersforge.catalan.layout.LayoutGroup: Getter for property children, the child layout areas.
getChildren() - Method in class org.writersforge.catalan.layout.LayoutArea: Getter for property children, the child layout areas.
getChildren(int) - Method in class org.writersforge.catalan.layout.LayoutGroup: Indexed getter for property children, the child layout areas.
getChildren(int) - Method in class org.writersforge.catalan.layout.LayoutArea: Indexed getter for property children, the child layout areas.
getColumnFlowSelect() - Method in class org.writersforge.catalan.templates.generic.TableOp: Returns the 'select' property for the <column-flow> op, or an empty string if 'select' is not specified.
getColumnHeaderSelect() - Method in class org.writersforge.catalan.templates.generic.TableOp: Returns the 'select' property for the <column-headers> op, or an empty string if 'select' is not specified.
getCurrentArea() - Method in class org.writersforge.catalan.layout.LayoutContext: Returns the LayoutArea object most recently pulled off the stack.
getCurrentPage() - Method in class org.writersforge.catalan.layout.Book: Gets the current page object in this Book.
getCurrentPage() - Method in class org.writersforge.catalan.templates.RenderTemplate: Retrieves the current page index
getCurrentPageNumber() - Method in class org.writersforge.catalan.layout.Book: Gets the current page number in this Book.
getCurrentRegion() - Method in class org.writersforge.catalan.layout.LayoutContext: Retrieves the cached current rendering region.
getData() - Method in class org.writersforge.catalan.layout.Book: Gets the Book's raw input data
getDatum() - Method in class org.writersforge.catalan.templates.generic.GenericOp: Returns the op itself.
getDatum() - Method in class org.writersforge.catalan.transform.rule.CreateRule: Getter for property datumName, the name of the new Datum.
getDatumProperty(String) - Method in class org.writersforge.catalan.templates.generic.GenericOp: Returns a property value from the encapsulated Datum op.
getDefaultAreaStyle() - Method in interface org.writersforge.catalan.layout.style.StyleMap: Returns the default area style from this map.
getDefaultAreaStyle() - Method in class org.writersforge.catalan.layout.style.DefaultStyle: Returns the default area style from this map.
getDefaultAreaStyle() - Method in class org.writersforge.catalan.layout.style.DatumStyleMap: Returns the default area style from this map.
getDefaultFont() - Method in interface org.writersforge.catalan.layout.style.TextStyle: Returns the default FontStyle of this text.
getDefaultFont() - Method in class org.writersforge.catalan.layout.style.StyleChain: Returns the default FontStyle of this text.
getDefaultFont() - Method in class org.writersforge.catalan.layout.style.DefaultStyle: Returns the default FontStyle of this text.
getDefaultFont() - Method in class org.writersforge.catalan.layout.style.DatumStyleWrapper: Returns the default FontStyle of this text.
getDefaultFontStyle() - Method in interface org.writersforge.catalan.layout.style.StyleMap: Returns the default font style from this map.
getDefaultFontStyle() - Method in class org.writersforge.catalan.layout.style.DefaultStyle: Returns the default font style from this map.
getDefaultFontStyle() - Method in class org.writersforge.catalan.layout.style.DatumStyleMap: Returns the default font style from this map.
getDefaultPageHeight() - Method in class org.writersforge.catalan.templates.RenderTemplate: Retrieves the default Page height for this template.
getDefaultPageHeight() - Method in class org.writersforge.catalan.templates.GenericTemplate: Retrieves the default Page height for this template.
getDefaultPageHeight() - Method in class org.writersforge.catalan.templates.DTDTemplate: Retrieves the default Page height for this template.
getDefaultPageWidth() - Method in class org.writersforge.catalan.templates.RenderTemplate: Retrieves the default Page width for this template.
getDefaultPageWidth() - Method in class org.writersforge.catalan.templates.GenericTemplate: Retrieves the default Page width for this template.
getDefaultPageWidth() - Method in class org.writersforge.catalan.templates.DTDTemplate: Retrieves the default Page width for this template.
getDefaultTextStyle() - Method in interface org.writersforge.catalan.layout.style.StyleMap: Returns the default text style from this map.
getDefaultTextStyle() - Method in class org.writersforge.catalan.layout.style.DefaultStyle: Returns the default text style from this map.
getDefaultTextStyle() - Method in class org.writersforge.catalan.layout.style.DatumStyleMap: Returns the default text style from this map.
getDescent() - Method in class org.writersforge.catalan.layout.style.FontStyleMetrics: Returns the descent for this font.
getDescription() - Method in class org.writersforge.catalan.layout.style.StyleChain: Returns an optional text description of this area.
getDescription() - Method in class org.writersforge.catalan.layout.style.DefaultStyle: Returns an optional text description of this area.
getDescription() - Method in class org.writersforge.catalan.layout.style.DatumStyleWrapper: Returns an optional text description of this area.
getDescription() - Method in interface org.writersforge.catalan.layout.style.AreaStyle: Returns an optional text description of this area.
getDestination() - Method in class org.writersforge.catalan.transform.rule.CopyRule: Getter for property destination, the Bellows query defining where to move to.
getDestinationNodes(Datum) - Method in class org.writersforge.catalan.transform.xform.MoveProcessor: Finds the Datum nodes to perform the transformation on.
getDestinationNodes(Datum) - Method in class org.writersforge.catalan.transform.xform.CopyProcessor: Finds the Datum nodes to perform the transformation on.
getDistance() - Method in class org.writersforge.catalan.layout.Relation: Getter for property distance, a scalar measure to use with comparisons.
getEnd() - Method in class org.writersforge.catalan.layout.StyledText.Span: Getter for property end, the index of the last text character in the style span.
getEnd() - Method in class org.writersforge.catalan.layout.Markup: Getter for property end, the index of the last text character in the style span.
getExtents() - Method in class org.writersforge.catalan.layout.LayoutArea: Getter for property extents, the actual extents for this area.
getFieldArraySize(int) - Method in class org.writersforge.catalan.transform.AsciiFieldManager: Retrieves the number of array elements of the given field.
getFieldCount() - Method in class org.writersforge.catalan.transform.AsciiFieldManager: Calculates the number of discrete fields in the format spec.
getFieldLength(int) - Method in class org.writersforge.catalan.transform.AsciiFieldManager: Retrieves the length of the given field in its ASCII version.
getFieldType(int) - Method in class org.writersforge.catalan.transform.AsciiFieldManager: Retrieves the Java type that corresponds to the given field number.
getFile() - Method in class org.writersforge.catalan.templates.generic.ImageOp: Retrieves the file path for the image that this op should render.
getFirstLineIndent() - Method in interface org.writersforge.catalan.layout.style.TextStyle: Returns the first line indent property of this text.
getFirstLineIndent() - Method in class org.writersforge.catalan.layout.style.StyleChain: Returns the first line indent property of this text.
getFirstLineIndent() - Method in class org.writersforge.catalan.layout.style.DefaultStyle: Returns the first line indent property of this text.
getFirstLineIndent() - Method in class org.writersforge.catalan.layout.style.DatumStyleWrapper: Returns the first line indent property of this text.
getFlowTemplate(String) - Method in class org.writersforge.catalan.templates.Section: Returns a Datum object that embodies the flow template for the named region.
getFontColor() - Method in class org.writersforge.catalan.layout.style.StyleChain: Returns the color of this run of text.
getFontColor() - Method in class org.writersforge.catalan.layout.style.FontStyleMetrics: Returns the color of this run of text.
getFontColor() - Method in interface org.writersforge.catalan.layout.style.FontStyle: Returns the color of this run of text.
getFontColor() - Method in class org.writersforge.catalan.layout.style.DefaultStyle: Returns the color of this run of text.
getFontColor() - Method in class org.writersforge.catalan.layout.style.DatumStyleWrapper: Returns the color of this run of text.
getFontHeight() - Method in class org.writersforge.catalan.layout.style.StyleChain: Estimates the height of the font in point size.
getFontHeight() - Method in class org.writersforge.catalan.layout.style.FontStyleMetrics: Estimates the height of the font in point size.
getFontHeight() - Method in interface org.writersforge.catalan.layout.style.FontStyle: Estimates the height of the font in point size.
getFontHeight() - Method in class org.writersforge.catalan.layout.style.DefaultStyle: Estimates the height of the font in point size.
getFontHeight() - Method in class org.writersforge.catalan.layout.style.DatumStyleWrapper: Estimates the height of the font in point size.
getFontName() - Method in class org.writersforge.catalan.layout.style.StyleChain: Returns the font name property of the style.
getFontName() - Method in class org.writersforge.catalan.layout.style.FontStyleMetrics: Getter for property name, the name of the font.
getFontName() - Method in interface org.writersforge.catalan.layout.style.FontStyle: Returns the font name property of the style.
getFontName() - Method in class org.writersforge.catalan.layout.style.DefaultStyle: Returns the font name property of the style.
getFontName() - Method in class org.writersforge.catalan.layout.style.DatumStyleWrapper: Returns the font name property of the style.
getFontSize() - Method in class org.writersforge.catalan.layout.style.StyleChain: Returns the font size property of the style.
getFontSize() - Method in class org.writersforge.catalan.layout.style.FontStyleMetrics: Getter for property size, the point size of the font.
getFontSize() - Method in interface org.writersforge.catalan.layout.style.FontStyle: Returns the font size property of the style.
getFontSize() - Method in class org.writersforge.catalan.layout.style.DefaultStyle: Returns the font size property of the style.
getFontSize() - Method in class org.writersforge.catalan.layout.style.DatumStyleWrapper: Returns the font size property of the style.
getFontStyle() - Method in class org.writersforge.catalan.layout.StyledText: Returns the font style of this object
getFontStyle() - Method in class org.writersforge.catalan.layout.style.StyleChain: Returns the font style property of the style.
getFontStyle() - Method in class org.writersforge.catalan.layout.style.FontStyleMetrics: Getter for property style: plain, bold, or italic.
getFontStyle() - Method in interface org.writersforge.catalan.layout.style.FontStyle: Returns the font style property of the style.
getFontStyle() - Method in class org.writersforge.catalan.layout.style.DefaultStyle: Returns the font style property of the style.
getFontStyle() - Method in class org.writersforge.catalan.layout.style.DatumStyleWrapper: Returns the font style property of the style.
getFontStyle(String) - Method in interface org.writersforge.catalan.layout.style.StyleMap: Returns the named font style from this map.
getFontStyle(String) - Method in class org.writersforge.catalan.layout.style.DefaultStyle: Returns the named font style from this map.
getFontStyle(String) - Method in class org.writersforge.catalan.layout.style.DatumStyleMap: Returns the named font style from this map.
getFontStyles() - Method in class org.writersforge.catalan.layout.style.StyleChain: Returns an array of all FontStyle objects in this chain.
getFreeSpace() - Method in interface org.writersforge.catalan.layout.LayoutEngine: Returns the free space in the current layout region.
getFreeSpace() - Method in class org.writersforge.catalan.layout.AbstractLayoutEngine: Returns the free space in the current layout region.
getHAlign() - Method in class org.writersforge.catalan.layout.style.StyleChain: Returns the horizontal alignment property of the style.
getHAlign() - Method in class org.writersforge.catalan.layout.style.DefaultStyle: Returns the horizontal alignment property of the style.
getHAlign() - Method in class org.writersforge.catalan.layout.style.DatumStyleWrapper: Returns the horizontal alignment property of the style.
getHAlign() - Method in interface org.writersforge.catalan.layout.style.AlignStyle: Returns the horizontal alignment property of the style.
getHeight() - Method in class org.writersforge.catalan.layout.Page: Getter for property height, the height of the Page in font points.
getHeight() - Method in class org.writersforge.catalan.layout.LayoutArea: Getter for property height, the final calculated height to render this area.
getHint() - Method in class org.writersforge.catalan.layout.LayoutArea: Getter for property hint, an optional field for descriptive info.
getIndent() - Method in class org.writersforge.catalan.layout.style.StyleChain: Returns the left indent spacing of this area.
getIndent() - Method in interface org.writersforge.catalan.layout.style.InsetStyle: Returns the left indent spacing of this area.
getIndent() - Method in class org.writersforge.catalan.layout.style.DefaultStyle: Returns the left indent spacing of this area.
getIndent() - Method in class org.writersforge.catalan.layout.style.DatumStyleWrapper: Returns the left indent spacing of this area.
getInsets() - Method in class org.writersforge.catalan.layout.Page: Getter for property insets, the unwritable margins for this Page.
getInsets() - Method in class org.writersforge.catalan.layout.style.StyleChain: Returns an Insets object set to the values of all four InsetStyle properties, indent, rightIndent, spaceBefore, and spaceAfter.
getInsets() - Method in interface org.writersforge.catalan.layout.style.InsetStyle: Returns an Insets object set to the values of all four InsetStyle properties, indent, rightIndent, spaceBefore, and spaceAfter.
getInsets() - Method in class org.writersforge.catalan.layout.style.DefaultStyle: Returns an Insets object set to the values of all four InsetStyle properties, indent, rightIndent, spaceBefore, and spaceAfter.
getInsets() - Method in class org.writersforge.catalan.layout.style.DatumStyleWrapper: Returns an Insets object set to the values of all four InsetStyle properties, indent, rightIndent, spaceBefore, and spaceAfter.
getInstance() - Static method in class org.writersforge.catalan.transform.ProcessorFactory: Retrieves the singleton instance of the ProcessorFactory.
getIntersects() - Method in class org.writersforge.catalan.layout.StyledText.Span: Getter for property intersects, all Markup objects that overlap this Span.
getLargest() - Method in class org.writersforge.catalan.layout.Constraint: Getter for property largest, the maximum size an area can be.
getLayout() - Method in class org.writersforge.catalan.templates.RenderTemplate: Retrieves the current LayoutEngine
getLeading() - Method in class org.writersforge.catalan.layout.style.FontStyleMetrics: Returns the leading for this font.
getLeftovers() - Method in class org.writersforge.catalan.transform.BaseNodeProcessor: Retrieves the current list of unprocessed input nodes.
getMarkup() - Method in class org.writersforge.catalan.layout.StyledText: Getter for property markup.
getMatch() - Method in class org.writersforge.catalan.templates.generic.IfOp: Returns the 'match' property of the op, or "" if 'match' is not specified.
getMaximum() - Method in class org.writersforge.catalan.layout.style.StyleChain: Returns the maximum geometrical extents of this area.
getMaximum() - Method in interface org.writersforge.catalan.layout.style.ExtentStyle: Returns the maximum geometrical extents of this area.
getMaximum() - Method in class org.writersforge.catalan.layout.style.DefaultStyle: Returns the maximum geometrical extents of this area.
getMaximum() - Method in class org.writersforge.catalan.layout.style.DatumStyleWrapper: Returns the maximum geometrical extents of this area.
getMinimum() - Method in class org.writersforge.catalan.layout.style.StyleChain: Returns the minimum geometrical extents of this area.
getMinimum() - Method in interface org.writersforge.catalan.layout.style.ExtentStyle: Returns the minimum geometrical extents of this area.
getMinimum() - Method in class org.writersforge.catalan.layout.style.DefaultStyle: Returns the minimum geometrical extents of this area.
getMinimum() - Method in class org.writersforge.catalan.layout.style.DatumStyleWrapper: Returns the minimum geometrical extents of this area.
getName() - Method in class org.writersforge.catalan.transform.DirectiveStack.Attribute: Retrieves the name property of this Attribute directive.
getNewName() - Method in class org.writersforge.catalan.transform.rule.RenameRule: Getter for property newName.
getNextDirective(Object) - Method in class org.writersforge.catalan.transform.DirectiveStack: Retrieves the next Directive in the stack.
getNodes() - Method in class org.writersforge.catalan.transform.BaseNodeProcessor: Retrieves the current node processing list.
getOp() - Method in class org.writersforge.catalan.templates.generic.GenericOp: Returns the encapsulated Datum op.
getOpType() - Method in class org.writersforge.catalan.templates.generic.GenericOp: Returns the element name of this op.
getOrientation() - Method in class org.writersforge.catalan.layout.LayoutGroup: Getter for property orientation, flow orientation of the children in this group
getOuterRegion() - Method in class org.writersforge.catalan.layout.LayoutContext: Retrieves the the top-level layout region.
getPage(int) - Method in class org.writersforge.catalan.layout.Book: Gets a single processed page.
getPages() - Method in class org.writersforge.catalan.layout.Book: Gets the array of processed pages.
getParameter(char) - Method in class org.writersforge.catalan.templates.generic.GenericOp: Returns the value of a numbered parameter; used for parameterized queries.
getPreferred() - Method in class org.writersforge.catalan.layout.Constraint: Getter for property preferred, the optimal size an area can be.
getPreferred() - Method in class org.writersforge.catalan.layout.style.StyleChain: Returns the preferred geometrical extents of this area.
getPreferred() - Method in interface org.writersforge.catalan.layout.style.ExtentStyle: Returns the preferred geometrical extents of this area.
getPreferred() - Method in class org.writersforge.catalan.layout.style.DefaultStyle: Returns the preferred geometrical extents of this area.
getPreferred() - Method in class org.writersforge.catalan.layout.style.DatumStyleWrapper: Returns the preferred geometrical extents of this area.
getProcessorIds() - Method in class org.writersforge.catalan.transform.Transformer: Retrieves an array of unique identifiers for all NodeProcessors in this Transformer.
getProperty() - Method in class org.writersforge.catalan.templates.generic.TextOp: Returns the 'property' property of the op, or null if 'property' is not specified.
getProperty(String) - Method in class org.writersforge.catalan.layout.Book: Returns the value of a generic property.
getPropertyName() - Method in class org.writersforge.catalan.transform.rule.QueryRule: Getter for property propertyName, the optional Datum property name inside the content.
getPropertyValue() - Method in class org.writersforge.catalan.transform.rule.CreateRule: Getter for property propertyValue, the value of the new property.
getQuery() - Method in class org.writersforge.catalan.transform.rule.QueryRule: Getter for property query, the Bellows query for selecting target content.
getQuery() - Method in class org.writersforge.catalan.transform.xform.XFormProcessor: Retrieves the Bellows query path to select nodes to process.
getQueryNodes(Datum) - Method in class org.writersforge.catalan.transform.xform.XFormProcessor: Finds the Datum nodes to perform the transformation on.
getQueueSize() - Method in interface org.writersforge.catalan.layout.LayoutEngine: Returns the number of areas currently in the layout queue.
getQueueSize() - Method in class org.writersforge.catalan.layout.AbstractLayoutEngine: Returns the number of areas currently in the layout queue.
getRegion(String) - Method in class org.writersforge.catalan.templates.Section: Returns a Rectangle that defines the bounding area for the named region.
getRegionExtents(String) - Method in interface org.writersforge.catalan.templates.RegionMap: Returns the geometrical extents of the named region.
getRegionExtents(String) - Method in class org.writersforge.catalan.templates.generic.GenericRegionMap: Returns the geometrical extents of the named region.
getRegionMap() - Method in class org.writersforge.catalan.templates.Section: Getter for property regionMap.
getRegionNames() - Method in class org.writersforge.catalan.templates.Section: Returns an array of all region names in this section which have flow and/or static content.
getRegionNames() - Method in interface org.writersforge.catalan.templates.RegionMap: Returns an array of all valid region names in this map.
getRegionNames() - Method in class org.writersforge.catalan.templates.generic.GenericRegionMap: Returns an array of all valid region names in this map.
getRelations() - Method in class org.writersforge.catalan.layout.Constraint: Getter for property relations.
getRelations(int) - Method in class org.writersforge.catalan.layout.Constraint: Indexed getter for property relations.
getRenderableExtents() - Method in class org.writersforge.catalan.layout.LayoutArea: Retrieves a Rectangle of the valid rendering extents for this area, the normal extents minus the insets.
getRightIndent() - Method in class org.writersforge.catalan.layout.style.StyleChain: Returns the right indent spacing of this area.
getRightIndent() - Method in interface org.writersforge.catalan.layout.style.InsetStyle: Returns the right indent spacing of this area.
getRightIndent() - Method in class org.writersforge.catalan.layout.style.DefaultStyle: Returns the right indent spacing of this area.
getRightIndent() - Method in class org.writersforge.catalan.layout.style.DatumStyleWrapper: Returns the right indent spacing of this area.
getRowFlowSelect() - Method in class org.writersforge.catalan.templates.generic.TableOp: Returns the 'select' property for the <row-flow> op, or an empty string if 'select' is not specified.
getRowHeaderSelect() - Method in class org.writersforge.catalan.templates.generic.TableOp: Returns the 'select' property for the <row-headers> op, or an empty string if 'select' is not specified.
getRuleCount() - Method in class org.writersforge.catalan.transform.rule.RuleCollection: Returns the number of child Rule objects in this collection.
getSections() - Method in class org.writersforge.catalan.templates.RenderTemplate: Returns an array of all Section objects associated with this template.
getSections() - Method in class org.writersforge.catalan.templates.GenericTemplate: Returns an array of all Section objects associated with this template.
getSections() - Method in class org.writersforge.catalan.templates.DTDTemplate: Returns an array of all Section objects associated with this template.
getSelect() - Method in class org.writersforge.catalan.templates.generic.TextOp: Returns the 'select' property of the op, or "" if 'select' is not specified.
getSelect() - Method in class org.writersforge.catalan.templates.generic.ForEachOp: Returns the 'select' property of the op, or "" if 'select' is not specified.
getSmallest() - Method in class org.writersforge.catalan.layout.Constraint: Getter for property smallest, the minimum size an area can be.
getSpaceAfter() - Method in class org.writersforge.catalan.layout.style.StyleChain: Returns the bottom indent spacing of this area.
getSpaceAfter() - Method in interface org.writersforge.catalan.layout.style.InsetStyle: Returns the bottom indent spacing of this area.
getSpaceAfter() - Method in class org.writersforge.catalan.layout.style.DefaultStyle: Returns the bottom indent spacing of this area.
getSpaceAfter() - Method in class org.writersforge.catalan.layout.style.DatumStyleWrapper: Returns the bottom indent spacing of this area.
getSpaceBefore() - Method in class org.writersforge.catalan.layout.style.StyleChain: Returns the top indent spacing of this area.
getSpaceBefore() - Method in interface org.writersforge.catalan.layout.style.InsetStyle: Returns the top indent spacing of this area.
getSpaceBefore() - Method in class org.writersforge.catalan.layout.style.DefaultStyle: Returns the top indent spacing of this area.
getSpaceBefore() - Method in class org.writersforge.catalan.layout.style.DatumStyleWrapper: Returns the top indent spacing of this area.
getSpans() - Method in class org.writersforge.catalan.layout.StyledText: Returns an array of text spans that delimit all changes in text style, i.e., a list of discrete markup regions.
getStack() - Method in class org.writersforge.catalan.transform.DirectiveStack.Repeat: Retrieves the embedded stack.
getStackCount() - Method in class org.writersforge.catalan.layout.LayoutContext: Returns the number of unhandled areas left in the queue.
getStart() - Method in class org.writersforge.catalan.layout.StyledText.Span: Getter for property start, the index of the first text character in the style span.
getStart() - Method in class org.writersforge.catalan.layout.Markup: Getter for property start, the index of the first text character in the style span.
getStaticTemplate(String) - Method in class org.writersforge.catalan.templates.Section: Returns a Datum object that embodies the static template for the named region.
getStyle() - Method in class org.writersforge.catalan.layout.Markup: Getter for property style, the font for this markup section.
getStyle() - Method in class org.writersforge.catalan.layout.LayoutArea: Getter for property style, the layout constraints set up by the template for this area.
getStyledText() - Method in class org.writersforge.catalan.layout.LayoutText: Getter for property styledText, the multi-style text content of this area.
getStyleMap() - Method in class org.writersforge.catalan.templates.generic.GenericOp: Returns the StyleMap for this op.
getTarget() - Method in class org.writersforge.catalan.layout.Relation: Getter for property target, the LayoutArea (attractor) to bind to.
getText() - Method in class org.writersforge.catalan.layout.StyledText: Returns a plain text version of the text contents.
getText() - Method in class org.writersforge.catalan.layout.LayoutText: Getter for property text, the raw text content of this area.
getText() - Method in class org.writersforge.catalan.templates.generic.LiteralOp: Retrieves the PCDATA text content from the current literal op.
getTextHeight(int) - Method in class org.writersforge.catalan.layout.StyledText: Calculates the vertical extents of the entire run of text, if the text were wrapped to the given width.
getTextLength() - Method in class org.writersforge.catalan.layout.StyledText: Returns the total count of text characters.
getTextStyle() - Method in class org.writersforge.catalan.layout.StyledText: Returns the text style of this object
getTextStyle(String) - Method in interface org.writersforge.catalan.layout.style.StyleMap: Returns the named text style from this map.
getTextStyle(String) - Method in class org.writersforge.catalan.layout.style.DefaultStyle: Returns the named text style from this map.
getTextStyle(String) - Method in class org.writersforge.catalan.layout.style.DatumStyleMap: Returns the named text style from this map.
getTextStyles() - Method in class org.writersforge.catalan.layout.style.StyleChain: Returns an array of all TextStyle objects in this chain.
getVAlign() - Method in class org.writersforge.catalan.layout.style.StyleChain: Returns the vertical alignment property of the style.
getVAlign() - Method in class org.writersforge.catalan.layout.style.DefaultStyle: Returns the vertical alignment property of the style.
getVAlign() - Method in class org.writersforge.catalan.layout.style.DatumStyleWrapper: Returns the vertical alignment property of the style.
getVAlign() - Method in interface org.writersforge.catalan.layout.style.AlignStyle: Returns the vertical alignment property of the style.
getValue() - Method in class org.writersforge.catalan.transform.DirectiveStack.Directive: Retrieves the static value of this directive.
getWeight() - Method in class org.writersforge.catalan.layout.Relation: Getter for property weight, how important this relationship is.
getWidth() - Method in class org.writersforge.catalan.layout.Page: Getter for property width, the width of the Page in font points.
getWidth() - Method in class org.writersforge.catalan.layout.LayoutArea: Getter for property width, the final calculated width to render this area.
getWrap() - Method in interface org.writersforge.catalan.layout.style.TextStyle: Returns the wrap style of this text, according to the WRAP_xxx enumeration.
getWrap() - Method in class org.writersforge.catalan.layout.style.StyleChain: Returns the wrap style of this text, according to the WRAP_xxx enumeration.
getWrap() - Method in class org.writersforge.catalan.layout.style.DefaultStyle: Returns the wrap style of this text, according to the WRAP_xxx enumeration.
getWrap() - Method in class org.writersforge.catalan.layout.style.DatumStyleWrapper: Returns the wrap style of this text, according to the WRAP_xxx enumeration.
getX() - Method in class org.writersforge.catalan.layout.LayoutArea: Getter for property x, the final calculated x-axis origin to render this area.
getY() - Method in class org.writersforge.catalan.layout.LayoutArea: Getter for property y, the final calculated y-axis origin to render this area.
GREATER_THAN_EQUAL_MASK - Static variable in class org.writersforge.catalan.layout.Relation: Require greater than or equal to distance
GREATER_THAN_MASK - Static variable in class org.writersforge.catalan.layout.Relation: Require greater than distance
GroupOp - class org.writersforge.catalan.templates.generic.GroupOp.: A vertical or horizontal container of other ops, depending on whether the op was a <row> or <column> element.
GroupOp(Datum, StyleMap) - Constructor for class org.writersforge.catalan.templates.generic.GroupOp: Creates a new instance of a vertically oriented GroupOp.
GroupOp(Datum, StyleMap, int) - Constructor for class org.writersforge.catalan.templates.generic.GroupOp: Creates a new instance of a GroupOp.
GroupOp(Datum, StyleMap, StyleChain) - Constructor for class org.writersforge.catalan.templates.generic.GroupOp: Creates a new instance of a vertically oriented GroupOp with an optional StyleChain fallback.
GroupOp(Datum, StyleMap, StyleChain, int) - Constructor for class org.writersforge.catalan.templates.generic.GroupOp: Creates a new instance of a GroupOp with an optional StyleChain fallback.
GroupProcessor - class org.writersforge.catalan.transform.GroupProcessor.: Composite NodeProcessor which can combine multiple processors into a single easily referenced one.
GroupProcessor(NodeProcessor[], String) - Constructor for class org.writersforge.catalan.transform.GroupProcessor: Creates a new instance of GroupProcessor.
guessSize(LayoutArea) - Method in class org.writersforge.catalan.layout.SimpleFlowLayout: Estimates the size that the area "wants" to be.
guessSize(LayoutArea) - Method in interface org.writersforge.catalan.layout.LayoutEngine: Estimates the size that the area "wants" to be.
guessSize(LayoutArea) - Method in class org.writersforge.catalan.layout.AbstractLayoutEngine: Estimates the size that the area "wants" to be.

H

HEAVY_WEIGHT - Static variable in class org.writersforge.catalan.layout.Relation: Very important Relation, only override if critical
HORIZONTAL - Static variable in class org.writersforge.catalan.layout.LayoutGroup: Group child areas in a horizontal direction
HORIZONTAL_MASK - Static variable in class org.writersforge.catalan.layout.Relation: Apply relation along horizontal axis
HtmlRenderer - class org.writersforge.catalan.renderers.HtmlRenderer.: Generates a collection of HTML files from one or more Page objects created by a RenderTemplate class.
HtmlRenderer() - Constructor for class org.writersforge.catalan.renderers.HtmlRenderer

I

IfOp - class org.writersforge.catalan.templates.generic.IfOp.: A template op wrapper for <if> and <if-not>.
IfOp(Datum, StyleMap) - Constructor for class org.writersforge.catalan.templates.generic.IfOp: Creates a new instance of IfOp.
IfOp(Datum, StyleMap, StyleChain) - Constructor for class org.writersforge.catalan.templates.generic.IfOp: Creates a new instance of IfOp with an optional StyleChain fallback.
ImageOp - class org.writersforge.catalan.templates.generic.ImageOp.: A template op wrapper for <image>.
ImageOp(Datum, StyleMap) - Constructor for class org.writersforge.catalan.templates.generic.ImageOp: Creates a new instance of ImageOp.
ImageOp(Datum, StyleMap, StyleChain) - Constructor for class org.writersforge.catalan.templates.generic.ImageOp: Creates a new instance of ImageOp with an optional StyleChain fallback.
INDENT_MASK - Static variable in class org.writersforge.catalan.layout.Relation: Horizontally indented to the left of the attractor (can be negative for indentation to the right)
initSpecs(Datum) - Method in class org.writersforge.catalan.transform.CustomNodeProcessor: Processes initialization data in the form of an XML tree.
InlineProcessor - class org.writersforge.catalan.transform.xform.InlineProcessor.: A Datum-only NodeProcessor for decreasing the level of nesting for the queried set of elements.
InlineProcessor(String) - Constructor for class org.writersforge.catalan.transform.xform.InlineProcessor: Creates a new instance of InlineProcessor.
InsertProcessor - class org.writersforge.catalan.transform.xform.InsertProcessor.: A Datum-only NodeProcessor for inserting static XML content into other parts of the same XML tree.
InsertProcessor(String, Datum) - Constructor for class org.writersforge.catalan.transform.xform.InsertProcessor: Creates a new instance of InsertProcessor for element creation.
InsertProcessor(String, String, String) - Constructor for class org.writersforge.catalan.transform.xform.InsertProcessor: Creates a new instance of InsertProcessor for attribute creation.
insertValue(int, StringBuffer, Object) - Method in class org.writersforge.catalan.transform.AsciiFieldManager: Converts the newValue object into ASCII content and inserts it into the asciiData buffer.
InsetStyle - interface org.writersforge.catalan.layout.style.InsetStyle.: The border of whitespace that shouldn't be drawn upon by this area.
isAtomic() - Method in class org.writersforge.catalan.layout.Constraint: Getter for property atomic, whether the area can be split or not.
isBreakable() - Method in class org.writersforge.catalan.layout.LayoutText: Getter for property breakable, whether the area can be split or not.
isBreakable() - Method in class org.writersforge.catalan.layout.LayoutArea: Getter for property breakable, whether the area can be split or not.
isBreakable() - Method in class org.writersforge.catalan.layout.style.StyleChain: Returns the atomic property of this text.
isBreakable() - Method in class org.writersforge.catalan.layout.style.DefaultStyle: Returns the breakable property of this text.
isBreakable() - Method in class org.writersforge.catalan.layout.style.DatumStyleWrapper: Returns the breakable property of this text.
isBreakable() - Method in interface org.writersforge.catalan.layout.style.AreaStyle: Returns the breakable property of this area.
isEqual() - Method in class org.writersforge.catalan.layout.Relation: Does the Relation allow distances exactly equal to the distance property?
isFinished() - Method in class org.writersforge.catalan.transform.DirectiveStack: Determines if the stack has reached the end of its run.
isGreaterThan() - Method in class org.writersforge.catalan.layout.Relation: Does the Relation allow distances greater than the distance property?
isHorizontal() - Method in class org.writersforge.catalan.templates.generic.GroupOp: Determines if this group op should be oriented horizontally.
isLeadingAttractorEdge() - Method in class org.writersforge.catalan.layout.Relation: Does the Relation refer to the leading edge of the attractor area?
isLeadingSatelliteEdge() - Method in class org.writersforge.catalan.layout.Relation: Does the Relation refer to the leading edge of the satellite area?
isLessThan() - Method in class org.writersforge.catalan.layout.Relation: Does the Relation allow distances less than the distance property?
isMove() - Method in class org.writersforge.catalan.transform.rule.CopyRule: Getter for property move, whether or not to keep the original selection.
isPropertyRule() - Method in class org.writersforge.catalan.transform.rule.QueryRule: Determines if this Rule affects Datum objects or Datum properties.
isRenderable() - Method in class org.writersforge.catalan.layout.LayoutText: Determines if this area has renderable content.
isRenderable() - Method in class org.writersforge.catalan.layout.LayoutPadding: Determines if this area has renderable content.
isRenderable() - Method in class org.writersforge.catalan.layout.LayoutGroup: Determines if this area has renderable content.
isRenderable() - Method in class org.writersforge.catalan.layout.LayoutArea: Determines if this area has renderable content.
isVertical() - Method in class org.writersforge.catalan.layout.Relation: Is the Relation oriented along the horizontal axis?
isVertical() - Method in class org.writersforge.catalan.templates.generic.GroupOp: Determines if this group op should be oriented vertically.

L

LayoutArea - class org.writersforge.catalan.layout.LayoutArea.: Lightweight component for expressing final renderable content.
LayoutArea(AreaStyle) - Constructor for class org.writersforge.catalan.layout.LayoutArea: Creates a new instance of LayoutArea.
layoutArea(LayoutArea, LayoutContext, List) - Method in class org.writersforge.catalan.layout.SimpleFlowLayout: Lay out an area; unlike layoutRegion(), it can be called recursively.
layoutAreas(List) - Method in interface org.writersforge.catalan.layout.LayoutEngine: Attempts to lay out all the areas in the supplied List.
layoutAreas(List) - Method in class org.writersforge.catalan.layout.AbstractLayoutEngine: Attempts to lay out all the areas in the supplied List.
LayoutContext - class org.writersforge.catalan.layout.LayoutContext.: Context for an ongoing iterative layout process.
LayoutContext(LayoutArea[]) - Constructor for class org.writersforge.catalan.layout.LayoutContext: Creates a new instance of LayoutContext
LayoutEngine - interface org.writersforge.catalan.layout.LayoutEngine.: Base interface for all layout engines.
LayoutFactory - class org.writersforge.catalan.layout.LayoutFactory.: Factory for creating LayoutEngine objects.
LayoutGroup - class org.writersforge.catalan.layout.LayoutGroup.: Grouping container for other LayoutArea objects.
LayoutGroup(AreaStyle) - Constructor for class org.writersforge.catalan.layout.LayoutGroup: Creates a new instance of LayoutGroup.
LayoutGroup(AreaStyle, int) - Constructor for class org.writersforge.catalan.layout.LayoutGroup: Creates a new instance of LayoutGroup with the given orientation.
LayoutPadding - class org.writersforge.catalan.layout.LayoutPadding.: A block of whitespace used to create flexible padding between other areas.
LayoutPadding(AreaStyle) - Constructor for class org.writersforge.catalan.layout.LayoutPadding: Creates a new instance of LayoutPadding with the given AreaStyle.
layoutPage(Page, LayoutArea[]) - Method in class org.writersforge.catalan.layout.AsciiLayout: Adds as many areas to the Page as will fit; returns the rest of them for the next Page.
layoutRegion(LayoutContext, Rectangle) - Method in class org.writersforge.catalan.layout.SimpleFlowLayout: Attempts to lay out as many of the pending areas in the context as it can, into the provided region's bounding box.
layoutRegion(LayoutContext, Rectangle) - Method in interface org.writersforge.catalan.layout.LayoutEngine: Deprecated.
layoutRegion(LayoutContext, Rectangle) - Method in class org.writersforge.catalan.layout.AsciiLayout: Attempts to lay out as many of the pending areas in the context as it can, into the provided region's bounding box.
LayoutShape - class org.writersforge.catalan.layout.LayoutShape.: Non-textual drawing element.
LayoutShape(AreaStyle) - Constructor for class org.writersforge.catalan.layout.LayoutShape: Creates a new instance of LayoutShape.
LayoutText - class org.writersforge.catalan.layout.LayoutText.: A portion of renderable text.
LayoutText(AreaStyle) - Constructor for class org.writersforge.catalan.layout.LayoutText: Creates a new instance of LayoutText.
LayoutText(AreaStyle, String) - Constructor for class org.writersforge.catalan.layout.LayoutText: Creates a new instance of LayoutText.
LayoutText(AreaStyle, StyledText) - Constructor for class org.writersforge.catalan.layout.LayoutText: Creates a new instance of LayoutText.
LEADING_ATTRACTOR_EDGE_MASK - Static variable in class org.writersforge.catalan.layout.Relation: Relate to leading edge in attractor
LEADING_SATELLITE_EDGE_MASK - Static variable in class org.writersforge.catalan.layout.Relation: Relate to leading edge in satellite
LESS_THAN_EQUAL_MASK - Static variable in class org.writersforge.catalan.layout.Relation: Require less than or equal to distance
LESS_THAN_MASK - Static variable in class org.writersforge.catalan.layout.Relation: Require less than distance
LIGHT_WEIGHT - Static variable in class org.writersforge.catalan.layout.Relation: Optional Relation, use as a fallback, if nothing else needs the position
listToDatumArray(List) - Static method in class org.writersforge.catalan.templates.RenderTemplate: Converts an ArrayList into an array of Datum objects.
listToLayoutAreaArray(List) - Static method in class org.writersforge.catalan.templates.RenderTemplate: Converts an ArrayList into an array of LayoutArea objects.
LiteralOp - class org.writersforge.catalan.templates.generic.LiteralOp.: A template op wrapper for <literal> and static text.
LiteralOp(Datum, StyleMap) - Constructor for class org.writersforge.catalan.templates.generic.LiteralOp: Creates a new instance of LiteralOp.
LiteralOp(Datum, StyleMap, StyleChain) - Constructor for class org.writersforge.catalan.templates.generic.LiteralOp: Creates a new instance of LiteralOp with an optional StyleChain fallback.
loadTemplate(ListDatum) - Method in class org.writersforge.catalan.templates.GenericTemplate: Loads the XML layout template.
loadTemplate(Reader) - Method in class org.writersforge.catalan.templates.GenericTemplate: Loads the XML layout template.
loadXmlStack(Datum[]) - Static method in class org.writersforge.catalan.transform.DirectiveStack: Factory method for creating a stack from an XML document.

M

main(String[]) - Static method in class org.writersforge.catalan.GenericGenerator: Invokes the rendering process using the generic XML processing tools.
main(String[]) - Static method in class org.writersforge.catalan.DTDGenerator
MANDATORY_WEIGHT - Static variable in class org.writersforge.catalan.layout.Relation: The highest valid Relation, cannot be ignored
Markup - class org.writersforge.catalan.layout.Markup.: Helper class to manage markup spans.
Markup() - Constructor for class org.writersforge.catalan.layout.Markup: Creates a new instance of Markup
Markup(FontStyle, int, int) - Constructor for class org.writersforge.catalan.layout.Markup: Creates a new instance of Markup with set values.
MEDIUM_WEIGHT - Static variable in class org.writersforge.catalan.layout.Relation: Moderately important Relation, should think twice before overriding
MINIMAL_WEIGHT - Static variable in class org.writersforge.catalan.layout.Relation: The lowest valid Relation weight, overridden by anything
MoveProcessor - class org.writersforge.catalan.transform.xform.MoveProcessor.: A Datum-only NodeProcessor for moving existing XML content to other parts of the same XML tree.
MoveProcessor(String, String, String) - Constructor for class org.writersforge.catalan.transform.xform.MoveProcessor: Creates a new instance of MoveProcessor.

N

newCopyDatumRule(String, String) - Static method in class org.writersforge.catalan.transform.rule.CopyRule: Creates a new instance of CopyRule for copying Datum objects.
newCopyPropertyRule(String, String, String) - Static method in class org.writersforge.catalan.transform.rule.CopyRule: Creates a new instance of CopyRule for copying Datum properties.
newCreateDatumRule(String, Datum) - Static method in class org.writersforge.catalan.transform.rule.CreateRule: Creates a new instance of CreateRule for creating new Datum objects.
newCreatePropertyRule(String, String, Object) - Static method in class org.writersforge.catalan.transform.rule.CreateRule: Creates a new instance of CreateRule for creating new Datum properties.
newDeleteDatumRule(String) - Static method in class org.writersforge.catalan.transform.rule.CopyRule: Creates a new instance of CopyRule for deleting Datum objects.
newDeletePropertyRule(String, String) - Static method in class org.writersforge.catalan.transform.rule.CopyRule: Creates a new instance of CopyRule for deleting Datum properties.
newLayoutEngine(String) - Static method in class org.writersforge.catalan.layout.LayoutFactory: Creates a new layout engine, based on the input parameters.
newMoveDatumRule(String, String) - Static method in class org.writersforge.catalan.transform.rule.CopyRule: Creates a new instance of CopyRule for moving Datum objects.
newMovePropertyRule(String, String, String) - Static method in class org.writersforge.catalan.transform.rule.CopyRule: Creates a new instance of CopyRule for moving Datum properties.
newRenameDatumRule(String, String) - Static method in class org.writersforge.catalan.transform.rule.RenameRule: Creates a new instance of RenameRule for changing type names in Datum objects.
newRenamePropertyRule(String, String, String) - Static method in class org.writersforge.catalan.transform.rule.RenameRule: Creates a new instance of RenameRule for changing the name of Datum properties.
nextArea() - Method in class org.writersforge.catalan.layout.LayoutContext: Pulls the next area off the stack.
normalize(StringBuffer) - Method in class org.writersforge.catalan.transform.AsciiFieldManager: Fills in current padding without touching any existing data fields.
Normalizer - class org.writersforge.catalan.transform.Normalizer.: A text processor which cleans up the input text content according to its set of configurable rules.
Normalizer() - Constructor for class org.writersforge.catalan.transform.Normalizer: Creates a new instance of Normalizer.
NOT_EQUAL_MASK - Static variable in class org.writersforge.catalan.layout.Relation: Require not equal to distance
NOT_FOUND - Static variable in class org.writersforge.catalan.layout.style.DefaultStyle: Default value for an undefined integer property
NOT_FOUND - Static variable in class org.writersforge.catalan.layout.style.DatumStyleWrapper: The standard tag for 'style value not found'

O

ObjectToDatum - class org.writersforge.catalan.transform.ObjectToDatum.: A data processor which converts a List of java objects into Datum content.
ObjectToDatum(DirectiveStack) - Constructor for class org.writersforge.catalan.transform.ObjectToDatum: Creates a new instance of ObjectToDatum.
org.writersforge.catalan - package org.writersforge.catalan: Catalan Document Creation Framework.
org.writersforge.catalan.layout - package org.writersforge.catalan.layout: Catalan Layout API.
org.writersforge.catalan.layout.style - package org.writersforge.catalan.layout.style: Catalan Style API.
org.writersforge.catalan.renderers - package org.writersforge.catalan.renderers: Catalan Renderer Engines.
org.writersforge.catalan.templates - package org.writersforge.catalan.templates: Catalan Template API.
org.writersforge.catalan.templates.generic - package org.writersforge.catalan.templates.generic: Catalan Generic Template Helper Classes.
org.writersforge.catalan.transform - package org.writersforge.catalan.transform: Catalan Data Transformation Package.
org.writersforge.catalan.transform.rule - package org.writersforge.catalan.transform.rule: Catalan XML Transformation Package.
org.writersforge.catalan.transform.xform - package org.writersforge.catalan.transform.xform: Catalan XML-to-XML Data Transformation Package.

P

PaddingOp - class org.writersforge.catalan.templates.generic.PaddingOp.
PaddingOp(Datum, StyleMap) - Constructor for class org.writersforge.catalan.templates.generic.PaddingOp: Creates a new instance of PaddingOp.
PaddingOp(Datum, StyleMap, StyleChain) - Constructor for class org.writersforge.catalan.templates.generic.PaddingOp: Creates a new instance of PaddingOp with an optional StyleChain fallback.
Page - class org.writersforge.catalan.layout.Page.: A single page of final output.
Page(Book, int, int) - Constructor for class org.writersforge.catalan.layout.Page: Creates a new instance of Page.
parseArgs(String[]) - Method in class org.writersforge.catalan.GenericGenerator: Parses and processes the command-line arguments.
PdfRenderer - class org.writersforge.catalan.renderers.PdfRenderer.: Generates a PDF file from one or more Page objects created by a RenderTemplate class.
PdfRenderer() - Constructor for class org.writersforge.catalan.renderers.PdfRenderer: Creates a new instance of PdfRenderer
postProcessTargets(Datum[]) - Method in class org.writersforge.catalan.transform.rule.QueryRule: Performs any cleanup or deletion on the source Datum objects after all normal processing is finished.
postProcessTargets(Datum[]) - Method in class org.writersforge.catalan.transform.rule.CopyRule: Performs any cleanup or deletion on the source Datum objects after all normal processing is finished.
process(Book) - Method in class org.writersforge.catalan.templates.RenderTemplate: Processes all content in the Book's ListDatum container according to the rules in this template, and divides the results into separate Pages.
process(Datum) - Method in class org.writersforge.catalan.transform.rule.RuleCollection: Applies changes to the supplied Datum content by running all the child Rule objects it contains.
process(Datum) - Method in interface org.writersforge.catalan.transform.rule.Rule: Applies changes to the supplied content.
process(Datum) - Method in class org.writersforge.catalan.transform.rule.Recipe: Sends the content through the XML recipe.
process(Datum) - Method in class org.writersforge.catalan.transform.rule.QueryRule: Applies changes to the supplied content.
process(String[], List) - Method in class org.writersforge.catalan.transform.Transformer: Runs the List of input nodes through a set of processors, by id.
processAll(List) - Method in class org.writersforge.catalan.transform.Transformer: Runs the List of input nodes through every processor in the Transformer's XML specification, in order.
processDatum(Datum, Datum) - Method in class org.writersforge.catalan.transform.rule.RenameRule: Applies changes to Datum objects in the supplied content.
processDatum(Datum, Datum) - Method in class org.writersforge.catalan.transform.rule.QueryRule: Applies changes to Datum objects in the supplied content.
processDatum(Datum, Datum) - Method in class org.writersforge.catalan.transform.rule.CreateRule: Applies changes to Datum objects in the supplied content.
processDatum(Datum, Datum) - Method in class org.writersforge.catalan.transform.rule.CopyRule: Applies changes to Datum objects in the supplied content.
processNode(Object) - Method in class org.writersforge.catalan.transform.GroupProcessor: Process a single node.
processNode(Object) - Method in class org.writersforge.catalan.transform.XmlToBean: Process a single node.
processNode(Object) - Method in class org.writersforge.catalan.transform.BeanToXml: Process a single node.
processNode(Object) - Method in class org.writersforge.catalan.transform.Concatenator: Process a single node.
processNode(Object) - Method in class org.writersforge.catalan.transform.AsciiConverter: Process a single node.
processNode(Object) - Method in class org.writersforge.catalan.transform.TextProcessor: Process a single node.
processNode(Object) - Method in class org.writersforge.catalan.transform.ObjectToDatum: Process a single node.
processNode(Object) - Method in class org.writersforge.catalan.transform.DatumToObject: Process a single node.
processNode(Object) - Method in class org.writersforge.catalan.transform.xform.XFormProcessor: Process a single node.
ProcessorFactory - class org.writersforge.catalan.transform.ProcessorFactory.: Factory for converting XML transform instructions into NodeProcessor classes.
processProperty(Datum, Datum) - Method in class org.writersforge.catalan.transform.rule.RenameRule: Applies changes to Datum properties in the supplied content.
processProperty(Datum, Datum) - Method in class org.writersforge.catalan.transform.rule.QueryRule: Applies changes to Datum properties in the supplied content.
processProperty(Datum, Datum) - Method in class org.writersforge.catalan.transform.rule.CreateRule: Applies changes to Datum properties in the supplied content.
processProperty(Datum, Datum) - Method in class org.writersforge.catalan.transform.rule.CopyRule: Applies changes to Datum properties in the supplied content.
processText(String) - Method in class org.writersforge.catalan.transform.VariableTextReplacer: Processes the text node.
processText(String) - Method in class org.writersforge.catalan.transform.TokenSplitter: Processes the text node.
processText(String) - Method in class org.writersforge.catalan.transform.TextReplacer: Processes the text node.
processText(String) - Method in class org.writersforge.catalan.transform.TextProcessor: Processes the text node.
processText(String) - Method in class org.writersforge.catalan.transform.Normalizer: Processes the text node.

Q

QueryRule - class org.writersforge.catalan.transform.rule.QueryRule.: Starting point for all Rule implementations which rely on a Bellows query to select which Datum objects to operate on.
QueryRule(String, String) - Constructor for class org.writersforge.catalan.transform.rule.QueryRule: Creates a new instance of QueryRule for Datum or Datum property operations.

R

Recipe - class org.writersforge.catalan.transform.rule.Recipe.: Convenience class for loading Bellows XML recipes as a composite Rule instance.
Recipe(Datum) - Constructor for class org.writersforge.catalan.transform.rule.Recipe: Creates a new instance of an XML transformation Recipe.
RegionMap - interface org.writersforge.catalan.templates.RegionMap.: Base interface for defining flow regions in a Section.
rejectArea(LayoutArea) - Method in class org.writersforge.catalan.layout.LayoutContext: Puts the area into the reject pile, to be deferred to the next page.
Relation - class org.writersforge.catalan.layout.Relation.: A constraints-based relationship between two LayoutArea objects.
Relation.Above - class org.writersforge.catalan.layout.Relation.Above.: Convenience class to constrain an area that must remain vertically above the previous area in the layout.
Relation.Above(LayoutArea, int, int) - Constructor for class org.writersforge.catalan.layout.Relation.Above: Creates a new instance of Above, essentially a convenience wrapper around the base Relation class with simpler parameters and distinct type (for easier checking with instanceof).
Relation.Above(LayoutArea, int, int, int) - Constructor for class org.writersforge.catalan.layout.Relation.Above: Creates a new instance of Above, essentially a convenience wrapper around the base Relation class with simpler parameters and distinct type (for easier checking with instanceof).
Relation.Below - class org.writersforge.catalan.layout.Relation.Below.: Convenience class to constrain an area that must remain vertically below the previous area in the layout.
Relation.Below(LayoutArea, int, int) - Constructor for class org.writersforge.catalan.layout.Relation.Below: Creates a new instance of Below, essentially a convenience wrapper around the base Relation class with simpler parameters and distinct type (for easier checking with instanceof).
Relation.Below(LayoutArea, int, int, int) - Constructor for class org.writersforge.catalan.layout.Relation.Below: Creates a new instance of Below, essentially a convenience wrapper around the base Relation class with simpler parameters and distinct type (for easier checking with instanceof).
Relation.Indent - class org.writersforge.catalan.layout.Relation.Indent.: Convenience class to constrain an area that must remain indented to the right of the previous area in the layout (leftward indentation can be achieved with a negative distance).
Relation.Indent(LayoutArea, int, int) - Constructor for class org.writersforge.catalan.layout.Relation.Indent: Creates a new instance of Above, essentially a convenience wrapper around the base Relation class with simpler parameters and distinct type (for easier checking with instanceof).
Relation(LayoutArea, int, int) - Constructor for class org.writersforge.catalan.layout.Relation: Creates a new instance of Relation.
Relation(LayoutArea, int, int, int) - Constructor for class org.writersforge.catalan.layout.Relation: Creates a new instance of Relation
removeProperty(String) - Method in class org.writersforge.catalan.layout.Book: Delete all traces of the named property
RenameProcessor - class org.writersforge.catalan.transform.xform.RenameProcessor.: A Datum-only NodeProcessor for renaming XML content.
RenameProcessor(String, String, String) - Constructor for class org.writersforge.catalan.transform.xform.RenameProcessor: Creates a new instance of RenameProcessor.
RenameRule - class org.writersforge.catalan.transform.rule.RenameRule.: A query-based Rule for changing the Datum type (i.e., the XML element name) or the name of a certain Datum property (i.e., the XML attribute).
render(Book) - Method in class org.writersforge.catalan.renderers.Renderer: Renders an entire Book, pulling all data from the Book's Page array.
renderArea(LayoutArea) - Method in class org.writersforge.catalan.renderers.TextRenderer: Renders a single LayoutArea within the current Page.
renderArea(LayoutArea) - Method in class org.writersforge.catalan.renderers.Renderer: Renders a single LayoutArea object within the current Page.
renderDTD(Reader, Writer) - Method in class org.writersforge.catalan.DTDGenerator: Converts the FormXML content from the reader into PDF format and sends it to the pdfStream.
Renderer - class org.writersforge.catalan.renderers.Renderer.: Abstract base class for rendering Page objects into a final output format.
Renderer() - Constructor for class org.writersforge.catalan.renderers.Renderer
renderPage(Book, int) - Method in class org.writersforge.catalan.renderers.Renderer: Renders a single page of a book.
renderSection(Section, Book) - Method in class org.writersforge.catalan.templates.RenderTemplate: Converts a section of the document into Page objects, using the data in the Book as an input source.
renderShapeArea(LayoutShape) - Method in class org.writersforge.catalan.renderers.TextRenderer: Renders a single LayoutShape within the current Page.
renderShapeArea(LayoutShape) - Method in class org.writersforge.catalan.renderers.Renderer: Renders a single LayoutShape area within the current Page.
renderShapeArea(LayoutShape) - Method in class org.writersforge.catalan.renderers.PdfRenderer: Renders a single LayoutShape within the current Page.
RenderTemplate - class org.writersforge.catalan.templates.RenderTemplate.: Base class for all rendering templates.
RenderTemplate() - Constructor for class org.writersforge.catalan.templates.RenderTemplate: Creates a new instance of RenderTemplate using the default LayoutEngine.
RenderTemplate(LayoutEngine) - Constructor for class org.writersforge.catalan.templates.RenderTemplate: Creates a new instance of RenderTemplate using the given LayoutEngine.
RenderTemplate(String) - Constructor for class org.writersforge.catalan.templates.RenderTemplate: Creates a new instance of RenderTemplate using the requested LayoutEngine.
renderTextArea(LayoutText) - Method in class org.writersforge.catalan.renderers.TextRenderer: Renders a single LayoutText within the current Page.
renderTextArea(LayoutText) - Method in class org.writersforge.catalan.renderers.Renderer: Renders a single LayoutText area within the current Page.
renderTextArea(LayoutText) - Method in class org.writersforge.catalan.renderers.PdfRenderer: Renders a single LayoutText within the current Page.
reset() - Method in class org.writersforge.catalan.transform.DirectiveStack: Initializes the stack to its initial state.
resolve(Datum) - Method in class org.writersforge.catalan.templates.generic.TextOp: Runs a Datum XML node through the op and returns a List of LayoutArea objects.
resolve(Datum) - Method in class org.writersforge.catalan.templates.generic.TableOp: Runs a Datum XML node through the op and returns a List of LayoutArea objects.
resolve(Datum) - Method in class org.writersforge.catalan.templates.generic.PaddingOp: Runs a Datum XML node through the op and returns a List of LayoutArea objects.
resolve(Datum) - Method in class org.writersforge.catalan.templates.generic.LiteralOp: Runs a Datum XML node through the op and returns a List of LayoutArea objects.
resolve(Datum) - Method in class org.writersforge.catalan.templates.generic.ImageOp: Runs a Datum XML node through the op and returns a List of LayoutArea objects.
resolve(Datum) - Method in class org.writersforge.catalan.templates.generic.IfOp: Runs a Datum XML node through the op and returns a List of LayoutArea objects.
resolve(Datum) - Method in class org.writersforge.catalan.templates.generic.GroupOp: Runs a Datum XML node through the op and returns a List of LayoutArea objects.
resolve(Datum) - Method in class org.writersforge.catalan.templates.generic.GenericOp: Runs a Datum XML node through the op and returns a List of LayoutArea objects.
resolve(Datum) - Method in class org.writersforge.catalan.templates.generic.ForEachOp: Runs a Datum XML node through the op and returns a List of LayoutArea objects.
resolveParameter(char, Datum) - Method in class org.writersforge.catalan.templates.generic.GenericOp: Attempts to resolve a parameter against a Datum.
resolvePath(String, Datum) - Method in class org.writersforge.catalan.templates.generic.GenericOp: Attempts to resolve a parameterized query path.
Rule - interface org.writersforge.catalan.transform.rule.Rule.: A processing rule for defining complex operations on Datum content.
RuleCollection - class org.writersforge.catalan.transform.rule.RuleCollection.: A composite Rule that manages a collection of other Rule objects.
RuleCollection() - Constructor for class org.writersforge.catalan.transform.rule.RuleCollection
run() - Method in class org.writersforge.catalan.GenericGenerator: Fires off the document generator, given the current input and output file settings and output format.
runQuery(String, Datum) - Method in class org.writersforge.catalan.templates.generic.GenericOp: Performs a query on the supplied Datum tree, resolving parameterized variables and managing absolute and relative paths.

S

Section - class org.writersforge.catalan.templates.Section.: A single section of a larger document.
Section(RegionMap, Datum[], Datum[]) - Constructor for class org.writersforge.catalan.templates.Section: Creates a new instance of Section.
setAreas(int, LayoutArea) - Method in class org.writersforge.catalan.layout.Page: Indexed setter for property areas, the layout areas associated with this Page.
setAreas(LayoutArea[]) - Method in class org.writersforge.catalan.layout.Page: Setter for property areas, the layout areas associated with this Page.
setAtomic(boolean) - Method in class org.writersforge.catalan.layout.Constraint: Setter for property atomic, whether the area can be split or not.
setChildren(int, LayoutArea) - Method in class org.writersforge.catalan.layout.LayoutGroup: Indexed setter for property children, the child layout areas.
setChildren(int, LayoutArea) - Method in class org.writersforge.catalan.layout.LayoutArea: Indexed setter for property children, the child layout areas.
setChildren(LayoutArea[]) - Method in class org.writersforge.catalan.layout.LayoutGroup: Setter for property children, the child layout areas.
setChildren(LayoutArea[]) - Method in class org.writersforge.catalan.layout.LayoutArea: Setter for property children, the child layout areas.
setCurrentPage(int) - Method in class org.writersforge.catalan.templates.RenderTemplate: Sets the current page index
setCurrentPageNumber(int) - Method in class org.writersforge.catalan.layout.Book: Sets the current page number in this Book.
setCurrentRegion(Rectangle) - Method in class org.writersforge.catalan.layout.LayoutContext: Caches the current rendering region in the LayoutContext.
setCurrentRegion(Shape) - Method in interface org.writersforge.catalan.layout.LayoutEngine: Assigns a clipping region for the current rendering context.
setCurrentRegion(Shape) - Method in class org.writersforge.catalan.layout.AbstractLayoutEngine: Assigns a clipping region for the current rendering context.
setDefaultSize(Dimension) - Static method in class org.writersforge.catalan.layout.Constraint: Sets the default size for the preferred property.
setDistance(int) - Method in class org.writersforge.catalan.layout.Relation: Setter for property distance, a scalar measure to use with comparisons.
setEnd(int) - Method in class org.writersforge.catalan.layout.Markup: Setter for property end, the index of the last text character in the style span.
setEndToken(String) - Method in class org.writersforge.catalan.transform.VariableTextReplacer: Assigns the token used to end a variable.
setExtents(Rectangle) - Method in class org.writersforge.catalan.layout.LayoutArea: Setter for property extents, the actual extents for this area.
setFormat(String) - Method in class org.writersforge.catalan.GenericGenerator: Sets the rendering format: "PDF", "TEXT", or "HTML".
setHeight(int) - Method in class org.writersforge.catalan.layout.LayoutArea: Setter for property height, the final calculated height to render this area.
setHint(String) - Method in class org.writersforge.catalan.layout.LayoutArea: Setter for property hint, an optional field for descriptive info.
setIncludeDelimiters(boolean) - Method in class org.writersforge.catalan.transform.TokenSplitter: Sets the policy for including delimiters in the output.
setInputFiles(String[]) - Method in class org.writersforge.catalan.GenericGenerator: Sets the array of input file paths.
setInsets(Insets) - Method in class org.writersforge.catalan.layout.Page: Setter for property insets, the unwritable margins for this Page.
setLayout(LayoutEngine) - Method in class org.writersforge.catalan.templates.RenderTemplate: Assigns a LayoutEngine to this template.
setNormalizeTokens(String[]) - Method in class org.writersforge.catalan.transform.Normalizer: Assigns a new set of tokens to normalize.
setOuterRegion(Rectangle) - Method in class org.writersforge.catalan.layout.LayoutContext: Caches the top-level layout region in the LayoutContext.
setOutputFile(String) - Method in class org.writersforge.catalan.GenericGenerator: Sets the output file path.
setOutputStream(OutputStream) - Method in class org.writersforge.catalan.renderers.PdfRenderer: Sets a new OutputStream to render the next PDF file to.
setPadding(String) - Method in class org.writersforge.catalan.transform.AsciiConverter: Assigns a custom padding string to use as a cycling overlay to all padded ('x') spans.
setPadding(String) - Method in class org.writersforge.catalan.transform.AsciiFieldManager: Assigns a new custom padding specification.
setProperty(String, Object) - Method in class org.writersforge.catalan.layout.Book: Assigns a value to a generic property.
setRelations(int, Relation) - Method in class org.writersforge.catalan.layout.Constraint: Indexed setter for property relations.
setRelations(Relation[]) - Method in class org.writersforge.catalan.layout.Constraint: Setter for property relations.
setRenderer(Renderer) - Method in class org.writersforge.catalan.GenericGenerator: Assigns the Renderer to use for creating the final output.
setReplaceCount(int) - Method in class org.writersforge.catalan.transform.TextReplacer: Assigns the maximum number of times per node that the processor will replace text.
setResolver(String) - Method in class org.writersforge.catalan.transform.Normalizer: Assigns the text that the processor substitutes for normalized text.
setStart(int) - Method in class org.writersforge.catalan.layout.Markup: Setter for property start, the index of the first text character in the style span.
setStartToken(String) - Method in class org.writersforge.catalan.transform.VariableTextReplacer: Assigns the token used to start a variable.
setStyle(FontStyle) - Method in class org.writersforge.catalan.layout.Markup: Setter for property style, the font for this markup section.
setStyledText(StyledText) - Method in class org.writersforge.catalan.layout.LayoutText: Setter for property styledText, the multi-style text content of this area.
setSwallowUndefined(boolean) - Method in class org.writersforge.catalan.transform.VariableTextReplacer: Determines the behavior for processing variables that aren't defined in lookup map.
setTemplateFile(String) - Method in class org.writersforge.catalan.GenericGenerator: Sets the file path for the template file.
setText(String) - Method in class org.writersforge.catalan.layout.LayoutText: Setter for property text, the raw text content of this area.
setWidth(int) - Method in class org.writersforge.catalan.layout.LayoutArea: Setter for property width, the final calculated width to render this area.
setWriter(Writer) - Method in class org.writersforge.catalan.renderers.TextRenderer: Sets the output for the DTD content.
setX(int) - Method in class org.writersforge.catalan.layout.LayoutArea: Setter for property x, the final calculated x-axis origin to render this area.
setY(int) - Method in class org.writersforge.catalan.layout.LayoutArea: Setter for property y, the final calculated y-axis origin to render this area.
SIMPLE_FLOW_ENGINE - Static variable in class org.writersforge.catalan.layout.LayoutFactory: The factory name for the SimpleFlowLayout engine.
SimpleFlowLayout - class org.writersforge.catalan.layout.SimpleFlowLayout.: Very simple layout engine which flows all LayoutArea objects down and to the right.
SimpleFlowLayout() - Constructor for class org.writersforge.catalan.layout.SimpleFlowLayout
sortAreas(LayoutArea[]) - Method in class org.writersforge.catalan.templates.RenderTemplate: Rearranges the LayoutArea objects in a more linear order, gathering keep-with areas together and shuffling to make the layout more efficient.
start(List) - Method in class org.writersforge.catalan.transform.Concatenator: Starts a new traversal.
start(List) - Method in class org.writersforge.catalan.transform.AsciiConverter: Starts a new traversal.
start(List) - Method in class org.writersforge.catalan.transform.ObjectToDatum: Starts a new traversal.
start(List) - Method in class org.writersforge.catalan.transform.BaseNodeProcessor: Starts a new traversal.
startBook(Book) - Method in class org.writersforge.catalan.renderers.Renderer: Performs any special initialization that the Renderer must do at the very beginning of the rendering process.
startBook(Book) - Method in class org.writersforge.catalan.renderers.PdfRenderer: Performs any special initialization that the Renderer must do at the very beginning of the rendering process.
startPage(Page) - Method in class org.writersforge.catalan.renderers.Renderer: Performs any special initialization that the Renderer must do before every Page.
startPage(Page) - Method in class org.writersforge.catalan.renderers.PdfRenderer: Performs any special initialization that the Renderer must do before every Page.
stringWidth(String) - Method in class org.writersforge.catalan.layout.style.FontStyleMetrics: Estimates the width of the given string if rendered in this style.
STYLE_ENUM - Static variable in interface org.writersforge.catalan.layout.style.FontStyle: Enumeration of font styles; uses constants from Style
StyleChain - class org.writersforge.catalan.layout.style.StyleChain.: Style aggregator.
StyleChain() - Constructor for class org.writersforge.catalan.layout.style.StyleChain: Creates a new empty instance of StyleChain.
StyleChain(StyleChain) - Constructor for class org.writersforge.catalan.layout.style.StyleChain: Creates a new instance of StyleChain using the copy as a template.
StyledText - class org.writersforge.catalan.layout.StyledText.: A lightweight container for styled text.
StyledText.Span - class org.writersforge.catalan.layout.StyledText.Span.: A single homogeneous span of markup style.
StyledText.Span(int, int, Markup[]) - Constructor for class org.writersforge.catalan.layout.StyledText.Span: Creates a new instance of Span.
StyledText() - Constructor for class org.writersforge.catalan.layout.StyledText: Creates a new default instance of StyledText.
StyledText(String) - Constructor for class org.writersforge.catalan.layout.StyledText: Creates a new instance of StyledText with the given unstyled text.
StyledText(String, TextStyle) - Constructor for class org.writersforge.catalan.layout.StyledText: Creates a new instance of StyledText with the given text and style.
StyledText(TextStyle) - Constructor for class org.writersforge.catalan.layout.StyledText: Creates a new instance of StyledText with the given style.
StyleMap - interface org.writersforge.catalan.layout.style.StyleMap.: Central access point for all layout styles.
StyleProcessor - class org.writersforge.catalan.transform.xform.StyleProcessor.: A Datum-only NodeProcessor for changing the formatting style of XML element names and attributes.
StyleProcessor(String, PropertyName.PropertyStyle, Boolean) - Constructor for class org.writersforge.catalan.transform.xform.StyleProcessor: Creates a new instance of StyleProcessor.

T

TableOp - class org.writersforge.catalan.templates.generic.TableOp.: A template op wrapper for <table>.
TableOp(Datum, StyleMap) - Constructor for class org.writersforge.catalan.templates.generic.TableOp: Creates a new instance of TableOp.
TableOp(Datum, StyleMap, StyleChain) - Constructor for class org.writersforge.catalan.templates.generic.TableOp: Creates a new instance of TableOp with an optional StyleChain fallback.
TextOp - class org.writersforge.catalan.templates.generic.TextOp.: A template op describing a run of renderable text.
TextOp(Datum, StyleMap) - Constructor for class org.writersforge.catalan.templates.generic.TextOp: Creates a new instance of TextOp.
TextOp(Datum, StyleMap, StyleChain) - Constructor for class org.writersforge.catalan.templates.generic.TextOp: Creates a new instance of TextOp with an optional StyleChain fallback.
TextProcessor - class org.writersforge.catalan.transform.TextProcessor.: The shared base class for all Catalan ASCII text processors.
TextProcessor() - Constructor for class org.writersforge.catalan.transform.TextProcessor: Creates a new instance of TextProcessor.
TextRenderer - class org.writersforge.catalan.renderers.TextRenderer.: Generates a collection of ASCII text files from one or more Page objects created by a RenderTemplate class.
TextRenderer() - Constructor for class org.writersforge.catalan.renderers.TextRenderer
TextReplacer - class org.writersforge.catalan.transform.TextReplacer.: A text processor which performs a simple search and replace action.
TextReplacer(String, String) - Constructor for class org.writersforge.catalan.transform.TextReplacer: Creates a new instance of TextReplacer.
TextStyle - interface org.writersforge.catalan.layout.style.TextStyle.: The size and alignment info for a block of text.
ToAttributeProcessor - class org.writersforge.catalan.transform.xform.ToAttributeProcessor.: A Datum-only NodeProcessor for converting element content into attribute content.
ToAttributeProcessor(String, String) - Constructor for class org.writersforge.catalan.transform.xform.ToAttributeProcessor: Creates a new instance of ToAttributeProcessor.
ToElementProcessor - class org.writersforge.catalan.transform.xform.ToElementProcessor.: A Datum-only NodeProcessor for converting attributes into element content.
ToElementProcessor(String, String) - Constructor for class org.writersforge.catalan.transform.xform.ToElementProcessor: Creates a new instance of ToElementProcessor.
TokenSplitter - class org.writersforge.catalan.transform.TokenSplitter.: A text processor which breaks apart its String contents into smaller parts, based on its own parameters.
TokenSplitter(String[]) - Constructor for class org.writersforge.catalan.transform.TokenSplitter: Creates a new instance of TokenSplitter.
toString() - Method in class org.writersforge.catalan.layout.Relation: Returns this object as a String
toString() - Method in class org.writersforge.catalan.layout.Markup: Creates a String version of this object
toString() - Method in class org.writersforge.catalan.layout.LayoutText: Converts the area object into String form.
toString() - Method in class org.writersforge.catalan.layout.LayoutPadding: Converts the area object into String form.
toString() - Method in class org.writersforge.catalan.layout.LayoutGroup: Converts the area object into String form.
toString() - Method in class org.writersforge.catalan.layout.LayoutArea: Converts the area object into String form.
toString() - Method in class org.writersforge.catalan.layout.Constraint: Creates a String representation of this Constraint
toString() - Method in class org.writersforge.catalan.layout.style.FontStyleMetrics: Returns this object as a String
toString() - Method in class org.writersforge.catalan.transform.AsciiConverter: Convert this object to a String value.
toString() - Method in class org.writersforge.catalan.transform.VariableTextReplacer: Convert this object to a String value.
toString() - Method in class org.writersforge.catalan.transform.TokenSplitter: Convert this object to a String value.
toString() - Method in class org.writersforge.catalan.transform.TextReplacer: Convert this object to a String value.
toString() - Method in class org.writersforge.catalan.transform.ObjectToDatum: Convert this object to a String value.
toString() - Method in class org.writersforge.catalan.transform.Normalizer: Convert this object to a String value.
TRAILING_ATTRACTOR_EDGE_MASK - Static variable in class org.writersforge.catalan.layout.Relation: Relate to trailing edge in attractor
TRAILING_SATELLITE_EDGE_MASK - Static variable in class org.writersforge.catalan.layout.Relation: Relate to trailing edge in satellite
Transformer - class org.writersforge.catalan.transform.Transformer.: A XML driven data transformer for converting data from one format to another.
Transformer(Datum) - Constructor for class org.writersforge.catalan.transform.Transformer: Creates a new instance of Transformer, loading a collection of NodeProcessor implementations based on the specification in the supplied Datum tree.
transformNode(Datum, Datum) - Method in class org.writersforge.catalan.transform.xform.RenameProcessor: Performs an in-place transformation on the supplied Datum tree.
transformNode(Datum, Datum) - Method in class org.writersforge.catalan.transform.xform.ToAttributeProcessor: Performs an in-place transformation on the supplied Datum tree.
transformNode(Datum, Datum) - Method in class org.writersforge.catalan.transform.xform.ToElementProcessor: Performs an in-place transformation on the supplied Datum tree.
transformNode(Datum, Datum) - Method in class org.writersforge.catalan.transform.xform.StyleProcessor: Performs an in-place transformation on the supplied Datum tree.
transformNode(Datum, Datum) - Method in class org.writersforge.catalan.transform.xform.InsertProcessor: Performs an in-place transformation on the supplied Datum tree.
transformNode(Datum, Datum) - Method in class org.writersforge.catalan.transform.xform.DeleteProcessor: Performs an in-place transformation on the supplied Datum tree.
transformNode(Datum, Datum) - Method in class org.writersforge.catalan.transform.xform.MoveProcessor: Performs an in-place transformation on the supplied Datum tree.
transformNode(Datum, Datum) - Method in class org.writersforge.catalan.transform.xform.CopyProcessor: Performs an in-place transformation on the supplied Datum tree.
transformNode(Datum, Datum) - Method in class org.writersforge.catalan.transform.xform.WrapProcessor: Performs an in-place transformation on the supplied Datum tree.
transformNode(Datum, Datum) - Method in class org.writersforge.catalan.transform.xform.InlineProcessor: Performs an in-place transformation on the supplied Datum tree.
transformNode(Datum, Datum) - Method in class org.writersforge.catalan.transform.xform.XFormProcessor: Performs an in-place transformation on the supplied Datum tree.

V

VariableTextReplacer - class org.writersforge.catalan.transform.VariableTextReplacer.: A text processor which performs dynamic text replacement by looking up specially formatted variables and resolving them against a Map of variable names to text values.
VariableTextReplacer(Map) - Constructor for class org.writersforge.catalan.transform.VariableTextReplacer: Creates a new instance of VariableTextReplacer.
VERTICAL - Static variable in class org.writersforge.catalan.layout.LayoutGroup: Group child areas in a vertical direction
VERTICAL_MASK - Static variable in class org.writersforge.catalan.layout.Relation: Apply relation along vertical axis

W

WRAP_CHARACTER - Static variable in interface org.writersforge.catalan.layout.style.TextStyle: Text should be wrapped at the character boundary
WRAP_ENUM - Static variable in interface org.writersforge.catalan.layout.style.TextStyle: Enumeration of text wrapping
WRAP_NEVER - Static variable in interface org.writersforge.catalan.layout.style.TextStyle: Text should not be wrapped at all
WRAP_PHRASE - Static variable in interface org.writersforge.catalan.layout.style.TextStyle: Text should be wrapped at the phrase boundary
WRAP_SENTENCE - Static variable in interface org.writersforge.catalan.layout.style.TextStyle: Text should be wrapped at the sentence boundary
WRAP_WORD - Static variable in interface org.writersforge.catalan.layout.style.TextStyle: Text should be wrapped at the word boundary
WrapProcessor - class org.writersforge.catalan.transform.xform.WrapProcessor.: A Datum-only NodeProcessor for increasing the level of nesting for the queried set of elements.
WrapProcessor(String, String) - Constructor for class org.writersforge.catalan.transform.xform.WrapProcessor: Creates a new instance of WrapProcessor.
wrapText(int) - Method in class org.writersforge.catalan.layout.StyledText: Performs line-wrapping on the text contents.
wrapText(int, int, int) - Method in class org.writersforge.catalan.layout.StyledText: Performs line-wrapping on the text contents.

X

XFormProcessor - class org.writersforge.catalan.transform.xform.XFormProcessor.: Common base class for all XForm operations.
XFormProcessor(String) - Constructor for class org.writersforge.catalan.transform.xform.XFormProcessor: Creates a new instance of XFormProcessor.
XmlToBean - class org.writersforge.catalan.transform.XmlToBean.: A processor which converts each Datum input node into a JavaBean.
XmlToBean() - Constructor for class org.writersforge.catalan.transform.XmlToBean: Creates a new instance of BeanToXml.

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

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV NEXT

FRAMES NO FRAMES