public class FOText extends FONode
FONode.FONodeIterator
Modifier and Type | Field and Description |
---|---|
char[] |
ca
the character array containing the text
|
int |
endIndex
The ending valid index of the ca array
to be processed.
|
int |
startIndex
The starting valid index of the ca array
to be processed.
|
Constructor and Description |
---|
FOText(FONode parent)
Creates a now FO text node.
|
Modifier and Type | Method and Description |
---|---|
protected void |
addCharacters(char[] data,
int start,
int end,
PropertyList list,
org.xml.sax.Locator locator)
Adds characters (does nothing here)
|
void |
bind(PropertyList pList)
Bind the given
PropertyList to this node
Does nothing by default. |
CharIterator |
charIterator() |
FONode |
clone(FONode parent,
boolean removeChildren)
Perform a shallow cloning operation,
set its parent, and optionally clean 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.
|
protected java.lang.String |
gatherContextInfo()
Gathers context information for the getContextInfo() method.
|
Block |
getAncestorBlock() |
Length |
getBaseLineShift() |
java.awt.Color |
getColor() |
CommonFont |
getCommonFont() |
CommonHyphenation |
getCommonHyphenation() |
KeepProperty |
getKeepTogether() |
Property |
getLetterSpacing() |
SpaceProperty |
getLineHeight() |
java.lang.String |
getLocalName()
Returns the local name (i.e.
|
FOText |
getNextFOTextThisBlock() |
java.lang.String |
getNormalNamespacePrefix() |
FOText |
getPrevFOTextThisBlock() |
CommonTextDecoration |
getTextDecoration() |
int |
getWhitespaceTreatment() |
Property |
getWordSpacing() |
int |
getWrapOption() |
static int |
isWordChar(char inputChar)
Determines whether the input char should be considered part of a
"word".
|
java.lang.String |
toString() |
boolean |
willCreateArea()
Check if this text node will create an area.
|
addChildNode, attachSiblings, attributeError, attributeWarning, canHaveMarkers, clone, createPropertyList, decorateWithContextInfo, errorText, getChildNodes, getChildNodes, getContentHandlerFactory, getContextInfo, getExtensionAttachment, getFOEventHandler, getLocator, getLocatorString, getLogger, getName, getName, getNameId, getNamespaceURI, getNodeString, getParent, getRoot, getUserAgent, inMarker, invalidChildError, invalidChildError, missingChildElementError, missingPropertyError, nodesOutOfOrderError, processNode, removeChild, setLocator, startOfNode, tooManyNodesError, tooManyNodesError, validateChildNode, validateChildNode, warningText
public char[] ca
public int startIndex
public int endIndex
public FOText(FONode parent)
parent
- FONode that is the parent of this objectprotected void addCharacters(char[] data, int start, int end, PropertyList list, org.xml.sax.Locator locator) throws FOPException
addCharacters
in class FONode
data
- array of characters containing text to be addedstart
- starting array element to addend
- ending array element to addlist
- currently applicable PropertyListlocator
- location in fo source file.FOPException
- if there's a problem during processingpublic FONode clone(FONode parent, boolean removeChildren) throws FOPException
clone
in class FONode
parent
- the intended parent of the cloneremoveChildren
- if true, clean the list of child nodesFOPException
- if there's a problem while cloning the nodepublic 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 FONode
pList
- the PropertyList
FOPException
- if there was an error when
processing the PropertyList
protected void endOfNode() throws FOPException
endOfNode
in class FONode
FOPException
- if there's a problem during processingpublic boolean willCreateArea()
public CharIterator charIterator()
charIterator
in class FONode
protected void createBlockPointers(Block ancestorBlock)
public FOText getPrevFOTextThisBlock()
public FOText getNextFOTextThisBlock()
public Block getAncestorBlock()
public static int isWordChar(char inputChar)
inputChar
- the character to be tested.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 class java.lang.Object
public java.lang.String getLocalName()
getLocalName
in class FONode
public java.lang.String getNormalNamespacePrefix()
getNormalNamespacePrefix
in class FONode
protected java.lang.String gatherContextInfo()
gatherContextInfo
in class FONode
Copyright 1999-2008 The Apache Software Foundation. All Rights Reserved.