|
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.FOText
A text node (PCDATA) in the formatting object tree.
| Nested Class Summary |
| Nested classes inherited from class org.apache.fop.fo.FONode |
FONode.FONodeIterator, FONode.GatherContextInfoFunction |
| Field Summary |
| Fields inherited from class org.apache.fop.fo.FONode |
FO_URI, FOX_URI, locator, log, parent, siblings |
| Constructor Summary | |
FOText(FONode parent)
Creates a new FO text node. |
|
| Method Summary | |
void |
bind(PropertyList pList)
Bind the given PropertyList to this node
Does nothing by default. Subclasses should override this method
in case they want to use the properties available on the
PropertyList. |
protected void |
characters(char[] data,
int start,
int length,
PropertyList list,
org.xml.sax.Locator locator)
Adds characters. Does nothing by default. To be overridden in subclasses that allow #PCDATA content. |
char |
charAt(int position)
|
CharIterator |
charIterator()
Return a CharIterator over all characters in this node |
FONode |
clone(FONode parent,
boolean removeChildren)
Performs a shallow cloning operation, sets the clone's parent, and optionally cleans the list of child nodes |
protected void |
createBlockPointers(Block ancestorBlock)
This method is run as part of the ancestor Block's flushText(), to create xref pointers to the previous FOText objects within the same Block |
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()
|
void |
finalizeNode()
Finalize this node. This method can be overridden by subclasses to perform finishing tasks (cleanup, validation checks, ...) without triggering endXXX() events in the FOEventHandler.
The method is called by the default FONode.endOfNode()
implementation. |
protected java.lang.String |
gatherContextInfo()
Gathers context information for the getContextInfo() method. |
Block |
getAncestorBlock()
|
Length |
getBaseLineShift()
|
char[] |
getCharArray()
Return the array of characters for this instance. |
java.awt.Color |
getColor()
|
CommonFont |
getCommonFont()
|
CommonHyphenation |
getCommonHyphenation()
|
KeepProperty |
getKeepTogether()
|
Property |
getLetterSpacing()
|
SpaceProperty |
getLineHeight()
|
java.lang.String |
getLocalName()
Returns the local name (i.e. without namespace prefix) of the node |
FOText |
getNextFOTextThisBlock()
|
java.lang.String |
getNormalNamespacePrefix()
Returns the normally used namespace prefix for this node |
FOText |
getPrevFOTextThisBlock()
|
CommonTextDecoration |
getTextDecoration()
|
int |
getWhitespaceTreatment()
|
Property |
getWordSpacing()
|
int |
getWrapOption()
|
int |
length()
|
void |
resetBuffer()
Resets the backing java.nio.CharBuffer |
java.lang.CharSequence |
subSequence(int start,
int end)
|
java.lang.String |
toString()
|
boolean |
willCreateArea()
Check if this text node will create an area. |
| Methods inherited from class java.lang.Object |
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
| Constructor Detail |
public FOText(FONode parent)
parent - FONode that is the parent of this object| Method Detail |
protected void characters(char[] data,
int start,
int length,
PropertyList list,
org.xml.sax.Locator locator)
throws FOPException
#PCDATA content.
characters in class FONodedata - array of characters containing text to be addedstart - starting array element to addlength - number of elements to addlist - currently applicable PropertyListlocator - location in the XSL-FO source file.
FOPException - if there's a problem during processingpublic char[] getCharArray()
public FONode clone(FONode parent,
boolean removeChildren)
throws FOPException
clone in class FONodeparent - the intended parent of the cloneremoveChildren - if true, clean the list of child nodes
FOPException - if there's a problem while cloning the node
public void bind(PropertyList pList)
throws FOPException
PropertyList to this node
Does nothing by default. Subclasses should override this method
in case they want to use the properties available on the
PropertyList.
bind in class FONodepList - the PropertyList
FOPException - if there was an error when
processing the PropertyList
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 processingpublic void finalizeNode()
FOEventHandler.
The method is called by the default FONode.endOfNode()
implementation.
finalizeNode in class FONodepublic boolean willCreateArea()
public CharIterator charIterator()
FONodeCharIterator over all characters in this node
charIterator in class FONodeprotected void createBlockPointers(Block ancestorBlock)
ancestorBlock - the ancestor fo:blockpublic FOText getPrevFOTextThisBlock()
public FOText getNextFOTextThisBlock()
public Block getAncestorBlock()
public CommonFont getCommonFont()
public CommonHyphenation getCommonHyphenation()
public java.awt.Color getColor()
public KeepProperty getKeepTogether()
public Property getLetterSpacing()
public SpaceProperty getLineHeight()
public int getWhitespaceTreatment()
public Property getWordSpacing()
public int getWrapOption()
public CommonTextDecoration getTextDecoration()
public Length getBaseLineShift()
public java.lang.String toString()
toString in interface java.lang.CharSequencepublic java.lang.String getLocalName()
getLocalName in class FONodepublic java.lang.String getNormalNamespacePrefix()
getNormalNamespacePrefix in class FONodeprotected java.lang.String gatherContextInfo()
gatherContextInfo in class FONodepublic char charAt(int position)
charAt in interface java.lang.CharSequence
public java.lang.CharSequence subSequence(int start,
int end)
subSequence in interface java.lang.CharSequencepublic int length()
length in interface java.lang.CharSequencepublic void resetBuffer()
java.nio.CharBuffer
|
fop 1.0 | ||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||||