|
fop 1.0 | ||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||||
java.lang.Objectorg.apache.fop.fo.FONode
org.apache.fop.fo.FObj
org.apache.fop.fo.pagination.bookmarks.Bookmark
Class modelling the
fo:bookmark object, first introduced in the
XSL 1.1 WD.
| Nested Class Summary |
| Nested classes inherited from class org.apache.fop.fo.FObj |
FObj.FObjIterator |
| Nested classes inherited from class org.apache.fop.fo.FONode |
FONode.FONodeIterator, FONode.GatherContextInfoFunction |
| Field Summary |
| Fields inherited from class org.apache.fop.fo.FObj |
firstChild |
| Fields inherited from class org.apache.fop.fo.FONode |
FO_URI, FOX_URI, locator, log, parent, siblings |
| Constructor Summary | |
Bookmark(FONode parent)
Create a new Bookmark object that is a child of the given FONode. |
|
| Method Summary | |
protected void |
addChildNode(FONode obj)
Adds a node as a child of this node. The default implementation of this method just ignores any child node being added. |
void |
bind(PropertyList pList)
Bind property values from the property list to the FO node. Must be overridden in all FObj subclasses that have properties applying to it. |
protected void |
endOfNode()
Primarily used for making final content model validation checks and/or informing the FOEventHandler that the end of this FO
has been reached.
The default implementation simply calls FONode.finalizeNode(), without
sending any event to the FOEventHandler.
Note: the recommended way to override this method in subclasses is super.endOfNode(); // invoke finalizeNode()
|
java.lang.String |
getBookmarkTitle()
Get the bookmark title for this bookmark |
java.util.ArrayList |
getChildBookmarks()
Get the child Bookmarks in an java.util.ArrayList. |
java.lang.String |
getExternalDestination()
Returns the value of the external-destination property. |
java.lang.String |
getInternalDestination()
Returns the value of the internal-destination property. |
java.lang.String |
getLocalName()
Returns the local name (i.e. without namespace prefix) of the node |
int |
getNameId()
Returns the Constants class integer value of this node |
boolean |
showChildItems()
Determines if this fo:bookmark's subitems should be initially displayed or hidden, based on the starting-state property set on this FO. |
protected void |
validateChildNode(org.xml.sax.Locator loc,
java.lang.String nsURI,
java.lang.String localName)
Checks to make sure, during SAX processing of input document, that the incoming node is valid for this (parent) node (e.g., checking to see that fo:table is not an immediate child of fo:root)
called from FOTreeBuilder.startElement(String, String, String, Attributes)
before constructing the child FObj.
XSL/FOP: (bookmark-title, bookmark*) |
| Methods inherited from class java.lang.Object |
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
| Constructor Detail |
public Bookmark(FONode parent)
FONode.
parent - the parent fo node| Method Detail |
public void bind(PropertyList pList)
throws FOPException
bind in class FObjpList - the PropertyList where the properties can be found.
FOPException - if there is a problem binding the values
protected void validateChildNode(org.xml.sax.Locator loc,
java.lang.String nsURI,
java.lang.String localName)
throws ValidationException
fo:table is not an immediate child of fo:root)
called from FOTreeBuilder.startElement(String, String, String, Attributes)
before constructing the child FObj.
validateChildNode in class FONodeloc - location in the FO source filensURI - namespace of incoming nodelocalName - name of the incoming node (without namespace prefix)
ValidationException - if incoming node not valid for parent
protected void endOfNode()
throws FOPException
FOEventHandler that the end of this FO
has been reached.
The default implementation simply calls FONode.finalizeNode(), without
sending any event to the FOEventHandler.
super.endOfNode(); // invoke finalizeNode()
getFOEventHandler().endXXX(); // send endOfNode() notification
endOfNode in class FONodeFOPException - if there's a problem during processingprotected void addChildNode(FONode obj)
addChildNode in class FObjpublic java.lang.String getBookmarkTitle()
public java.lang.String getInternalDestination()
public java.lang.String getExternalDestination()
public boolean showChildItems()
public java.util.ArrayList getChildBookmarks()
Bookmarks in an java.util.ArrayList.
ArrayList containing the child Bookmarkspublic java.lang.String getLocalName()
getLocalName in class FONodepublic int getNameId()
Constants class integer value of this node
getNameId in class FONodeConstants.FO_BOOKMARK
|
fop 1.0 | ||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||||