|
fop 0.91beta | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--org.apache.fop.fo.FONode | +--org.apache.fop.fo.FObj
Base class for representation of formatting objects and their processing.
Field Summary | |
protected java.util.List |
childNodes
The immediate child nodes of this node. |
protected java.util.Map |
markers
Markers added to this element. |
Fields inherited from class org.apache.fop.fo.FONode |
FO_URI, locator, log, parent |
Constructor Summary | |
FObj(FONode parent)
Create a new formatting object. |
Method Summary | |
protected void |
addChildNode(FONode child)
Adds a node as a child of this node. |
void |
addExtensionAttachment(ExtensionAttachment attachment)
Add a new extension attachment to this FObj. |
protected void |
addMarker(Marker marker)
Add the marker to this formatting object. |
void |
bind(PropertyList pList)
Bind property values from the property list to the FO node. |
protected void |
checkId(java.lang.String id)
Setup the id for this formatting object. |
FONode |
clone(FONode parent,
boolean removeChildren)
Perform a shallow cloning operation, set its parent, and optionally clean the list of child nodes |
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. |
FObj |
findNearestAncestorFObj()
Find the nearest parent, grandparent, etc. |
protected java.lang.String |
gatherContextInfo()
Gathers context information for the getContextInfo() method. |
boolean |
generatesReferenceAreas()
Check if this formatting object generates reference areas. |
java.util.ListIterator |
getChildNodes()
Return an iterator over all the child nodes of this FObj. |
java.util.ListIterator |
getChildNodes(FONode childNode)
Return an iterator over the object's childNodes starting at the passed-in node. |
java.util.List |
getExtensionAttachments()
|
boolean |
getIsOutOfLineFODescendant()
Returns Out Of Line FO Descendant indicator. |
java.util.Map |
getMarkers()
|
java.lang.String |
getNamespaceURI()
|
java.lang.String |
getNormalNamespacePrefix()
|
static PropertyMaker |
getPropertyMakerFor(int propId)
Returns the PropertyMaker for a given property ID. |
boolean |
hasMarkers()
|
protected boolean |
isBlockItem(java.lang.String nsURI,
java.lang.String lName)
Convenience method for validity checking. |
protected boolean |
isBlockOrInlineItem(java.lang.String nsURI,
java.lang.String lName)
Convenience method for validity checking. |
protected boolean |
isInlineItem(java.lang.String nsURI,
java.lang.String lName)
Convenience method for validity checking. |
protected boolean |
isNeutralItem(java.lang.String nsURI,
java.lang.String lName)
Convenience method for validity checking. |
protected void |
notifyChildRemoval(FONode node)
Notifies a FObj that one of it's children is removed. |
void |
processNode(java.lang.String elementName,
org.xml.sax.Locator locator,
org.xml.sax.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 |
removeChild(FONode child)
Removes a child node. |
Methods inherited from class java.lang.Object |
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
protected java.util.List childNodes
protected java.util.Map markers
Constructor Detail |
public FObj(FONode parent)
parent
- the parent nodeMethod Detail |
public FONode clone(FONode parent, boolean removeChildren) throws FOPException
FONode
clone
in class FONode
FONode.clone(FONode, boolean)
public static PropertyMaker getPropertyMakerFor(int propId)
propId
- the property IDpublic void processNode(java.lang.String elementName, org.xml.sax.Locator locator, org.xml.sax.Attributes attlist, PropertyList pList) throws FOPException
FONode
processNode
in class FONode
FONode.processNode(java.lang.String, org.xml.sax.Locator, org.xml.sax.Attributes, org.apache.fop.fo.PropertyList)
protected PropertyList createPropertyList(PropertyList parent, FOEventHandler foEventHandler) throws FOPException
createPropertyList
in class FONode
FONode
public void bind(PropertyList pList) throws FOPException
pList
- the PropertyList where the properties can be found.FOPException
- if there is a problem binding the valuesprotected void checkId(java.lang.String id) throws ValidationException
id
- ID to checkValidationException
- if the ID is already defined elsewherepublic boolean getIsOutOfLineFODescendant()
protected void addChildNode(FONode child) throws FOPException
FONode
addChildNode
in class FONode
FONode.addChildNode(FONode)
public void removeChild(FONode child)
FONode
removeChild
in class FONode
FONode.removeChild(org.apache.fop.fo.FONode)
public FObj findNearestAncestorFObj()
public boolean generatesReferenceAreas()
public java.util.ListIterator getChildNodes()
FONode
getChildNodes
in class FONode
FONode.getChildNodes()
public java.util.ListIterator getChildNodes(FONode childNode)
getChildNodes
in class FONode
childNode
- First node in the iteratorprotected void notifyChildRemoval(FONode node)
node
- the node that was removedprotected void addMarker(Marker marker)
marker
- Marker to add.public boolean hasMarkers()
public java.util.Map getMarkers()
protected java.lang.String gatherContextInfo()
FONode
gatherContextInfo
in class FONode
FONode.gatherContextInfo()
protected boolean isBlockItem(java.lang.String nsURI, java.lang.String lName)
nsURI
- namespace URI of incoming nodelName
- local name (i.e., no prefix) of incoming nodeprotected boolean isInlineItem(java.lang.String nsURI, java.lang.String lName)
nsURI
- namespace URI of incoming nodelName
- local name (i.e., no prefix) of incoming nodeprotected boolean isBlockOrInlineItem(java.lang.String nsURI, java.lang.String lName)
nsURI
- namespace URI of incoming nodelName
- local name (i.e., no prefix) of incoming nodeprotected boolean isNeutralItem(java.lang.String nsURI, java.lang.String lName)
nsURI
- namespace URI of incoming nodelName
- local name (i.e., no prefix) of incoming nodeprotected int findAncestor(int ancestorID)
ancestorID
- -- Constants ID of node name to check for (e.g., FO_ROOT)public java.lang.String getNamespaceURI()
getNamespaceURI
in class FONode
FONode.getNamespaceURI()
public java.lang.String getNormalNamespacePrefix()
getNormalNamespacePrefix
in class FONode
FONode.getNormalNamespacePrefix()
public void addExtensionAttachment(ExtensionAttachment attachment)
attachment
- the attachment to add.public java.util.List getExtensionAttachments()
|
fop 0.91beta | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |