|
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.flow.Character
public class Character
Class modelling the
fo:character object.
| 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 | |
|---|---|
static int |
DOESNOT_FIT
constant indicating that the character does not fit |
static int |
OK
constant indicating that the character is OK |
| 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 | |
|---|---|
Character(FONode parent)
|
|
| Method Summary | |
|---|---|
void |
bind(PropertyList pList)
Bind property values from the property list to the FO node. |
CharIterator |
charIterator()
Return a CharIterator over all characters in this node |
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. |
Length |
getAlignmentAdjust()
|
int |
getAlignmentBaseline()
|
Length |
getBaselineShift()
|
char |
getCharacter()
|
java.awt.Color |
getColor()
|
CommonBorderPaddingBackground |
getCommonBorderPaddingBackground()
|
CommonFont |
getCommonFont()
|
CommonHyphenation |
getCommonHyphenation()
|
int |
getDominantBaseline()
|
KeepProperty |
getKeepWithNext()
|
KeepProperty |
getKeepWithPrevious()
|
Property |
getLetterSpacing()
|
SpaceProperty |
getLineHeight()
|
java.lang.String |
getLocalName()
Returns the local name (i.e. |
int |
getNameId()
Returns the Constants class integer value of this node |
StructureTreeElement |
getStructureTreeElement()
Returns the element in the document's structure tree that corresponds to this instance. |
CommonTextDecoration |
getTextDecoration()
|
Property |
getWordSpacing()
|
boolean |
isDelimitedTextRangeBoundary(int boundary)
Determine if node has a delimited text range boundary. |
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 java.lang.Object |
|---|
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
| Field Detail |
|---|
public static final int OK
public static final int DOESNOT_FIT
| Constructor Detail |
|---|
public Character(FONode parent)
parent - FONode that is the parent of this object| Method Detail |
|---|
public void bind(PropertyList pList)
throws FOPException
bind in class FObjpList - 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 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 CharIterator charIterator()
CharIterator over all characters in this node
charIterator in class FONodepublic CommonBorderPaddingBackground getCommonBorderPaddingBackground()
public CommonFont getCommonFont()
public CommonHyphenation getCommonHyphenation()
public char getCharacter()
public java.awt.Color getColor()
public Length getAlignmentAdjust()
public int getAlignmentBaseline()
public Length getBaselineShift()
public int getDominantBaseline()
public Property getLetterSpacing()
public SpaceProperty getLineHeight()
public CommonTextDecoration getTextDecoration()
public Property getWordSpacing()
public KeepProperty getKeepWithNext()
public KeepProperty getKeepWithPrevious()
public void setStructureTreeElement(StructureTreeElement structureTreeElement)
FONode
setStructureTreeElement in class FONodestructureTreeElement - set.public StructureTreeElement getStructureTreeElement()
getStructureTreeElement in interface StructureTreeElementHolderpublic java.lang.String getLocalName()
getLocalName in class FONodepublic int getNameId()
Constants class integer value of this node
getNameId in class FONodeConstants.FO_CHARACTERpublic boolean isDelimitedTextRangeBoundary(int boundary)
FONode
isDelimitedTextRangeBoundary in class FONodeboundary - one of {EN_BEFORE, EN_AFTER, or EN_BOTH} enumeration constants
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 | |||||||||