Package | Description |
---|---|
org.apache.fop.apps |
Application classes used for running FOP embedded in other applications.
|
org.apache.fop.area |
FOP's area tree.
|
org.apache.fop.cli |
This package contains the command-line client for Apache FOP.
|
org.apache.fop.fo |
Classes, constants and basic infrastructure for the FO tree.
|
org.apache.fop.fo.expr |
Classes for XSL expressions and functions.
|
org.apache.fop.fo.extensions |
Base classes for implementing extensions to XSL-FO.
|
org.apache.fop.fo.extensions.destination |
Classes to support named destinations (only relevant for PDF output)
|
org.apache.fop.fo.flow |
All the block- and inline-level flow formatting objects.
|
org.apache.fop.fo.flow.table | |
org.apache.fop.fo.pagination |
All the pagination and declaration formatting objects.
|
org.apache.fop.fo.pagination.bookmarks |
Formatting objects for bookmarks as defined since XSL 1.1.
|
org.apache.fop.fonts |
Classes for font handling.
|
org.apache.fop.fonts.substitute |
Font substitution facilities.
|
org.apache.fop.render |
Generic renderer interface.
|
org.apache.fop.render.afp |
An AFP Renderer implementation and supporting classes.
|
org.apache.fop.render.afp.extensions | |
org.apache.fop.render.awt |
AWT Renderer used for displaying rendered pages in Java applications.
|
org.apache.fop.render.awt.viewer |
AWT Viewer PreviewDialog and PreviewPanel.
|
org.apache.fop.render.bitmap |
Bitmap Renderer which creates TIFF and PNG images from rendered pages.
|
org.apache.fop.render.intermediate | |
org.apache.fop.render.java2d |
Java2D Renderer which paints rendered pages on Graphics2D instances.
|
org.apache.fop.render.pcl |
PCL Renderer (Supports PCL5 and HP GL/2)
|
org.apache.fop.render.pdf |
PDF Renderer
|
org.apache.fop.render.pdf.extensions | |
org.apache.fop.render.print |
Renderer which prints rendered pages directly to a printer.
|
org.apache.fop.render.ps |
PostScript Renderer
|
org.apache.fop.render.ps.extensions |
Extensions specific to the PostScript Renderer.
|
org.apache.fop.render.rtf.rtflib.rtfdoc |
Independent subsystem (not specific to FOP) classes that are used to build
RTF documents.
|
org.apache.fop.render.txt |
Plain Text Renderer
|
org.apache.fop.render.xml |
Area Tree XML Renderer.
|
org.apache.fop.servlet |
This package contains two sample FOP servlets.
|
org.apache.fop.svg |
Classes that add SVG support to FOP and SVG->PDF conversion for Batik.
|
org.apache.fop.tools.fontlist | |
org.apache.fop.util |
Various utility classes (I/O, codecs, color support, service discovers etc.).
|
Modifier and Type | Method and Description |
---|---|
DefaultHandler |
Fop.getDefaultHandler()
Returns the DefaultHandler object that will receive the SAX stream containing the
FO document to be rendered.
|
RendererConfig |
FOUserAgent.getRendererConfig(String mimeType,
RendererConfig.RendererConfigParser configCreator)
Returns the renderer configuration object for a particular MIME type.
|
Fop |
FopFactory.newFop(FOUserAgent userAgent)
Returns a new
Fop instance. |
Fop |
FOUserAgent.newFop(String outputFormat)
Returns a new
Fop instance. |
Fop |
FopFactory.newFop(String outputFormat)
Returns a new
Fop instance. |
Fop |
FopFactory.newFop(String outputFormat,
FOUserAgent userAgent)
Returns a new
Fop instance. |
Fop |
FopFactory.newFop(String outputFormat,
FOUserAgent userAgent,
OutputStream stream)
Returns a new
Fop instance. |
Fop |
FOUserAgent.newFop(String outputFormat,
OutputStream stream)
Returns a new
Fop instance. |
Fop |
FopFactory.newFop(String outputFormat,
OutputStream stream)
Returns a new
Fop instance. |
Modifier and Type | Method and Description |
---|---|
protected void |
AreaTreeHandler.setupModel(FOUserAgent userAgent,
String outputFormat,
OutputStream stream)
Sets up the AreaTreeModel instance for use by the AreaTreeHandler.
|
Constructor and Description |
---|
AreaTreeHandler(FOUserAgent userAgent,
String outputFormat,
OutputStream stream)
Constructor.
|
CachedRenderPagesModel(FOUserAgent userAgent,
String outputFormat,
FontInfo fontInfo,
OutputStream stream)
Main Constructor
|
PageViewport(PageViewport original)
Copy constructor.
|
RenderPagesModel(FOUserAgent userAgent,
String outputFormat,
FontInfo fontInfo,
OutputStream stream)
Create a new render pages model with the given renderer.
|
Modifier and Type | Method and Description |
---|---|
protected String |
CommandLineOptions.getOutputFormat() |
boolean |
CommandLineOptions.parse(String[] args)
Parses the command line arguments.
|
void |
InputHandler.renderTo(FOUserAgent userAgent,
String outputFormat)
Renders the pre-setup document.
|
void |
IFInputHandler.renderTo(FOUserAgent userAgent,
String outputFormat,
OutputStream out)
Generate a document, given an initialized Fop object
|
void |
InputHandler.renderTo(FOUserAgent userAgent,
String outputFormat,
OutputStream out)
Generate a document, given an initialized Fop object
|
void |
AreaTreeInputHandler.renderTo(FOUserAgent userAgent,
String outputFormat,
OutputStream out)
Generate a document, given an initialized Fop object
|
void |
InputHandler.transformTo(OutputStream out)
In contrast to render(Fop) this method only performs the XSLT stage and saves the
intermediate XSL-FO file to the output file.
|
protected void |
InputHandler.transformTo(Result result)
Transforms the input document to the input format expected by FOP using XSLT.
|
Modifier and Type | Class and Description |
---|---|
class |
ValidationException
Exception thrown during FO tree validation.
|
Modifier and Type | Method and Description |
---|---|
void |
FOValidationEventProducer.markerCloningFailed(Object source,
String markerClassName,
FOPException fe,
Locator loc)
Indicates a problem while cloning a marker (ex.
|
Modifier and Type | Method and Description |
---|---|
protected void |
FONode.addCharacters(char[] data,
int start,
int end,
PropertyList pList,
Locator locator)
Deprecated.
Please override
FONode.characters(char[], int, int, PropertyList, Locator)
instead! |
protected void |
FObj.addChildNode(FONode child)
Adds a node as a child of this node.
|
protected void |
FONode.addChildNode(FONode child)
Adds a node as a child of this node.
|
protected void |
FObjMixed.addChildNode(FONode child)
Adds a node as a child of this node.
|
protected static void |
FObj.addChildTo(FONode child,
FONode parent)
Used by RetrieveMarker during Marker-subtree cloning
|
void |
FObj.bind(PropertyList pList)
Bind property values from the property list to the FO node.
|
void |
FONode.bind(PropertyList propertyList)
Bind the given
PropertyList to this node
Does nothing by default. |
void |
FOText.bind(PropertyList pList)
Bind the given
PropertyList to this node
Does nothing by default. |
protected void |
XMLObj.characters(char[] data,
int start,
int length,
PropertyList pList,
Locator locator)
Adds characters.
|
protected void |
FONode.characters(char[] data,
int start,
int length,
PropertyList pList,
Locator locator)
Adds characters.
|
protected void |
UnknownXMLObj.characters(char[] data,
int start,
int length,
PropertyList pList,
Locator locator)
Adds characters.
|
protected void |
FObjMixed.characters(char[] data,
int start,
int length,
PropertyList pList,
Locator locator)
Adds characters.
|
protected void |
FOText.characters(char[] data,
int start,
int length,
PropertyList list,
Locator locator)
Adds characters.
|
FONode |
FObj.clone(FONode parent,
boolean removeChildren)
Performs a shallow cloning operation, sets the clone's parent,
and optionally cleans the list of child nodes
|
FONode |
FONode.clone(FONode cloneparent,
boolean removeChildren)
Performs a shallow cloning operation, sets the clone's parent,
and optionally cleans the list of child nodes
|
FONode |
FObjMixed.clone(FONode parent,
boolean removeChildren) |
FONode |
FOText.clone(FONode parent,
boolean removeChildren)
Performs a shallow cloning operation, sets the clone's parent,
and optionally cleans the list of child nodes
|
protected PropertyList |
FObj.createPropertyList(PropertyList parent,
FOEventHandler foEventHandler)
Create a default property list for this element.
|
protected PropertyList |
FONode.createPropertyList(PropertyList pList,
FOEventHandler foEventHandler)
Create a property list for this node.
|
void |
FObj.endOfNode()
Primarily used for making final content model validation checks
and/or informing the
FOEventHandler that the end of this FO
has been reached. |
void |
FONode.endOfNode()
Primarily used for making final content model validation checks
and/or informing the
FOEventHandler that the end of this FO
has been reached. |
void |
FObjMixed.endOfNode()
Primarily used for making final content model validation checks
and/or informing the
FOEventHandler that the end of this FO
has been reached. |
void |
FOText.endOfNode()
Primarily used for making final content model validation checks
and/or informing the
FOEventHandler that the end of this FO
has been reached. |
void |
FONode.finalizeNode()
Finalize this node.
|
void |
FObjMixed.finalizeNode()
Finalize this node.
|
ElementMapping.Maker |
ElementMappingRegistry.findFOMaker(String namespaceURI,
String localName,
Locator locator)
Finds the Maker used to create node objects of a particular type
|
Property |
PropertyList.getPropertyForAttribute(Attributes attributes,
String attributeName,
String attributeValue) |
void |
XMLObj.processNode(String elementName,
Locator locator,
Attributes attlist,
PropertyList propertyList)
Initialize the node with its name, location information, and attributes
The attributes must be used immediately as the sax attributes
will be altered for the next element.
|
void |
FObj.processNode(String elementName,
Locator locator,
Attributes attlist,
PropertyList pList)
Initialize the node with its name, location information, and attributes
The attributes must be used immediately as the sax attributes
will be altered for the next element.
|
void |
FONode.processNode(String elementName,
Locator locator,
Attributes attlist,
PropertyList pList)
Initialize the node with its name, location information, and attributes
The attributes must be used immediately as the sax attributes
will be altered for the next element.
|
void |
FObj.startOfNode()
Called after processNode() is called.
|
void |
FONode.startOfNode()
Called after processNode() is called.
|
Constructor and Description |
---|
FOTreeBuilder(String outputFormat,
FOUserAgent foUserAgent,
OutputStream stream)
FOTreeBuilder constructor |
Modifier and Type | Class and Description |
---|---|
class |
PropertyException
Class for managing exceptions that are raised in Property processing.
|
Modifier and Type | Method and Description |
---|---|
void |
ExternalDocument.bind(PropertyList pList)
Bind property values from the property list to the FO node.
|
void |
ExternalDocument.endOfNode() |
void |
ExternalDocument.startOfNode() |
Modifier and Type | Method and Description |
---|---|
void |
Destination.endOfNode()
Primarily used for making final content model validation checks
and/or informing the
FOEventHandler that the end of this FO
has been reached. |
void |
Destination.processNode(String elementName,
Locator locator,
Attributes attlist,
PropertyList pList)
Initialize the node with its name, location information, and attributes
The attributes must be used immediately as the sax attributes
will be altered for the next element.
|
Modifier and Type | Method and Description |
---|---|
protected void |
Wrapper.addChildNode(FONode child)
Adds a node as a child of this node.
|
protected void |
InstreamForeignObject.addChildNode(FONode child)
Adds a node as a child of this node.
|
void |
RetrieveMarker.bind(PropertyList pList)
Bind property values from the property list to the FO node.
|
void |
Leader.bind(PropertyList pList)
Bind property values from the property list to the FO node.
|
void |
BidiOverride.bind(PropertyList pList)
Bind property values from the property list to the FO node.
|
void |
AbstractPageNumberCitation.bind(PropertyList pList)
Bind property values from the property list to the FO node.
|
void |
BasicLink.bind(PropertyList pList)
Bind property values from the property list to the FO node.
|
void |
InlineLevel.bind(PropertyList pList)
Bind property values from the property list to the FO node.
|
void |
FootnoteBody.bind(PropertyList pList)
Bind property values from the property list to the FO node.
|
void |
ExternalGraphic.bind(PropertyList pList)
Bind property values from the property list to the FO node.
|
void |
BlockContainer.bind(PropertyList pList)
Bind property values from the property list to the FO node.
|
void |
PageNumber.bind(PropertyList pList)
Bind property values from the property list to the FO node.
|
void |
Wrapper.bind(PropertyList pList) |
void |
AbstractRetrieveMarker.bind(PropertyList pList)
Bind property values from the property list to the FO node.
|
void |
Inline.bind(PropertyList pList)
Bind property values from the property list to the FO node.
|
void |
ListBlock.bind(PropertyList pList)
Bind property values from the property list to the FO node.
|
void |
Marker.bind(PropertyList pList)
Bind property values from the property list to the FO node.
|
void |
ChangeBar.bind(PropertyList pList)
Bind property values from the property list to the FO node.
|
void |
MultiCase.bind(PropertyList pList) |
void |
ListItem.bind(PropertyList pList)
Bind property values from the property list to the FO node.
|
void |
Character.bind(PropertyList pList)
Bind property values from the property list to the FO node.
|
void |
MultiSwitch.bind(PropertyList pList)
Bind property values from the property list to the FO node.
|
void |
MultiPropertySet.bind(PropertyList pList)
Bind property values from the property list to the FO node.
|
void |
MultiToggle.bind(PropertyList pList)
Bind property values from the property list to the FO node.
|
void |
AbstractGraphics.bind(PropertyList pList)
Bind property values from the property list to the FO node.
|
void |
Float.bind(PropertyList pList)
Bind property values from the property list to the FO node.
|
void |
InlineContainer.bind(PropertyList pList) |
void |
RetrieveTableMarker.bind(PropertyList pList)
Bind property values from the property list to the FO node.
|
void |
InitialPropertySet.bind(PropertyList pList)
Bind property values from the property list to the FO node.
|
void |
Block.bind(PropertyList pList)
Bind property values from the property list to the FO node.
|
void |
Footnote.bind(PropertyList pList)
Bind property values from the property list to the FO node.
|
void |
AbstractListItemPart.bind(PropertyList pList)
Bind property values from the property list to the FO node.
|
void |
RetrieveMarker.endOfNode() |
void |
Leader.endOfNode() |
void |
MultiProperties.endOfNode()
Primarily used for making final content model validation checks
and/or informing the
FOEventHandler that the end of this FO
has been reached. |
void |
BasicLink.endOfNode()
Primarily used for making final content model validation checks
and/or informing the
FOEventHandler that the end of this FO
has been reached. |
void |
FootnoteBody.endOfNode()
Make sure the content model is satisfied, if so then tell the
FOEventHandler that we are at the
end of the footnote-body. |
void |
BlockContainer.endOfNode()
Primarily used for making final content model validation checks
and/or informing the
FOEventHandler that the end of this FO
has been reached. |
void |
PageNumber.endOfNode()
Primarily used for making final content model validation checks
and/or informing the
FOEventHandler that the end of this FO
has been reached. |
void |
Wrapper.endOfNode() |
void |
Inline.endOfNode()
Primarily used for making final content model validation checks
and/or informing the
FOEventHandler that the end of this FO
has been reached. |
void |
ListBlock.endOfNode()
Make sure the content model is satisfied, if so then tell the
FOEventHandler that we are at the end
of the list-block. |
void |
InstreamForeignObject.endOfNode()
Make sure content model satisfied, if so then tell the
FOEventHandler that we are at
the end of the instream-foreign-object. |
void |
Marker.endOfNode()
Primarily used for making final content model validation checks
and/or informing the
FOEventHandler that the end of this FO
has been reached. |
void |
MultiCase.endOfNode() |
void |
ListItem.endOfNode()
Primarily used for making final content model validation checks
and/or informing the
FOEventHandler that the end of this FO
has been reached. |
void |
MultiSwitch.endOfNode()
Primarily used for making final content model validation checks
and/or informing the
FOEventHandler that the end of this FO
has been reached. |
void |
PageNumberCitation.endOfNode()
Primarily used for making final content model validation checks
and/or informing the
FOEventHandler that the end of this FO
has been reached. |
void |
ListItemLabel.endOfNode()
Primarily used for making final content model validation checks
and/or informing the
FOEventHandler that the end of this FO
has been reached. |
void |
Float.endOfNode()
Primarily used for making final content model validation checks
and/or informing the
FOEventHandler that the end of this FO
has been reached. |
void |
InlineContainer.endOfNode() |
void |
ListItemBody.endOfNode()
Primarily used for making final content model validation checks
and/or informing the
FOEventHandler that the end of this FO
has been reached. |
void |
RetrieveTableMarker.endOfNode() |
void |
PageNumberCitationLast.endOfNode()
Primarily used for making final content model validation checks
and/or informing the
FOEventHandler that the end of this FO
has been reached. |
void |
Block.endOfNode()
Primarily used for making final content model validation checks
and/or informing the
FOEventHandler that the end of this FO
has been reached. |
void |
Footnote.endOfNode()
Make sure content model satisfied, if so then tell the
FOEventHandler that we are at the end of the footnote. |
void |
AbstractListItemPart.endOfNode()
Primarily used for making final content model validation checks
and/or informing the
FOEventHandler that the end of this FO
has been reached. |
void |
RetrieveMarker.processNode(String elementName,
Locator locator,
Attributes attlist,
PropertyList pList)
Initialize the node with its name, location information, and attributes
The attributes must be used immediately as the sax attributes
will be altered for the next element.
|
void |
AbstractPageNumberCitation.processNode(String elementName,
Locator locator,
Attributes attlist,
PropertyList pList)
Initialize the node with its name, location information, and attributes
The attributes must be used immediately as the sax attributes
will be altered for the next element.
|
void |
ChangeBarBegin.processNode(String elementName,
Locator locator,
Attributes attlist,
PropertyList pList)
Initialize the node with its name, location information, and attributes
The attributes must be used immediately as the sax attributes
will be altered for the next element.
|
void |
ChangeBar.processNode(String elementName,
Locator locator,
Attributes attlist,
PropertyList pList)
Initialize the node with its name, location information, and attributes
The attributes must be used immediately as the sax attributes
will be altered for the next element.
|
void |
Float.processNode(String elementName,
Locator locator,
Attributes attlist,
PropertyList pList) |
void |
RetrieveTableMarker.processNode(String elementName,
Locator locator,
Attributes attlist,
PropertyList pList)
Initialize the node with its name, location information, and attributes
The attributes must be used immediately as the sax attributes
will be altered for the next element.
|
void |
ChangeBarEnd.processNode(String elementName,
Locator locator,
Attributes attlist,
PropertyList pList)
Initialize the node with its name, location information, and attributes
The attributes must be used immediately as the sax attributes
will be altered for the next element.
|
void |
RetrieveMarker.startOfNode() |
void |
Leader.startOfNode() |
void |
BasicLink.startOfNode()
Called after processNode() is called.
|
void |
FootnoteBody.startOfNode()
Called after processNode() is called.
|
void |
ExternalGraphic.startOfNode()
Called after processNode() is called.
|
void |
BlockContainer.startOfNode()
Called after processNode() is called.
|
void |
PageNumber.startOfNode()
Called after processNode() is called.
|
void |
Wrapper.startOfNode() |
void |
Inline.startOfNode()
Called after processNode() is called.
|
void |
ListBlock.startOfNode()
Called after processNode() is called.
|
void |
InstreamForeignObject.startOfNode() |
void |
ListItem.startOfNode()
Called after processNode() is called.
|
void |
Character.startOfNode()
Called after processNode() is called.
|
void |
PageNumberCitation.startOfNode()
Called after processNode() is called.
|
void |
ListItemLabel.startOfNode()
Called after processNode() is called.
|
void |
ListItemBody.startOfNode()
Called after processNode() is called.
|
void |
RetrieveTableMarker.startOfNode() |
void |
PageNumberCitationLast.startOfNode()
Called after processNode() is called.
|
void |
Block.startOfNode()
Called after processNode() is called.
|
void |
Footnote.startOfNode()
Called after processNode() is called.
|
Modifier and Type | Method and Description |
---|---|
protected void |
Table.addChildNode(FONode child)
Adds a node as a child of this node.
|
protected void |
TablePart.addChildNode(FONode child)
Adds a node as a child of this node.
|
protected void |
TableRow.addChildNode(FONode child)
Adds a node as a child of this node.
|
protected void |
TableCellContainer.addTableCellChild(TableCell cell,
boolean firstRow)
Add cell to current row.
|
void |
Table.bind(PropertyList pList)
Bind property values from the property list to the FO node.
|
void |
TablePart.bind(PropertyList pList)
Bind property values from the property list to the FO node.
|
void |
TableCaption.bind(PropertyList pList)
Bind property values from the property list to the FO node.
|
void |
TableColumn.bind(PropertyList pList)
Bind property values from the property list to the FO node.
|
void |
TableCellContainer.bind(PropertyList pList) |
void |
TableAndCaption.bind(PropertyList pList) |
void |
TableRow.bind(PropertyList pList)
Bind property values from the property list to the FO node.
|
void |
TableFObj.bind(PropertyList pList)
Bind property values from the property list to the FO node.
|
void |
TableCell.bind(PropertyList pList)
Bind property values from the property list to the FO node.
|
FONode |
Table.clone(FONode parent,
boolean removeChildren)
Performs a shallow cloning operation, sets the clone's parent,
and optionally cleans the list of child nodes
|
void |
Table.endOfNode()
Primarily used for making final content model validation checks
and/or informing the
FOEventHandler that the end of this FO
has been reached. |
void |
TableHeader.endOfNode()
Primarily used for making final content model validation checks
and/or informing the
FOEventHandler that the end of this FO
has been reached. |
void |
TableCaption.endOfNode()
Primarily used for making final content model validation checks
and/or informing the
FOEventHandler that the end of this FO
has been reached. |
void |
TableFooter.endOfNode()
Primarily used for making final content model validation checks
and/or informing the
FOEventHandler that the end of this FO
has been reached. |
void |
TableColumn.endOfNode()
Primarily used for making final content model validation checks
and/or informing the
FOEventHandler that the end of this FO
has been reached. |
void |
TableAndCaption.endOfNode()
Make sure content model satisfied, if so then tell the
FOEventHandler that we are at the end of the flow.
|
void |
TableRow.endOfNode()
Primarily used for making final content model validation checks
and/or informing the
FOEventHandler that the end of this FO
has been reached. |
void |
TableBody.endOfNode()
Primarily used for making final content model validation checks
and/or informing the
FOEventHandler that the end of this FO
has been reached. |
void |
TableCell.endOfNode()
Make sure content model satisfied, if so then tell the
FOEventHandler that we are at the end of the table-cell.
|
void |
Table.finalizeNode()
Finalize this node.
|
void |
TablePart.finalizeNode()
Finalize this node.
|
void |
TableRow.finalizeNode()
Finalize this node.
|
void |
TableCell.finalizeNode()
Finalize this node.
|
void |
TablePart.processNode(String elementName,
Locator locator,
Attributes attlist,
PropertyList pList)
Initialize the node with its name, location information, and attributes
The attributes must be used immediately as the sax attributes
will be altered for the next element.
|
void |
TableRow.processNode(String elementName,
Locator locator,
Attributes attlist,
PropertyList pList)
Initialize the node with its name, location information, and attributes
The attributes must be used immediately as the sax attributes
will be altered for the next element.
|
void |
TableFObj.processNode(String elementName,
Locator locator,
Attributes attlist,
PropertyList pList)
Initialize the node with its name, location information, and attributes
The attributes must be used immediately as the sax attributes
will be altered for the next element.
|
void |
Table.startOfNode()
Called after processNode() is called.
|
void |
TableHeader.startOfNode()
Called after processNode() is called.
|
void |
TableFooter.startOfNode()
Called after processNode() is called.
|
void |
TableColumn.startOfNode()
Called after processNode() is called.
|
void |
TableRow.startOfNode()
Called after processNode() is called.
|
void |
TableBody.startOfNode()
Called after processNode() is called.
|
void |
TableCell.startOfNode()
Called after processNode() is called.
|
Modifier and Type | Method and Description |
---|---|
void |
PageSequence.addChildNode(FONode child)
Adds a node as a child of this node.
|
protected void |
SimplePageMaster.addChildNode(FONode child)
Adds a node as a child of this node.
|
void |
RepeatablePageMasterReference.bind(PropertyList pList)
Bind property values from the property list to the FO node.
|
void |
PageSequence.bind(PropertyList pList)
Bind property values from the property list to the FO node.
|
void |
RepeatablePageMasterAlternatives.bind(PropertyList pList)
Bind property values from the property list to the FO node.
|
void |
PageSequenceMaster.bind(PropertyList pList)
Bind property values from the property list to the FO node.
|
void |
Flow.bind(PropertyList pList)
Bind property values from the property list to the FO node.
|
void |
AbstractPageSequence.bind(PropertyList pList)
Bind property values from the property list to the FO node.
|
void |
ColorProfile.bind(PropertyList pList)
Bind property values from the property list to the FO node.
|
void |
LayoutMasterSet.bind(PropertyList pList)
Bind property values from the property list to the FO node.
|
void |
RegionBody.bind(PropertyList pList)
Bind property values from the property list to the FO node.
|
void |
Root.bind(PropertyList pList)
Bind property values from the property list to the FO node.
|
void |
RegionBA.bind(PropertyList pList)
Bind property values from the property list to the FO node.
|
void |
SimplePageMaster.bind(PropertyList pList)
Bind property values from the property list to the FO node.
|
void |
Region.bind(PropertyList pList)
Bind property values from the property list to the FO node.
|
void |
ConditionalPageMasterReference.bind(PropertyList pList)
Bind property values from the property list to the FO node.
|
void |
RegionSE.bind(PropertyList pList)
Bind property values from the property list to the FO node.
|
void |
SinglePageMasterReference.bind(PropertyList pList)
Bind property values from the property list to the FO node.
|
void |
PageSequenceWrapper.bind(PropertyList pList)
Bind property values from the property list to the FO node.
|
void |
Declarations.bind(PropertyList pList)
Bind property values from the property list to the FO node.
|
void |
SideRegion.bind(PropertyList pList)
Bind property values from the property list to the FO node.
|
void |
PageSequence.endOfNode()
Primarily used for making final content model validation checks
and/or informing the
FOEventHandler that the end of this FO
has been reached. |
void |
RepeatablePageMasterAlternatives.endOfNode()
Primarily used for making final content model validation checks
and/or informing the
FOEventHandler that the end of this FO
has been reached. |
void |
PageSequenceMaster.endOfNode()
Primarily used for making final content model validation checks
and/or informing the
FOEventHandler that the end of this FO
has been reached. |
void |
Flow.endOfNode()
Primarily used for making final content model validation checks
and/or informing the
FOEventHandler that the end of this FO
has been reached. |
void |
LayoutMasterSet.endOfNode()
Primarily used for making final content model validation checks
and/or informing the
FOEventHandler that the end of this FO
has been reached. |
void |
Root.endOfNode()
Primarily used for making final content model validation checks
and/or informing the
FOEventHandler that the end of this FO
has been reached. |
void |
SimplePageMaster.endOfNode()
Primarily used for making final content model validation checks
and/or informing the
FOEventHandler that the end of this FO
has been reached. |
void |
StaticContent.endOfNode()
Make sure content model satisfied, if so then tell the
FOEventHandler that we are at the end of the flow.
|
void |
Declarations.endOfNode()
At the end of this element sort out the children into
a hashmap of color profiles and a list of extension attachments.
|
void |
RepeatablePageMasterReference.startOfNode()
Called after processNode() is called.
|
void |
PageSequence.startOfNode()
Called after processNode() is called.
|
void |
RepeatablePageMasterAlternatives.startOfNode()
Called after processNode() is called.
|
void |
PageSequenceMaster.startOfNode()
Called after processNode() is called.
|
void |
Flow.startOfNode()
Called after processNode() is called.
|
void |
AbstractPageSequence.startOfNode()
Called after processNode() is called.
|
void |
LayoutMasterSet.startOfNode()
Called after processNode() is called.
|
void |
Root.startOfNode()
Called after processNode() is called.
|
void |
SimplePageMaster.startOfNode()
Called after processNode() is called.
|
void |
StaticContent.startOfNode()
Called after processNode() is called.
|
void |
ConditionalPageMasterReference.startOfNode()
Called after processNode() is called.
|
void |
SinglePageMasterReference.startOfNode()
Called after processNode() is called.
|
Modifier and Type | Method and Description |
---|---|
void |
BookmarkTitle.bind(PropertyList pList) |
void |
Bookmark.bind(PropertyList pList)
Bind property values from the property list to the FO node.
|
void |
BookmarkTree.endOfNode()
Primarily used for making final content model validation checks
and/or informing the
FOEventHandler that the end of this FO
has been reached. |
void |
Bookmark.endOfNode()
Primarily used for making final content model validation checks
and/or informing the
FOEventHandler that the end of this FO
has been reached. |
Modifier and Type | Method and Description |
---|---|
void |
FontManager.autoDetectFonts(boolean autoDetectFonts,
FontAdder fontAdder,
boolean strict,
FontEventListener listener,
List<EmbedFontInfo> fontInfoList)
Detect fonts from the operating system via FOPs autodetect mechanism.
|
List<EmbedFontInfo> |
DefaultFontConfigurator.configure(FontConfig fontInfoConfig)
Initializes font info settings from the user configuration
|
List<T> |
FontConfigurator.configure(FontConfig fontInfoConfig)
Initializes font info settings from the user configuration
|
void |
FontManagerConfigurator.configure(FontManager fontManager,
boolean strict)
Initializes font settings from the user configuration
|
static FontTriplet.Matcher |
FontManagerConfigurator.createFontsMatcher(Configuration cfg,
boolean strict)
Creates a font triplet matcher from a configuration object.
|
static FontTriplet.Matcher |
FontManagerConfigurator.createFontsMatcher(List<String> fontFamilies,
boolean strict)
Creates a font triplet matcher from a configuration object.
|
void |
FontCacheManager.delete()
Deletes the font cache from the file-system.
|
void |
FontManager.deleteCache()
Deletes the current FontCache file
|
void |
FontDetector.detect(FontManager fontManager,
FontAdder fontAdder,
boolean strict,
FontEventListener eventListener,
List<EmbedFontInfo> fontInfoList) |
DefaultFontConfig |
DefaultFontConfig.DefaultFontConfigParser.parse(Configuration cfg,
boolean strict)
Parses the font configuration and return the configuration object.
|
DefaultFontConfig |
DefaultFontConfig.DefaultFontConfigParser.parse(Configuration cfg,
boolean strict,
FontEventAdapter eventAdapter) |
FontConfig |
DefaultFontConfig.DefaultFontConfigParser.parse(Configuration cfg,
FontManager fontManager,
boolean strict,
EventProducer eventProducer)
Parse the font configuration and return an object containing all the necessary data.
|
FontConfig |
FontConfig.FontConfigParser.parse(Configuration cfg,
FontManager fontManager,
boolean strict,
EventProducer eventProducer)
Parse the font configuration and return an object containing all the necessary data.
|
void |
FontCache.save()
Deprecated.
use
FontCache.saveTo(File) instead |
void |
FontCacheManager.save()
Serializes the font cache to file.
|
void |
FontManager.saveCache()
Saves the FontCache as necessary
|
void |
FontCache.saveTo(File cacheFile)
Writes the font cache to disk.
|
Constructor and Description |
---|
XMLFontMetricsReader(InputSource source,
InternalResourceResolver resourceResolver)
Deprecated.
Construct a XMLFontMetricsReader object from a path to a metric.xml file
and read metric data
|
Modifier and Type | Method and Description |
---|---|
void |
FontSubstitutionsConfigurator.configure(FontSubstitutions substitutions)
Configures a font substitution catalog
|
Modifier and Type | Method and Description |
---|---|
RendererConfig |
RendererConfig.RendererConfigParser.build(FOUserAgent userAgent,
Configuration rendererConfiguration)
Builds the object that contains the renderer configuration data.
|
void |
PrintRendererConfigurator.configure(IFDocumentHandler documentHandler)
Configures a intermediate format document handler.
|
void |
PrintRendererConfigurator.configure(Renderer renderer)
Builds a list of EmbedFontInfo objects for use with the setup() method.
|
void |
XMLHandlerConfigurator.configure(RendererContext context,
String ns)
Configures renderer context by setting the handler configuration on it.
|
abstract void |
AbstractRendererMaker.configureRenderer(FOUserAgent userAgent,
Renderer renderer)
Configures a given renderer using the appropriate configurator.
|
IFDocumentHandler |
RendererFactory.createDocumentHandler(FOUserAgent userAgent,
String outputFormat)
Creates a
IFDocumentHandler object based on the desired output format. |
FOEventHandler |
RendererFactory.createFOEventHandler(FOUserAgent userAgent,
String outputFormat,
OutputStream out)
Creates FOEventHandler instances based on the desired output.
|
Renderer |
RendererFactory.createRenderer(FOUserAgent userAgent,
String outputFormat)
Creates a Renderer object based on render-type desired
|
protected FontCollection |
PrintRendererConfigurator.getCustomFontCollection(InternalResourceResolver resolver,
String mimeType)
Returns the font collection for custom configured fonts.
|
protected RendererConfig |
PrintRendererConfigurator.getRendererConfig(IFDocumentHandler documentHandler)
Returns the renderer configuration data for a specific renderer.
|
protected RendererConfig |
PrintRendererConfigurator.getRendererConfig(Renderer renderer)
gets the renderer configuration data for a specific renderer.
|
protected RendererConfig |
PrintRendererConfigurator.getRendererConfig(String mimeType)
gets the renderer configuration data for a specific renderer.
|
abstract FOEventHandler |
AbstractFOEventHandlerMaker.makeFOEventHandler(FOUserAgent ua,
OutputStream out)
Instantiates a new FOEventHandler.
|
void |
AbstractRenderer.renderPage(PageViewport page)
Tells the renderer to render a particular page.
|
void |
Renderer.renderPage(PageViewport page)
Tells the renderer to render a particular page.
|
void |
PrintRenderer.setupFontInfo(FontInfo inFontInfo)
Set up the given FontInfo.
|
abstract void |
AbstractRenderer.setupFontInfo(FontInfo fontInfo)
Set up the given FontInfo.
|
void |
Renderer.setupFontInfo(FontInfo fontInfo)
Set up the given FontInfo.
|
void |
PrintRendererConfigurator.setupFontInfo(String mimeType,
FontInfo fontInfo)
Sets up the
FontInfo object for the IFDocumentHandler. |
Modifier and Type | Method and Description |
---|---|
AFPRendererConfig |
AFPRendererConfig.AFPRendererConfigParser.build(FOUserAgent userAgent,
Configuration cfg)
Builds the object that contains the renderer configuration data.
|
void |
AFPRendererConfigurator.configure(IFDocumentHandler documentHandler) |
protected FontCollection |
AFPRendererConfigurator.getCustomFontCollection(InternalResourceResolver uriResolverWrapper,
String mimeType) |
Modifier and Type | Method and Description |
---|---|
protected void |
AFPPageSetupElement.characters(char[] data,
int start,
int length,
PropertyList pList,
Locator locator)
Adds characters.
|
void |
AbstractAFPExtensionObject.endOfNode()
Primarily used for making final content model validation checks
and/or informing the
FOEventHandler that the end of this FO
has been reached. |
void |
AFPPageSegmentElement.processNode(String elementName,
Locator locator,
Attributes attlist,
PropertyList propertyList)
Initialize the node with its name, location information, and attributes
The attributes must be used immediately as the sax attributes
will be altered for the next element.
|
void |
AFPPageOverlayElement.processNode(String elementName,
Locator locator,
Attributes attlist,
PropertyList propertyList)
Initialize the node with its name, location information, and attributes
The attributes must be used immediately as the sax attributes
will be altered for the next element.
|
void |
AFPIncludeFormMapElement.processNode(String elementName,
Locator locator,
Attributes attlist,
PropertyList propertyList)
Initialize the node with its name, location information, and attributes
The attributes must be used immediately as the sax attributes
will be altered for the next element.
|
void |
AbstractAFPExtensionObject.processNode(String elementName,
Locator locator,
Attributes attlist,
PropertyList propertyList)
Initialize the node with its name, location information, and attributes
The attributes must be used immediately as the sax attributes
will be altered for the next element.
|
void |
AFPPageSetupElement.processNode(String elementName,
Locator locator,
Attributes attlist,
PropertyList propertyList)
Initialize the node with its name, location information, and attributes
The attributes must be used immediately as the sax attributes
will be altered for the next element.
|
void |
AFPPageOverlayElement.startOfNode()
Called after processNode() is called.
|
void |
AFPIncludeFormMapElement.startOfNode()
Called after processNode() is called.
|
void |
AFPPageSetupElement.startOfNode()
Called after processNode() is called.
|
void |
AFPInvokeMediumMapElement.startOfNode()
Called after processNode() is called.
|
Modifier and Type | Method and Description |
---|---|
Dimension |
AWTRenderer.getPageImageSize(int pageNum) |
void |
AWTRenderer.renderPage(PageViewport pageViewport)
This method override only stores the PageViewport in a List.
|
Modifier and Type | Method and Description |
---|---|
double |
PreviewPanel.getScaleToFit(double viewWidth,
double viewHeight)
Returns the scale factor required in order to fit either the current page or
two adjacent pages within a window of the given height and width, depending
on the display mode.
|
double |
PreviewPanel.getScaleToFitWidth()
As getScaleToFitWindow, but ignoring the Y axis.
|
double |
PreviewPanel.getScaleToFitWindow()
Returns the scale factor required in order to fit either the current
page within the current window or to fit two adjacent pages within
the display if the displaymode is continuous.
|
void |
Renderable.renderTo(FOUserAgent userAgent,
String outputFormat)
Renders the pre-setup document.
|
Modifier and Type | Method and Description |
---|---|
BitmapRendererConfig |
BitmapRendererConfig.BitmapRendererConfigParser.build(FOUserAgent userAgent,
Configuration cfg) |
PNGRendererConfig |
PNGRendererConfig.PNGRendererConfigParser.build(FOUserAgent userAgent,
Configuration cfg) |
TIFFRendererConfig |
TIFFRendererConfig.TIFFRendererConfigParser.build(FOUserAgent userAgent,
Configuration cfg)
Builds the object that contains the renderer configuration data.
|
void |
BitmapRendererConfigurator.configure(IFDocumentHandler documentHandler)
Configures a intermediate format document handler.
|
void |
TIFFRendererConfigurator.configure(IFDocumentHandler documentHandler) |
void |
TIFFRendererConfigurator.configure(Renderer renderer)
Configure the TIFF renderer.
|
void |
TIFFRendererMaker.configureRenderer(FOUserAgent userAgent,
Renderer renderer) |
void |
PNGRendererMaker.configureRenderer(FOUserAgent userAgent,
Renderer renderer) |
Modifier and Type | Method and Description |
---|---|
RendererConfig |
IFRendererConfig.IFRendererConfigParser.build(FOUserAgent userAgent,
Configuration cfg)
Builds the object that contains the renderer configuration data.
|
void |
IFDocumentHandlerConfigurator.configure(IFDocumentHandler documentHandler)
Configures a intermediate format document handler.
|
void |
IFRenderer.renderPage(PageViewport page)
Tells the renderer to render a particular page.
|
void |
IFRenderer.setupFontInfo(FontInfo inFontInfo)
Set up the given FontInfo.
|
void |
IFDocumentHandlerConfigurator.setupFontInfo(String mimeType,
FontInfo fontInfo)
Sets up the
FontInfo object for the IFDocumentHandler. |
static void |
IFUtil.setupFonts(IFDocumentHandler documentHandler)
Sets up the fonts on a document handler.
|
static void |
IFUtil.setupFonts(IFDocumentHandler documentHandler,
FontInfo fontInfo)
Sets up the fonts on a document handler.
|
Modifier and Type | Method and Description |
---|---|
Java2DRendererConfig |
Java2DRendererConfig.Java2DRendererConfigParser.build(FOUserAgent userAgent,
Configuration cfg)
Builds the object that contains the renderer configuration data.
|
void |
Java2DRendererConfigurator.configure(Renderer renderer)
Configure the Java 2D renderer.
|
BufferedImage |
Java2DRenderer.getPageImage(int pageNum)
Generates a desired page from the renderer's page viewport list.
|
PageViewport |
Java2DRenderer.getPageViewport(int pageIndex)
Returns a page viewport.
|
void |
Java2DRenderer.renderPage(PageViewport pageViewport)
This method override only stores the PageViewport in a List.
|
Modifier and Type | Method and Description |
---|---|
PCLRendererConfig |
PCLRendererConfig.PCLRendererConfigParser.build(FOUserAgent userAgent,
Configuration cfg)
Builds the object that contains the renderer configuration data.
|
void |
PCLRendererConfigurator.configure(IFDocumentHandler documentHandler)
Configures a intermediate format document handler.
|
Modifier and Type | Method and Description |
---|---|
PDFRendererConfig |
PDFRendererConfig.PDFRendererConfigParser.build(FOUserAgent userAgent,
Configuration cfg) |
void |
PDFRendererConfigurator.configure(IFDocumentHandler documentHandler)
Configures a intermediate format document handler.
|
Modifier and Type | Method and Description |
---|---|
protected void |
PDFArrayElement.addChildNode(FONode child) |
protected void |
PDFDocumentInformationElement.addChildNode(FONode child) |
protected void |
PDFDictionaryElement.addChildNode(FONode child) |
protected void |
PDFCollectionEntryElement.characters(char[] data,
int start,
int length,
PropertyList pList,
Locator locator) |
void |
PDFArrayElement.endOfNode() |
void |
PDFCollectionEntryElement.endOfNode() |
void |
PDFDictionaryElement.endOfNode() |
void |
PDFArrayElement.processNode(String elementName,
Locator locator,
Attributes attlist,
PropertyList propertyList) |
void |
PDFActionElement.processNode(String elementName,
Locator locator,
Attributes attlist,
PropertyList propertyList) |
void |
PDFCollectionEntryElement.processNode(String elementName,
Locator locator,
Attributes attlist,
PropertyList propertyList) |
void |
PDFReferenceElement.processNode(String elementName,
Locator locator,
Attributes attlist,
PropertyList propertyList) |
void |
PDFPageElement.processNode(String elementName,
Locator locator,
Attributes attlist,
PropertyList propertyList) |
void |
PDFDocumentInformationElement.processNode(String elementName,
Locator locator,
Attributes attlist,
PropertyList propertyList) |
void |
PDFDictionaryElement.processNode(String elementName,
Locator locator,
Attributes attlist,
PropertyList propertyList) |
void |
PDFEmbeddedFileElement.processNode(String elementName,
Locator locator,
Attributes attlist,
PropertyList propertyList) |
void |
PDFLayerElement.startOfNode() |
void |
PDFNavigatorElement.startOfNode() |
void |
PDFArrayElement.startOfNode() |
void |
PDFActionElement.startOfNode() |
void |
PDFCollectionEntryElement.startOfNode() |
void |
PDFPageElement.startOfNode() |
void |
PDFCatalogElement.startOfNode() |
void |
PDFDocumentInformationElement.startOfNode() |
void |
PDFDictionaryElement.startOfNode() |
void |
PDFEmbeddedFileElement.startOfNode() |
Modifier and Type | Method and Description |
---|---|
void |
PrintRendererMaker.configureRenderer(FOUserAgent userAgent,
Renderer renderer) |
Modifier and Type | Method and Description |
---|---|
PSRendererConfig |
PSRendererConfig.PSRendererConfigParser.build(FOUserAgent userAgent,
Configuration cfg) |
void |
PSRendererConfigurator.configure(IFDocumentHandler documentHandler) |
Modifier and Type | Method and Description |
---|---|
void |
AbstractPSExtensionElement.endOfNode() |
void |
AbstractPSExtensionObject.endOfNode()
Primarily used for making final content model validation checks
and/or informing the
FOEventHandler that the end of this FO
has been reached. |
void |
AbstractPSExtensionObject.processNode(String elementName,
Locator locator,
Attributes attlist,
PropertyList propertyList)
Initialize the node with its name, location information, and attributes
The attributes must be used immediately as the sax attributes
will be altered for the next element.
|
void |
PSSetPageDeviceElement.processNode(String elementName,
Locator locator,
Attributes attlist,
PropertyList propertyList)
Initialize the node with its name, location information, and attributes
The attributes must be used immediately as the sax attributes
will be altered for the next element.
|
void |
PSPageSetupCodeElement.startOfNode()
Called after processNode() is called.
|
void |
AbstractPSCommentElement.startOfNode() |
void |
PSSetPageDeviceElement.startOfNode()
Called after processNode() is called.
|
void |
PSSetupCodeElement.startOfNode()
Called after processNode() is called.
|
Modifier and Type | Method and Description |
---|---|
RtfAttributes |
IRtfTextContainer.getTextContainerAttributes()
Text containers usually provide default attributes for all texts that they contain.
|
RtfAttributes |
RtfText.getTextContainerAttributes()
IRtfTextContainer requirement:
|
RtfAttributes |
RtfHyperLink.getTextContainerAttributes()
IRtfTextContainer requirement:
|
RtfAttributes |
RtfParagraph.getTextContainerAttributes()
IRtfTextContainer requirement: return a copy of our attributes
|
RtfTableCell |
RtfTableRow.newTableCellMergedHorizontally(int cellWidth,
RtfAttributes attrs)
Added by Boris POUDEROUS on 07/02/2002
in order to add an empty cell that is merged with the previous cell.
|
RtfTableRow |
RtfTable.newTableRow(RtfAttributes attrs)
Close current row if any and start a new one
|
Modifier and Type | Method and Description |
---|---|
TxtRendererConfig |
TxtRendererConfig.TxtRendererConfigParser.build(FOUserAgent userAgent,
Configuration cfg)
Builds the object that contains the renderer configuration data.
|
void |
TXTRendererConfigurator.configure(Renderer renderer)
Configure the PS renderer.
|
void |
TXTRendererMaker.configureRenderer(FOUserAgent userAgent,
Renderer renderer) |
void |
TXTRenderer.renderPage(PageViewport page)
Tells the renderer to render a particular page.
|
Modifier and Type | Method and Description |
---|---|
void |
XMLRendererMaker.configureRenderer(FOUserAgent userAgent,
Renderer renderer) |
void |
XMLRenderer.renderPage(PageViewport page)
Tells the renderer to render a particular page.
|
void |
XMLRenderer.setupFontInfo(FontInfo inFontInfo)
Set up the given FontInfo.
|
Modifier and Type | Method and Description |
---|---|
protected void |
FopServlet.render(Source src,
Transformer transformer,
jakarta.servlet.http.HttpServletResponse response)
Renders an input file (XML or XSL-FO) into a PDF file.
|
protected void |
FopPrintServlet.render(Source src,
Transformer transformer,
jakarta.servlet.http.HttpServletResponse response)
Renders an input file (XML or XSL-FO) into a PDF file.
|
protected void |
FopServlet.renderFO(String fo,
jakarta.servlet.http.HttpServletResponse response)
Renders an XSL-FO file into a PDF file.
|
protected void |
FopServlet.renderXML(String xml,
String xslt,
jakarta.servlet.http.HttpServletResponse response)
Renders an XML file into a PDF file by applying a stylesheet
that converts the XML to XSL-FO.
|
Modifier and Type | Method and Description |
---|---|
static FontInfo |
PDFDocumentGraphics2DConfigurator.createFontInfo(Configuration cfg,
boolean useComplexScriptFeatures)
Creates the
FontInfo instance for the given configuration. |
Modifier and Type | Method and Description |
---|---|
SortedMap |
FontListGenerator.listFonts(FopFactory fopFactory,
String mime,
FontEventListener listener)
List all fonts configured for a particular output format (identified by MIME type).
|
Modifier and Type | Method and Description |
---|---|
static void |
LogUtil.handleError(org.apache.commons.logging.Log log,
String errorStr,
boolean strict)
Convenience method that handles any error appropriately
|
static void |
LogUtil.handleException(org.apache.commons.logging.Log log,
Exception e,
boolean strict)
Convenience method that handles any error appropriately
|
Copyright © 2025 Apache Software Foundation. All rights reserved.