|
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.FOText
public class FOText
A text node (PCDATA) in the formatting object tree.
| Nested Class Summary |
|---|
| 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.FONode |
|---|
FO_URI, FOX_URI, locator, log, parent, siblings |
| Constructor Summary | |
|---|---|
FOText(FONode parent)
Creates a new FO text node. |
|
| Method Summary | |
|---|---|
void |
addMapping(int start,
int end,
java.lang.CharSequence mappedChars)
Add characters mapped by script substitution processing. |
int |
bidiLevelAt(int position)
Obtain bidirectional level of character at specified position, which must be a non-negative integer less than the length of this FO. |
void |
bind(PropertyList pList)
Bind the given PropertyList to this node
Does nothing by default. |
protected void |
characters(char[] data,
int start,
int length,
PropertyList list,
org.xml.sax.Locator locator)
Adds characters. |
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 java.util.Stack |
collectDelimitedTextRanges(java.util.Stack ranges,
DelimitedTextRange currentRange)
Collect the sequence of delimited text ranges, where each new range is pushed onto RANGES, where default implementation collects ranges 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. |
void |
finalizeNode()
Finalize this node. |
protected java.lang.String |
gatherContextInfo()
Gathers context information for the getContextInfo() method. |
Length |
getBaseLineShift()
|
int[] |
getBidiLevels()
Obtain bidirectional level of each character represented by this FOText. |
int[] |
getBidiLevels(int start,
int end)
Obtain bidirectional level of each character over interval [start,end). |
java.lang.CharSequence |
getCharSequence()
Return the array of characters for this instance. |
java.awt.Color |
getColor()
|
CommonFont |
getCommonFont()
|
CommonHyphenation |
getCommonHyphenation()
|
java.lang.String |
getCountry()
|
KeepProperty |
getKeepTogether()
|
java.lang.String |
getLanguage()
|
Property |
getLetterSpacing()
|
SpaceProperty |
getLineHeight()
|
java.lang.String |
getLocalName()
Returns the local name (i.e. |
java.lang.String |
getMapping(int start,
int end)
Obtain mapping of characters over specific interval. |
int[] |
getMappingBidiLevels(int start,
int end)
Obtain bidirectional levels of mapping of characters over specific interval. |
int |
getMappingLength(int start,
int end)
Obtain length of mapping of characters over specific interval. |
java.lang.String |
getNormalNamespacePrefix()
Returns the normally used namespace prefix for this node |
java.lang.String |
getScript()
|
StructureTreeElement |
getStructureTreeElement()
|
CommonTextDecoration |
getTextDecoration()
|
int |
getWhitespaceTreatment()
|
Property |
getWordSpacing()
|
int |
getWrapOption()
|
boolean |
hasMapping(int start,
int end)
Determine if characters over specific interval have a mapping. |
boolean |
isDelimitedTextRangeBoundary(int boundary)
Determine if node has a delimited text range boundary. |
int |
length()
|
void |
resetBuffer()
Resets the backing java.nio.CharBuffer |
void |
setBidiLevel(int level,
int start,
int end)
Set bidirectional level over interval [start,end). |
void |
setStructureTreeElement(StructureTreeElement structureTreeElement)
Sets the structure tree element. |
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 java.lang.CharSequence getCharSequence()
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 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 getCountry()
public java.lang.String getLanguage()
public java.lang.String getScript()
public java.lang.String toString()
toString in interface java.lang.CharSequencetoString in class java.lang.Objectpublic 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
public boolean isDelimitedTextRangeBoundary(int boundary)
FONode
isDelimitedTextRangeBoundary in class FONodeboundary - one of {EN_BEFORE, EN_AFTER, or EN_BOTH} enumeration constants
public void setStructureTreeElement(StructureTreeElement structureTreeElement)
FONode
setStructureTreeElement in class FONodestructureTreeElement - set.public StructureTreeElement getStructureTreeElement()
public void setBidiLevel(int level,
int start,
int end)
level - the resolved levelstart - the starting index of intervalend - the ending index of intervalpublic int[] getBidiLevels()
public int[] getBidiLevels(int start,
int end)
start - the starting index of intervalend - the ending index of interval
public int bidiLevelAt(int position)
throws java.lang.IndexOutOfBoundsException
position - an offset position into FO's characters
java.lang.IndexOutOfBoundsException - if position is not non-negative integer
or is greater than or equal to length
public void addMapping(int start,
int end,
java.lang.CharSequence mappedChars)
start - index in character bufferend - index in character buffermappedChars - sequence of character codes denoting substituted characters
public boolean hasMapping(int start,
int end)
start - index in character bufferend - index in character buffer
public java.lang.String getMapping(int start,
int end)
start - index in character bufferend - index in character buffer
public int getMappingLength(int start,
int end)
start - index in character bufferend - index in character buffer
public int[] getMappingBidiLevels(int start,
int end)
start - index in character bufferend - index in character buffer
protected java.util.Stack collectDelimitedTextRanges(java.util.Stack ranges,
DelimitedTextRange currentRange)
FONode
collectDelimitedTextRanges in class FONoderanges - a stack of delimited text rangescurrentRange - the current range or null (if none)
|
fop 1.1 | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||