|
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.FObj
org.apache.fop.fo.FObjMixed
org.apache.fop.fo.flow.Block
Class modelling the
fo:block object.
| Nested Class Summary |
| Nested classes inherited from class org.apache.fop.fo.FObj |
FObj.FObjIterator |
| Nested classes 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 |
| Fields inherited from class org.apache.fop.fo.FONode |
FO_URI, FOX_URI, locator, log, parent, siblings |
| Constructor Summary | |
Block(FONode parent)
Base constructor |
|
| Method Summary | |
void |
bind(PropertyList pList)
Bind property values from the property list to the FO node. Must be overridden in all FObj subclasses that have properties applying to it. |
CharIterator |
charIterator()
Returns a CharIterator over this FO's character content |
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()
|
int |
getBreakAfter()
|
int |
getBreakBefore()
|
java.awt.Color |
getColor()
|
CommonBorderPaddingBackground |
getCommonBorderPaddingBackground()
|
CommonFont |
getCommonFont()
|
CommonHyphenation |
getCommonHyphenation()
|
CommonMarginBlock |
getCommonMarginBlock()
|
CommonRelativePosition |
getCommonRelativePosition()
|
int |
getDisableColumnBalancing()
|
int |
getHyphenationKeep()
|
Numeric |
getHyphenationLadderCount()
|
int |
getIntrusionDisplace()
|
KeepProperty |
getKeepTogether()
|
KeepProperty |
getKeepWithNext()
|
KeepProperty |
getKeepWithPrevious()
|
Length |
getLastLineEndIndent()
|
int |
getLinefeedTreatment()
|
SpaceProperty |
getLineHeight()
|
int |
getLineHeightShiftAdjustment()
|
int |
getLineStackingStrategy()
|
java.lang.String |
getLocalName()
Returns the local name (i.e. without namespace prefix) of the node |
int |
getNameId()
Returns the Constants class integer value of this node |
int |
getOrphans()
|
java.lang.String |
getPtr()
Returns the value of the "foi:ptr" property, the internal structure pointer used for tagged PDF and other formats that support a structure tree in addition to paged content. |
int |
getSpan()
|
int |
getTextAlign()
|
int |
getTextAlignLast()
|
Length |
getTextIndent()
|
int |
getWhitespaceCollapse()
|
int |
getWhitespaceTreatment()
|
int |
getWidows()
|
int |
getWrapOption()
|
protected void |
startOfNode()
Called after processNode() is called. Subclasses can do additional processing. |
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.
XSL Content Model: marker* initial-property-set? (#PCDATA|%inline;|%block;)* Additionally: "An fo:bidi-override that is a descendant of an fo:leader or of the fo:inline child of an fo:footnote may not have block-level children, unless it has a nearer ancestor that is an fo:inline-container." |
| Methods inherited from class org.apache.fop.fo.FObjMixed |
addChildNode, characters, finalizeNode, handleWhiteSpaceFor |
| Methods inherited from class java.lang.Object |
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
| Constructor Detail |
public Block(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 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 FObjMixedFOPExceptionpublic CommonMarginBlock getCommonMarginBlock()
CommonMarginBlockpublic CommonBorderPaddingBackground getCommonBorderPaddingBackground()
CommonBorderPaddingBackgroundpublic CommonFont getCommonFont()
CommonFontpublic CommonHyphenation getCommonHyphenation()
CommonHyphenationpublic int getBreakAfter()
getBreakAfter in interface BreakPropertySetpublic java.lang.String getPtr()
getPtr in interface StructurePointerPropertySetpublic int getBreakBefore()
getBreakBefore in interface BreakPropertySetpublic Numeric getHyphenationLadderCount()
public KeepProperty getKeepWithNext()
public KeepProperty getKeepWithPrevious()
public KeepProperty getKeepTogether()
public int getOrphans()
public int getWidows()
public int getLineStackingStrategy()
public java.awt.Color getColor()
public SpaceProperty getLineHeight()
public int getSpan()
public int getTextAlign()
public int getTextAlignLast()
public Length getTextIndent()
public Length getLastLineEndIndent()
public int getWrapOption()
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 int getLinefeedTreatment()
public int getWhitespaceTreatment()
public int getWhitespaceCollapse()
public CommonRelativePosition getCommonRelativePosition()
CommonRelativePositionpublic int getHyphenationKeep()
public int getIntrusionDisplace()
public int getLineHeightShiftAdjustment()
public int getDisableColumnBalancing()
Constants#EN_TRUE, Constants#EN_FALSEpublic CharIterator charIterator()
CharIterator over this FO's character content
charIterator in class FObjMixedpublic java.lang.String getLocalName()
getLocalName in class FONodepublic int getNameId()
Constants class integer value of this node
getNameId in class FONodeConstants.FO_BLOCK
|
fop 1.0 | ||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||||