| java.lang.Object
 org.apache.fop.fo.FONode
org.apache.fop.fo.FObj
All known Subclasses: org.apache.fop.fo.pagination.bookmarks.BookmarkTitle, org.apache.fop.fo.flow.InitialPropertySet, org.apache.fop.fo.flow.Character, org.apache.fop.fo.flow.AbstractListItemPart, org.apache.fop.fo.pagination.RepeatablePageMasterReference, org.apache.fop.fo.pagination.PageSequence, org.apache.fop.fo.flow.MultiSwitch, org.apache.fop.fo.extensions.ExtensionObj, org.apache.fop.fo.pagination.RepeatablePageMasterAlternatives, org.apache.fop.fo.pagination.PageSequenceWrapper, org.apache.fop.fo.flow.AbstractGraphics, org.apache.fop.fo.FObjMixed, org.apache.fop.fo.flow.TableCaption, org.apache.fop.fo.pagination.PageSequenceMaster, org.apache.fop.fo.pagination.Root, org.apache.fop.fo.flow.TableFObj, org.apache.fop.fo.flow.Float, org.apache.fop.fo.pagination.ConditionalPageMasterReference, org.apache.fop.fo.pagination.SimplePageMaster, org.apache.fop.fo.flow.MultiProperties, org.apache.fop.fo.flow.MultiPropertySet, org.apache.fop.fo.flow.MultiCase, org.apache.fop.fo.flow.Footnote, org.apache.fop.fo.pagination.ColorProfile, org.apache.fop.fo.pagination.Region, org.apache.fop.fo.pagination.LayoutMasterSet, org.apache.fop.fo.flow.MultiToggle, org.apache.fop.fo.flow.PageNumber, org.apache.fop.fo.flow.BlockContainer, org.apache.fop.fo.pagination.Flow, org.apache.fop.fo.pagination.bookmarks.Bookmark, org.apache.fop.fo.pagination.SinglePageMasterReference, org.apache.fop.fo.flow.InlineContainer, org.apache.fop.fo.pagination.bookmarks.BookmarkTree, org.apache.fop.fo.flow.ListItem, org.apache.fop.fo.pagination.Declarations, org.apache.fop.fo.flow.TableAndCaption, org.apache.fop.fo.flow.PageNumberCitation, org.apache.fop.fo.flow.ListBlock, org.apache.fop.fo.flow.FootnoteBody,
| FObj | | abstract public class FObj extends FONode implements Constants(Code) | | Base class for representation of formatting objects and their processing.
|
| Inner Class :public class FObjIterator implements FONodeIterator | |
| Constructor Summary | |
| public | FObj(FONode parent)
Create a new formatting object. |
| Method Summary | |
| protected void | addChildNode(FONode child)
| | protected static void | addChildTo(FONode child, FObj parent)
| | public void | addExtensionAttachment(ExtensionAttachment attachment)
Add a new extension attachment to this FObj. | | public void | addForeignAttribute(QName attributeName, String value)
Adds a foreign attribute to this FObj. | | protected void | addMarker(Marker marker)
Add the marker to this formatting object. | | public void | bind(PropertyList pList)
Bind property values from the property list to the FO node. | | public FONode | clone(FONode parent, boolean removeChildren)
| | protected PropertyList | createPropertyList(PropertyList parent, FOEventHandler foEventHandler)
Create a default property list for this element. | | protected int | findAncestor(int ancestorID)
Convenience method for validity checking. | | public FObj | findNearestAncestorFObj()
Find the nearest parent, grandparent, etc. | | protected String | gatherContextInfo()
| | public boolean | generatesReferenceAreas()
Check if this formatting object generates reference areas. | | public FONodeIterator | getChildNodes()
| | public FONodeIterator | getChildNodes(FONode childNode)
| | public List | getExtensionAttachments()
the extension attachments of this FObj. | | public Map | getForeignAttributes()
| | public String | getId()
the "id" property. | | public boolean | getIsOutOfLineFODescendant()
Returns Out Of Line FO Descendant indicator. | | public Map | getMarkers()
| | public String | getNamespaceURI()
| | public String | getNormalNamespacePrefix()
| | public static PropertyMaker | getPropertyMakerFor(int propId)
Returns the PropertyMaker for a given property ID. | | public boolean | hasId()
| | public boolean | hasMarkers()
| | protected boolean | isBlockItem(String nsURI, String lName)
Convenience method for validity checking. | | protected boolean | isBlockOrInlineItem(String nsURI, String lName)
Convenience method for validity checking. | | protected boolean | isInlineItem(String nsURI, String lName)
Convenience method for validity checking. | | protected boolean | isNeutralItem(String nsURI, String lName)
Convenience method for validity checking. | | protected void | notifyChildRemoval(FONode node)
Notifies a FObj that one of it's children is removed. | | public void | processNode(String elementName, Locator locator, Attributes attlist, PropertyList pList)
| | public void | removeChild(FONode child)
| | protected void | startOfNode()
|
| firstChild | | protected FONode firstChild(Code) | | pointer to the descendant subtree
|
| FObj | | public FObj(FONode parent)(Code) | | Create a new formatting object.
All formatting object classes extend this class.
Parameters:
parent - the parent node |
| addChildTo | | protected static void addChildTo(FONode child, FObj parent) throws FOPException(Code) | | Used by RetrieveMarker during Marker-subtree cloning
Parameters:
child - the (cloned) child node
Parameters:
parent - the (cloned) parent node
throws:
FOPException - when the child could not be added to the parent |
| addExtensionAttachment | | public void addExtensionAttachment(ExtensionAttachment attachment)(Code) | | Add a new extension attachment to this FObj.
(see org.apache.fop.fo.FONode for details)
Parameters:
attachment - the attachment to add. |
| addForeignAttribute | | public void addForeignAttribute(QName attributeName, String value)(Code) | | Adds a foreign attribute to this FObj.
Parameters:
attributeName - the attribute name as a QName instance
Parameters:
value - the attribute value |
| addMarker | | protected void addMarker(Marker marker)(Code) | | Add the marker to this formatting object.
If this object can contain markers it checks that the marker
has a unique class-name for this object and that it is
the first child.
Parameters:
marker - Marker to add. |
| bind | | public void bind(PropertyList pList) throws FOPException(Code) | | Bind property values from the property list to the FO node.
Must be overridden in all FObj subclasses that have properties
applying to it.
Parameters:
pList - the PropertyList where the properties can be found.
throws:
FOPException - if there is a problem binding the values |
| findAncestor | | protected int findAncestor(int ancestorID)(Code) | | Convenience method for validity checking. Checks if the
current node has an ancestor of a given name.
Parameters:
ancestorID - ID of node name to check for (e.g., FO_ROOT) number of levels above FO where ancestor exists, -1 if not found |
| findNearestAncestorFObj | | public FObj findNearestAncestorFObj()(Code) | | Find the nearest parent, grandparent, etc. FONode that is also an FObj
FObj the nearest ancestor FONode that is an FObj |
| generatesReferenceAreas | | public boolean generatesReferenceAreas()(Code) | | Check if this formatting object generates reference areas.
true if generates reference areas |
| getChildNodes | | public FONodeIterator getChildNodes(FONode childNode)(Code) | | Return an iterator over the object's childNodes starting
at the passed-in node (= first call to iterator.next() will
return childNode)
Parameters:
childNode - First node in the iterator A ListIterator or null if childNode isn't a child ofthis FObj. |
| getExtensionAttachments | | public List getExtensionAttachments()(Code) | | the extension attachments of this FObj. |
| getForeignAttributes | | public Map getForeignAttributes()(Code) | | the map of foreign attributes |
| getIsOutOfLineFODescendant | | public boolean getIsOutOfLineFODescendant()(Code) | | Returns Out Of Line FO Descendant indicator.
true if Out of Line FO or Out Of Line descendant, false otherwise |
| getMarkers | | public Map getMarkers()(Code) | | the collection of Markers attached to this object |
| getPropertyMakerFor | | public static PropertyMaker getPropertyMakerFor(int propId)(Code) | | Returns the PropertyMaker for a given property ID.
Parameters:
propId - the property ID the requested Property Maker |
| hasId | | public boolean hasId()(Code) | | whether this object has an id set |
| hasMarkers | | public boolean hasMarkers()(Code) | | true if there are any Markers attached to this object |
| isBlockItem | | protected boolean isBlockItem(String nsURI, String lName)(Code) | | Convenience method for validity checking. Checks if the
incoming node is a member of the "%block;" parameter entity
as defined in Sect. 6.2 of the XSL 1.0 & 1.1 Recommendations
Parameters:
nsURI - namespace URI of incoming node
Parameters:
lName - local name (i.e., no prefix) of incoming node true if a member, false if not |
| isBlockOrInlineItem | | protected boolean isBlockOrInlineItem(String nsURI, String lName)(Code) | | Convenience method for validity checking. Checks if the
incoming node is a member of the "%block;" parameter entity
or "%inline;" parameter entity
Parameters:
nsURI - namespace URI of incoming node
Parameters:
lName - local name (i.e., no prefix) of incoming node true if a member, false if not |
| isInlineItem | | protected boolean isInlineItem(String nsURI, String lName)(Code) | | Convenience method for validity checking. Checks if the
incoming node is a member of the "%inline;" parameter entity
as defined in Sect. 6.2 of the XSL 1.0 & 1.1 Recommendations
Parameters:
nsURI - namespace URI of incoming node
Parameters:
lName - local name (i.e., no prefix) of incoming node true if a member, false if not |
| isNeutralItem | | protected boolean isNeutralItem(String nsURI, String lName)(Code) | | Convenience method for validity checking. Checks if the
incoming node is a member of the neutral item list
as defined in Sect. 6.2 of the XSL 1.0 & 1.1 Recommendations
Parameters:
nsURI - namespace URI of incoming node
Parameters:
lName - local name (i.e., no prefix) of incoming node true if a member, false if not |
| notifyChildRemoval | | protected void notifyChildRemoval(FONode node)(Code) | | Notifies a FObj that one of it's children is removed.
This method is subclassed by Block to clear the
firstInlineChild variable in case it doesn't generate
any areas (see addMarker()).
Parameters:
node - the node that was removed |
| Methods inherited from org.apache.fop.fo.FONode | protected void addCharacters(char[] data, int start, int end, PropertyList pList, Locator locator) throws FOPException(Code)(Java Doc)
protected void addChildNode(FONode child) throws FOPException(Code)(Java Doc)
protected static void attachSiblings(FONode precedingSibling, FONode followingSibling)(Code)(Java Doc)
protected void attributeError(String problem) throws ValidationException(Code)(Java Doc)
protected void attributeWarning(String problem)(Code)(Java Doc)
public void bind(PropertyList propertyList) throws FOPException(Code)(Java Doc)
protected boolean canHaveMarkers()(Code)(Java Doc)
public CharIterator charIterator()(Code)(Java Doc)
public FONode clone(FONode cloneparent, boolean removeChildren) throws FOPException(Code)(Java Doc)
protected Object clone()(Code)(Java Doc)
protected PropertyList createPropertyList(PropertyList pList, FOEventHandler foEventHandler) throws FOPException(Code)(Java Doc)
public static String decorateWithContextInfo(String text, FONode node)(Code)(Java Doc)
protected void endOfNode() throws FOPException(Code)(Java Doc)
protected static String errorText(Locator loc)(Code)(Java Doc)
protected String gatherContextInfo()(Code)(Java Doc)
public FONodeIterator getChildNodes()(Code)(Java Doc)
public FONodeIterator getChildNodes(FONode childNode)(Code)(Java Doc)
public ContentHandlerFactory getContentHandlerFactory()(Code)(Java Doc)
public String getContextInfo()(Code)(Java Doc)
public ExtensionAttachment getExtensionAttachment()(Code)(Java Doc)
public FOEventHandler getFOEventHandler()(Code)(Java Doc)
abstract public String getLocalName()(Code)(Java Doc)
public Locator getLocator()(Code)(Java Doc)
public static String getLocatorString(Locator loc)(Code)(Java Doc)
public Log getLogger()(Code)(Java Doc)
public String getName()(Code)(Java Doc)
public String getName(String prefix)(Code)(Java Doc)
public int getNameId()(Code)(Java Doc)
public String getNamespaceURI()(Code)(Java Doc)
public static String getNodeString(String namespaceURI, String localName)(Code)(Java Doc)
abstract public String getNormalNamespacePrefix()(Code)(Java Doc)
public FONode getParent()(Code)(Java Doc)
public Root getRoot()(Code)(Java Doc)
public FOUserAgent getUserAgent()(Code)(Java Doc)
protected boolean inMarker()(Code)(Java Doc)
protected void invalidChildError(Locator loc, String nsURI, String lName) throws ValidationException(Code)(Java Doc)
protected void invalidChildError(Locator loc, String nsURI, String lName, String ruleViolated) throws ValidationException(Code)(Java Doc)
protected void missingChildElementError(String contentModel) throws ValidationException(Code)(Java Doc)
protected void missingPropertyError(String propertyName) throws ValidationException(Code)(Java Doc)
protected void nodesOutOfOrderError(Locator loc, String tooLateNode, String tooEarlyNode) throws ValidationException(Code)(Java Doc)
public void processNode(String elementName, Locator locator, Attributes attlist, PropertyList pList) throws FOPException(Code)(Java Doc)
public void removeChild(FONode child)(Code)(Java Doc)
public void setLocator(Locator locator)(Code)(Java Doc)
protected void startOfNode() throws FOPException(Code)(Java Doc)
protected void tooManyNodesError(Locator loc, String nsURI, String lName) throws ValidationException(Code)(Java Doc)
protected void tooManyNodesError(Locator loc, String offendingNode) throws ValidationException(Code)(Java Doc)
protected void validateChildNode(Locator loc, String namespaceURI, String localName) throws ValidationException(Code)(Java Doc)
protected static String warningText(Locator loc)(Code)(Java Doc)
|
|
|