Package | Description |
---|---|
org.apache.fop.fo |
Classes, constants and basic infrastructure for the FO tree.
|
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.extensions.svg |
SVG extension classes which handle elements from the SVG namespace.
|
org.apache.fop.fo.extensions.xmp |
Extension classes which handles XMP metadata.
|
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.layoutmgr |
FOP's layout engine.
|
org.apache.fop.render.afp.extensions | |
org.apache.fop.render.ps.extensions |
Extensions specific to the PostScript Renderer.
|
Modifier and Type | Class and Description |
---|---|
class |
FObj
Base class for representation of formatting objects and their processing.
|
class |
FObjMixed
Base class for representation of mixed content formatting objects
(i.e., those that can contain both child FO's and text nodes/PCDATA).
|
class |
FOText
A text node (PCDATA) in the formatting object tree.
|
class |
UnknownXMLObj
Class for handling generic XML from a namespace not recognized by FOP
|
class |
XMLObj
Abstract class modelling generic, non-XSL-FO XML objects.
|
Modifier and Type | Field and Description |
---|---|
protected FONode |
FObjMixed.currentTextNode
Used for white-space handling; start CharIterator at node ...
|
protected FONode |
FObj.firstChild
pointer to the descendant subtree
|
protected FONode |
FONode.parent
Parent FO node
|
protected FONode[] |
FONode.siblings
pointer to the sibling nodes
|
Modifier and Type | Method and Description |
---|---|
FONode |
FONode.clone(FONode cloneparent,
boolean removeChildren)
Perform a shallow cloning operation,
set its parent, and optionally clean the list of child nodes
|
FONode |
FOText.clone(FONode parent,
boolean removeChildren)
Perform a shallow cloning operation,
set its parent, and optionally clean the list of child nodes
|
FONode |
FObj.clone(FONode parent,
boolean removeChildren)
Perform a shallow cloning operation,
set its parent, and optionally clean the list of child nodes
|
FONode |
FONode.FONodeIterator.firstNode()
Returns the first node in the list, and decreases the index,
so that a subsequent call to hasPrevious() will return false
|
FONode |
FObj.FObjIterator.firstNode()
Returns the first node in the list, and decreases the index,
so that a subsequent call to hasPrevious() will return false
|
FONode |
FONode.getParent() |
FONode |
FONode.FONodeIterator.lastNode()
Returns the last node in the list, and advances the
current position, so that a subsequent call to hasNext()
will return false
|
FONode |
FObj.FObjIterator.lastNode()
Returns the last node in the list, and advances the
current position, so that a subsequent call to hasNext()
will return false
|
FONode |
UnknownXMLObj.Maker.make(FONode parent)
Make an instance
|
FONode |
ElementMapping.Maker.make(FONode parent)
Creates a new FONode (or rather a specialized subclass of it).
|
FONode |
FONode.FONodeIterator.nextNode()
Convenience method with return type of FONode
(should be semantically equivalent to
(FONode) next(); ) |
FONode |
FObj.FObjIterator.nextNode()
Convenience method with return type of FONode
(should be semantically equivalent to
(FONode) next(); ) |
FONode |
FONode.FONodeIterator.previousNode()
Convenience method with return type of FONode
(should be semantically equivalent to
(FONode) previous(); ) |
FONode |
FObj.FObjIterator.previousNode()
Convenience method with return type of FONode
(should be semantically equivalent to
(FONode) previous(); ) |
Modifier and Type | Method and Description |
---|---|
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 void |
UnknownXMLObj.addChildNode(FONode child)
Adds a node as a child of this node.
|
protected void |
XMLObj.addChildNode(FONode child)
Adds a node as a child of this node.
|
protected void |
FObj.addChildNode(FONode child)
Adds a node as a child of this node.
|
protected static void |
FObj.addChildTo(FONode child,
FObj parent)
Used by RetrieveMarker during Marker-subtree cloning
|
protected static void |
FONode.attachSiblings(FONode precedingSibling,
FONode followingSibling)
This method is used when adding child nodes to a FO that already
contains at least one child.
|
FONode |
FONode.clone(FONode cloneparent,
boolean removeChildren)
Perform a shallow cloning operation,
set its parent, and optionally clean the list of child nodes
|
FONode |
FOText.clone(FONode parent,
boolean removeChildren)
Perform a shallow cloning operation,
set its parent, and optionally clean the list of child nodes
|
FONode |
FObj.clone(FONode parent,
boolean removeChildren)
Perform a shallow cloning operation,
set its parent, and optionally clean the list of child nodes
|
static java.lang.String |
FONode.decorateWithContextInfo(java.lang.String text,
FONode node)
Decorates a log or warning message with context information on the given node.
|
FONode.FONodeIterator |
FONode.getChildNodes(FONode childNode)
Return an iterator over the object's child nodes starting
at the passed node.
|
FONode.FONodeIterator |
FObj.getChildNodes(FONode childNode)
Return an iterator over the object's childNodes starting
at the passed-in node (= first call to iterator.next() will
return childNode)
|
void |
XMLWhiteSpaceHandler.handleWhiteSpace(FObjMixed fo,
FONode firstTextNode)
Handle white-space for the fo that is passed in, starting at
firstTextNode (when a nested FO is encountered)
|
void |
XMLWhiteSpaceHandler.handleWhiteSpace(FObjMixed fo,
FONode firstTextNode,
FONode nextChild)
Handle white-space for the fo that is passed in, starting at
firstTextNode
|
FONode |
UnknownXMLObj.Maker.make(FONode parent)
Make an instance
|
FONode |
ElementMapping.Maker.make(FONode parent)
Creates a new FONode (or rather a specialized subclass of it).
|
protected void |
FObj.notifyChildRemoval(FONode node)
Notifies a FObj that one of it's children is removed.
|
void |
FONode.removeChild(FONode child)
Removes a child node.
|
void |
FObj.removeChild(FONode child)
Removes a child node.
|
protected static void |
FONode.validateChildNode(FONode fo,
org.xml.sax.Locator loc,
java.lang.String namespaceURI,
java.lang.String localName)
Static version of
validateChildNode(Locator, String, String) that
can be used by subclasses that need to validate children against a different node
(for example: fo:wrapper needs to check if the incoming node is a
valid child to its parent) |
Constructor and Description |
---|
FObj(FONode parent)
Create a new formatting object.
|
FObjMixed(FONode parent) |
FONode(FONode parent)
Main constructor.
|
FOText(FONode parent)
Creates a now FO text node.
|
RecursiveCharIterator(FObj fobj,
FONode child)
Constructor which creates an iterator for only some child nodes
|
UnknownXMLObj(FONode parent,
java.lang.String space)
Constructs an unknown xml object (called by Maker).
|
XMLObj(FONode parent) |
Modifier and Type | Class and Description |
---|---|
class |
ExtensionObj
Base class for pdf bookmark extension objects.
|
class |
ExternalDocument
Class for the fox:external-document extenstion element.
|
Constructor and Description |
---|
ExtensionObj(FONode parent)
Create a new extension object.
|
ExternalDocument(FONode parent)
Constructs a ExternalDocument object (called by Maker).
|
Modifier and Type | Class and Description |
---|---|
class |
Destination
Class for named destinations in PDF.
|
Constructor and Description |
---|
Destination(FONode parent)
Constructs a Destination object (called by Maker).
|
Modifier and Type | Class and Description |
---|---|
class |
SVGElement
class representing the SVG root element
for constructing an svg document.
|
class |
SVGObj
Class for SVG element objects.
|
Constructor and Description |
---|
SVGElement(FONode parent)
Constructs an SVG object
|
SVGObj(FONode parent)
Constructs an SVG object (called by Maker).
|
Modifier and Type | Class and Description |
---|---|
class |
AbstractMetadataElement
Abstract base class for the XMP and RDF root nodes.
|
class |
RDFElement
Represents the top-level "RDF" element used by XMP metadata.
|
class |
XMPMetaElement
Represents the top-level "xmpmeta" element used by XMP metadata.
|
Constructor and Description |
---|
AbstractMetadataElement(FONode parent)
Main constructor.
|
RDFElement(FONode parent)
Main constructor.
|
XMPMetaElement(FONode parent)
Main constructor.
|
Modifier and Type | Class and Description |
---|---|
class |
AbstractGraphics
Common base class for instream-foreign-object and external-graphics
flow formatting objects.
|
class |
AbstractListItemPart
Common superclass for list-item-label and list-item-body.
|
class |
AbstractPageNumberCitation
Base class modelling the fo:page-number-citation object.
|
class |
BasicLink
Class modelling the fo:basic-link object.
|
class |
BidiOverride
Class modelling the fo:bidi-override object.
|
class |
Block
Class modelling the fo:block object.
|
class |
BlockContainer
Class modelling the fo:block-container object.
|
class |
Character
Class modelling the fo:character object.
|
class |
ExternalGraphic
Class modelling the
fo:external-graphic object. |
class |
Float
Class modelling the fo:float object.
|
class |
Footnote
Class modelling the fo:footnote object.
|
class |
FootnoteBody
Class modelling the fo:footnote-body object.
|
class |
InitialPropertySet
Class modelling the fo:initial-property-set object.
|
class |
Inline
Class modelling the fo:inline formatting object.
|
class |
InlineContainer
Class modelling the fo:inline-container object.
|
class |
InlineLevel
Class modelling the commonalities of several inline-level
formatting objects.
|
class |
InstreamForeignObject
Class modelling the fo:instream-foreign-object object.
|
class |
Leader
Class modelling fo:leader object.
|
class |
ListBlock
Class modelling the fo:list-block object.
|
class |
ListItem
Class modelling the fo:list-item object.
|
class |
ListItemBody
Class modelling the fo:list-item-body object.
|
class |
ListItemLabel
Class modelling the fo:list-item-label object.
|
class |
Marker
Class modelling the fo:marker object.
|
class |
MultiCase
Class modelling the fo:multi-case object.
|
class |
MultiProperties
Class modelling the fo:multi-properties object.
|
class |
MultiPropertySet
Class modelling the fo:multi-property-set object.
|
class |
MultiSwitch
Class modelling the fo:multi-switch object.
|
class |
MultiToggle
Class modelling the fo:multi-toggle property.
|
class |
PageNumber
Class modelling the fo:page-number object.
|
class |
PageNumberCitation
Class modelling the fo:page-number-citation object.
|
class |
PageNumberCitationLast
Class modelling the fo:page-number-citation-last object from XSL 1.1.
|
class |
RetrieveMarker
Class modelling the fo:retrieve-marker object.
|
class |
Wrapper
Class modelling the fo:wrapper object.
|
Modifier and Type | Method and Description |
---|---|
void |
ListItem.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 |
Footnote.addChildNode(FONode child)
Adds a node as a child of this node.
|
protected Marker.MarkerPropertyList |
Marker.getPropertyListFor(FONode foNode)
retrieve the property list of foNode
|
Constructor and Description |
---|
AbstractGraphics(FONode parent)
constructs an instream-foreign-object object (called by Maker).
|
AbstractListItemPart(FONode parent) |
AbstractPageNumberCitation(FONode parent) |
BasicLink(FONode parent) |
BidiOverride(FONode parent) |
Block(FONode parent) |
BlockContainer(FONode parent) |
Character(FONode parent) |
ExternalGraphic(FONode parent)
Create a new External graphic node.
|
Float(FONode parent) |
Footnote(FONode parent) |
FootnoteBody(FONode parent) |
InitialPropertySet(FONode parent) |
Inline(FONode parent) |
InlineContainer(FONode parent) |
InlineLevel(FONode parent) |
InstreamForeignObject(FONode parent)
constructs an instream-foreign-object object (called by Maker).
|
Leader(FONode parent) |
ListBlock(FONode parent) |
ListItem(FONode parent) |
ListItemBody(FONode parent) |
ListItemLabel(FONode parent) |
Marker(FONode parent)
Create a marker fo.
|
MultiCase(FONode parent) |
MultiProperties(FONode parent) |
MultiPropertySet(FONode parent) |
MultiSwitch(FONode parent) |
MultiToggle(FONode parent) |
PageNumber(FONode parent) |
PageNumberCitation(FONode parent)
Main constructor
|
PageNumberCitationLast(FONode parent)
Main constructor
|
RetrieveMarker(FONode parent)
Create a retrieve marker object.
|
Wrapper(FONode parent) |
Modifier and Type | Class and Description |
---|---|
class |
Table
Class modelling the fo:table object.
|
class |
TableAndCaption
Class modelling the fo:table-and-caption property.
|
class |
TableBody
Class modelling the fo:table-body object.
|
class |
TableCaption
Class modelling the fo:table-caption object.
|
class |
TableCell
Class modelling the fo:table-cell object.
|
class |
TableCellContainer
A common class for fo:table-body and fo:table-row which both can contain fo:table-cell.
|
class |
TableColumn
Class modelling the fo:table-column object.
|
class |
TableFObj
Common base class for table-related FOs
|
class |
TableFooter
Class modelling the fo:table-footer object.
|
class |
TableHeader
Class modelling the fo:table-header object.
|
class |
TableRow
Class modelling the fo:table-row object.
|
Modifier and Type | Method and Description |
---|---|
FONode |
Table.clone(FONode parent,
boolean removeChildren)
Perform a shallow cloning operation,
set its parent, and optionally clean the list of child nodes
|
Modifier and Type | Method and Description |
---|---|
protected void |
TableBody.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 |
Table.addChildNode(FONode child)
Adds a node as a child of this node.
|
FONode |
Table.clone(FONode parent,
boolean removeChildren)
Perform a shallow cloning operation,
set its parent, and optionally clean the list of child nodes
|
Constructor and Description |
---|
Table(FONode parent) |
TableAndCaption(FONode parent) |
TableBody(FONode parent) |
TableCaption(FONode parent) |
TableCell(FONode parent) |
TableCellContainer(FONode parent) |
TableColumn(FONode parent) |
TableColumn(FONode parent,
boolean implicit) |
TableFObj(FONode parent)
Main constructor
|
TableFooter(FONode parent) |
TableHeader(FONode parent) |
TableRow(FONode parent) |
Modifier and Type | Class and Description |
---|---|
class |
AbstractPageSequence
Abstract base class for the fo:page-sequence formatting object and the fox:external-document
extension object.
|
class |
ColorProfile
The fo:color-profile formatting object.
|
class |
ConditionalPageMasterReference
A conditional-page-master-reference formatting object.
|
class |
Declarations
Declarations formatting object.
|
class |
Flow
Class modelling the fo:flow object.
|
class |
LayoutMasterSet
The layout-master-set formatting object.
|
class |
PageSequence
Abstract base implementation for page sequences.
|
class |
PageSequenceMaster
The page-sequence-master formatting object.
|
class |
PageSequenceWrapper
The fo:page-sequence-wrapper formatting object, first introduced
in the XSL 1.1 WD.
|
class |
Region
This is an abstract base class for pagination regions
|
class |
RegionAfter
The fo:region-after element.
|
class |
RegionBA
Abstract base class for fo:region-before and fo:region-after.
|
class |
RegionBefore
The fo:region-before element.
|
class |
RegionBody
The fo:region-body element.
|
class |
RegionEnd
The fo:region-end element.
|
class |
RegionSE
Abstract base class for fo:region-start and fo:region-end.
|
class |
RegionStart
The fo:region-start element.
|
class |
RepeatablePageMasterAlternatives
A repeatable-page-master-alternatives formatting object.
|
class |
RepeatablePageMasterReference
A repeatable-page-master-reference formatting object.
|
class |
Root
The fo:root formatting object.
|
class |
SideRegion
Common base class for side regions (before, after, start, end).
|
class |
SimplePageMaster
A simple-page-master formatting object.
|
class |
SinglePageMasterReference
A single-page-master-reference formatting object.
|
class |
StaticContent
Class modelling the fo:static-content object.
|
class |
Title
Class modelling the fo:title object.
|
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.
|
protected void |
Root.validateChildNode(org.xml.sax.Locator loc,
FONode child) |
Constructor and Description |
---|
AbstractPageSequence(FONode parent)
Create a page sequence FO node.
|
ColorProfile(FONode parent) |
ConditionalPageMasterReference(FONode parent) |
Declarations(FONode parent) |
Flow(FONode parent) |
LayoutMasterSet(FONode parent) |
PageSequence(FONode parent)
Create a page sequence FO node.
|
PageSequenceMaster(FONode parent) |
PageSequenceWrapper(FONode parent) |
Region(FONode parent) |
RegionAfter(FONode parent) |
RegionBA(FONode parent) |
RegionBefore(FONode parent) |
RegionBody(FONode parent) |
RegionEnd(FONode parent) |
RegionSE(FONode parent) |
RegionStart(FONode parent) |
RepeatablePageMasterAlternatives(FONode parent) |
RepeatablePageMasterReference(FONode parent) |
Root(FONode parent) |
SideRegion(FONode parent) |
SimplePageMaster(FONode parent) |
SinglePageMasterReference(FONode parent) |
StaticContent(FONode parent) |
Title(FONode parent) |
Modifier and Type | Class and Description |
---|---|
class |
Bookmark
The fo:bookmark formatting object, first introduced in the
XSL 1.1 WD.
|
class |
BookmarkTitle
The fo:bookmark-title formatting object, first introduced in the
XSL 1.1 WD.
|
class |
BookmarkTree
The fo:bookmark-tree formatting object, first introduced in the
XSL 1.1 WD.
|
Modifier and Type | Method and Description |
---|---|
protected void |
Bookmark.addChildNode(FONode obj)
Adds a node as a child of this node.
|
protected void |
BookmarkTree.addChildNode(FONode obj)
Adds a node as a child of this node.
|
Constructor and Description |
---|
Bookmark(FONode parent)
Create a new bookmark object.
|
BookmarkTitle(FONode parent)
Create a new BookmarkTitle object.
|
BookmarkTree(FONode parent) |
Modifier and Type | Method and Description |
---|---|
void |
LayoutManagerMapping.Maker.make(FONode node,
java.util.List lms) |
void |
LayoutManagerMapping.FOTextLayoutManagerMaker.make(FONode node,
java.util.List lms) |
void |
LayoutManagerMapping.InlineLayoutManagerMaker.make(FONode node,
java.util.List lms) |
void |
LayoutManagerMapping.FootnodeLayoutManagerMaker.make(FONode node,
java.util.List lms) |
void |
LayoutManagerMapping.InlineContainerLayoutManagerMaker.make(FONode node,
java.util.List lms) |
void |
LayoutManagerMapping.BasicLinkLayoutManagerMaker.make(FONode node,
java.util.List lms) |
void |
LayoutManagerMapping.BlockLayoutManagerMaker.make(FONode node,
java.util.List lms) |
void |
LayoutManagerMapping.LeaderLayoutManagerMaker.make(FONode node,
java.util.List lms) |
void |
LayoutManagerMapping.CharacterLayoutManagerMaker.make(FONode node,
java.util.List lms) |
void |
LayoutManagerMapping.ExternalGraphicLayoutManagerMaker.make(FONode node,
java.util.List lms) |
void |
LayoutManagerMapping.BlockContainerLayoutManagerMaker.make(FONode node,
java.util.List lms) |
void |
LayoutManagerMapping.ListItemLayoutManagerMaker.make(FONode node,
java.util.List lms) |
void |
LayoutManagerMapping.ListBlockLayoutManagerMaker.make(FONode node,
java.util.List lms) |
void |
LayoutManagerMapping.InstreamForeignObjectLayoutManagerMaker.make(FONode node,
java.util.List lms) |
void |
LayoutManagerMapping.PageNumberLayoutManagerMaker.make(FONode node,
java.util.List lms) |
void |
LayoutManagerMapping.PageNumberCitationLayoutManagerMaker.make(FONode node,
java.util.List lms) |
void |
LayoutManagerMapping.PageNumberCitationLastLayoutManagerMaker.make(FONode node,
java.util.List lms) |
void |
LayoutManagerMapping.TableLayoutManagerMaker.make(FONode node,
java.util.List lms) |
void |
LayoutManagerMapping.RetrieveMarkerLayoutManagerMaker.make(FONode node,
java.util.List lms) |
void |
LayoutManagerMapping.WrapperLayoutManagerMaker.make(FONode node,
java.util.List lms) |
LayoutManager |
LayoutManagerMaker.makeLayoutManager(FONode node)
Make a specific LayoutManager for the node.
|
LayoutManager |
LayoutManagerMapping.makeLayoutManager(FONode node)
Make a specific LayoutManager for the node.
|
void |
LayoutManagerMaker.makeLayoutManagers(FONode node,
java.util.List lms)
Make LayoutManagers for the node and add them to the list lms.
|
void |
LayoutManagerMapping.makeLayoutManagers(FONode node,
java.util.List lms)
Make LayoutManagers for the node and add them to the list lms.
|
Modifier and Type | Class and Description |
---|---|
class |
AbstractAFPExtensionObject
Base class for the AFP-specific extension elements.
|
class |
AFPElement
This class extends the org.apache.fop.extensions.ExtensionObj class.
|
class |
AFPPageSetupElement
Extension element for fox:ps-page-setup-code.
|
Constructor and Description |
---|
AbstractAFPExtensionObject(FONode parent,
java.lang.String name) |
AFPElement(FONode parent,
java.lang.String name)
Constructs an AFP object (called by Maker).
|
AFPPageSetupElement(FONode parent)
Main constructor
|
Modifier and Type | Class and Description |
---|---|
class |
AbstractPSCommentElement
Base postscript commment element class
|
class |
AbstractPSExtensionElement
Base class for the PostScript-specific extension elements.
|
class |
AbstractPSExtensionObject
Base class for the PostScript-specific extension elements.
|
class |
PSCommentAfterElement
Comment after element
|
class |
PSCommentBeforeElement
Comment before element
|
class |
PSPageSetupCodeElement
Extension element for fox:ps-page-setup-code.
|
class |
PSSetPageDeviceElement
Extension element for ps:ps-setpagedevice.
|
class |
PSSetupCodeElement
Extension element for fox:ps-setup-code.
|
Constructor and Description |
---|
AbstractPSCommentElement(FONode parent)
Default constructor
|
AbstractPSExtensionElement(FONode parent)
Default constructor
|
AbstractPSExtensionObject(FONode parent) |
PSCommentAfterElement(FONode parent)
Main constructor
|
PSCommentBeforeElement(FONode parent)
Main constructor
|
PSPageSetupCodeElement(FONode parent)
Main constructor
|
PSSetPageDeviceElement(FONode parent)
Main constructor
|
PSSetupCodeElement(FONode parent)
Main constructor
|
Copyright 1999-2008 The Apache Software Foundation. All Rights Reserved.