|
fop 1.1 | |||||||||
| 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.FObjMixed
org.apache.fop.fo.flow.InlineLevel
org.apache.fop.fo.flow.BasicLink
public class BasicLink
Class modelling the
fo:basic-link object.
This class contains the logic to determine the link represented by this FO,
and whether that link is external (uses a URI) or internal (an id
reference).
| Nested Class Summary |
|---|
| Nested classes/interfaces inherited from class org.apache.fop.fo.FObj |
|---|
FObj.FObjIterator |
| Nested classes/interfaces inherited from class org.apache.fop.fo.FONode |
|---|
FONode.FONodeIterator, FONode.GatherContextInfoFunction |
| Field Summary |
|---|
| Fields inherited from class org.apache.fop.fo.FObjMixed |
|---|
currentTextNode, lastFOTextProcessed |
| Fields inherited from class org.apache.fop.fo.FObj |
|---|
firstChild, lastChild |
| Fields inherited from class org.apache.fop.fo.FONode |
|---|
FO_URI, FOX_URI, locator, log, parent, siblings |
| Constructor Summary | |
|---|---|
BasicLink(FONode parent)
Construct a BasicLink instance with the given FONode
as its parent. |
|
| Method Summary | |
|---|---|
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. |
Length |
getAlignmentAdjust()
|
int |
getAlignmentBaseline()
|
Length |
getBaselineShift()
|
int |
getDominantBaseline()
|
java.lang.String |
getExternalDestination()
Get the value of the external-destination property. |
java.lang.String |
getInternalDestination()
Get the value of the internal-destination property. |
java.lang.String |
getLocalName()
Returns the local name (i.e. |
int |
getNameId()
Returns the Constants class integer value of this node |
int |
getShowDestination()
Get the value of the show-destination property. |
StructureTreeElement |
getStructureTreeElement()
Returns the element in the document's structure tree that corresponds to this instance. |
boolean |
hasExternalDestination()
Convenience method to check if this instance has an external destination |
boolean |
hasInternalDestination()
Convenience method to check if this instance has an internal destination. |
void |
setStructureTreeElement(StructureTreeElement structureTreeElement)
Sets the structure tree element. |
protected void |
startOfNode()
Called after processNode() is called. |
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. |
| Methods inherited from class org.apache.fop.fo.flow.InlineLevel |
|---|
getColor, getCommonAccessibility, getCommonBorderPaddingBackground, getCommonFont, getCommonMarginInline, getKeepWithNext, getKeepWithPrevious, getLineHeight, isDelimitedTextRangeBoundary |
| Methods inherited from class org.apache.fop.fo.FObjMixed |
|---|
addChildNode, characters, charIterator, finalizeNode, handleWhiteSpaceFor, removeChild |
| Methods inherited from class java.lang.Object |
|---|
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
| Constructor Detail |
|---|
public BasicLink(FONode parent)
FONode
as its parent.
parent - FONode that is the parent of this object| Method Detail |
|---|
public void bind(PropertyList pList)
throws FOPException
bind in class InlineLevelpList - the PropertyList where the properties can be found.
FOPException - if there is a problem binding the values
protected void startOfNode()
throws FOPException
startOfNode in class FObjFOPException - FOP Exception
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 FObjMixedFOPException - if there's a problem during processing
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 parentpublic Length getAlignmentAdjust()
public int getAlignmentBaseline()
public Length getBaselineShift()
public int getDominantBaseline()
public void setStructureTreeElement(StructureTreeElement structureTreeElement)
FONode
setStructureTreeElement in class FONodestructureTreeElement - set.public StructureTreeElement getStructureTreeElement()
getStructureTreeElement in interface StructureTreeElementHolderpublic java.lang.String getInternalDestination()
internal-destination property.
public java.lang.String getExternalDestination()
external-destination property.
public boolean hasInternalDestination()
true if this basic link has an internal destination;
false otherwisepublic boolean hasExternalDestination()
true if this basic link has an external destination;
false otherwisepublic int getShowDestination()
show-destination property.
public java.lang.String getLocalName()
getLocalName in class FONodepublic int getNameId()
Constants class integer value of this node
getNameId in class FONodeConstants.FO_BASIC_LINK
|
fop 1.1 | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||