|
fop 0.90alpha1 | ||||||||||
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
The fo:bookmark formatting object, first introduced in the XSL 1.1 WD. Prototype version only, subject to change as XSL 1.1 WD evolves.
Field Summary |
Fields inherited from class org.apache.fop.fo.FObj |
childNodes, markers |
Fields inherited from class org.apache.fop.fo.FONode |
FO_URI, locator, log, parent |
Constructor Summary | |
Bookmark(FONode parent)
Create a new bookmark object. |
Method Summary | |
protected void |
addChildNode(FONode obj)
Adds a node as a child of this node. |
void |
bind(PropertyList pList)
Bind property values from the property list to the FO node. |
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. |
java.lang.String |
getBookmarkTitle()
Get the bookmark title for this bookmark |
java.util.ArrayList |
getChildBookmarks()
|
java.lang.String |
getExternalDestination()
|
java.lang.String |
getInternalDestination()
|
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 the this (parent) node (e.g., checking to see that fo:table is not an immediate child of fo:root) called within FObj constructor |
Methods inherited from class org.apache.fop.fo.FObj |
addExtensionAttachment, addMarker, checkId, clone, createPropertyList, findAncestor, findNearestAncestorFObj, generatesReferenceAreas, getChildNodes, getChildNodes, getExtensionAttachments, getIsOutOfLineFODescendant, getMarkers, getNamespaceURI, getNormalNamespacePrefix, getPropertyMakerFor, hasMarkers, isBlockItem, isBlockOrInlineItem, isInlineItem, isNeutralItem, notifyChildRemoval, processNode, removeChild |
Methods inherited from class org.apache.fop.fo.FONode |
addCharacters, attributeError, attributeWarning, charIterator, clone, errorText, getExtensionAttachment, getFOEventHandler, getLocator, getLocatorString, getLogger, getName, getName, getNodeString, getParent, getRoot, getUserAgent, invalidChildError, invalidChildError, missingChildElementError, missingPropertyError, nodesOutOfOrderError, setLocator, startOfNode, tooManyNodesError, tooManyNodesError, warningText |
Methods inherited from class java.lang.Object |
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public Bookmark(FONode parent)
parent
- the parent fo nodeMethod Detail |
public void bind(PropertyList pList) throws FOPException
FObj
bind
in class FObj
pList
- the PropertyList where the properties can be found.
FOPException
- if there is a problem binding the valuesFObj.bind(PropertyList)
protected void validateChildNode(org.xml.sax.Locator loc, java.lang.String nsURI, java.lang.String localName) throws ValidationException
FONode
validateChildNode
in class FONode
loc
- location in the FO source filensURI
- namespace of incoming nodelocalName
- (e.g. "table" for "fo:table")
ValidationException
- if incoming node not valid for parentXSL/FOP: (bookmark-title, bookmark*)
protected void endOfNode() throws FOPException
FONode
endOfNode
in class FONode
FOPException
- if there's a problem during processingFONode.endOfNode()
protected void addChildNode(FONode obj)
FONode
addChildNode
in class FObj
FONode.addChildNode(FONode)
public java.lang.String getBookmarkTitle()
public java.lang.String getInternalDestination()
public java.lang.String getExternalDestination()
public boolean showChildItems()
public java.util.ArrayList getChildBookmarks()
public java.lang.String getLocalName()
FONode
getLocalName
in class FONode
FONode.getLocalName()
public int getNameId()
FONode
getNameId
in class FONode
FONode.getNameId()
|
fop 0.90alpha1 | ||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |