|
fop 2.2 | |||||||||
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.BlockContainer
public class BlockContainer
Class modelling the
fo:block-container
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 |
---|
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 | |
---|---|
BlockContainer(FONode parent)
Creates a new BlockContainer instance as a child of the given FONode . |
Method Summary | |
---|---|
void |
bind(PropertyList pList)
Bind property values from the property list to the FO node. |
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. |
boolean |
generatesReferenceAreas()
Check if this formatting object generates reference areas. |
LengthRangeProperty |
getBlockProgressionDimension()
|
Direction |
getBlockProgressionDirection()
Obtain block progression direction. |
int |
getBreakAfter()
|
int |
getBreakBefore()
|
Direction |
getColumnProgressionDirection()
Obtain column progression direction. |
CommonAbsolutePosition |
getCommonAbsolutePosition()
|
CommonBorderPaddingBackground |
getCommonBorderPaddingBackground()
|
CommonMarginBlock |
getCommonMarginBlock()
|
int |
getDisableColumnBalancing()
|
int |
getDisplayAlign()
|
boolean |
getExplicitWritingMode()
Obtain writing mode explicit indicator. |
LengthRangeProperty |
getInlineProgressionDimension()
|
Direction |
getInlineProgressionDirection()
Obtain inline progression direction. |
KeepProperty |
getKeepTogether()
|
KeepProperty |
getKeepWithNext()
|
KeepProperty |
getKeepWithPrevious()
|
java.lang.String |
getLocalName()
Returns the local name (i.e. |
int |
getNameId()
Returns the Constants class integer value of this node |
int |
getOverflow()
|
int |
getReferenceOrientation()
|
Direction |
getRowProgressionDirection()
Obtain row progression direction. |
Direction |
getShiftDirection()
Obtain (baseline) shift direction. |
int |
getSpan()
|
WritingMode |
getWritingMode()
Obtain writing mode. |
protected boolean |
isBidiBoundary(boolean propagate)
|
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 |
Constructor Detail |
---|
public BlockContainer(FONode parent)
FONode
.
parent
- FONode
that is the parent of this objectMethod Detail |
---|
public void bind(PropertyList pList) throws FOPException
bind
in class FObj
pList
- the PropertyList where the properties can be found.
FOPException
- if there is a problem binding the valuespublic void startOfNode() throws FOPException
startOfNode
in class FObj
FOPException
- FOP Exceptionprotected 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 FONode
loc
- 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 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
.
Note: the recommended way to override this method in subclasses is
super.endOfNode(); // invoke finalizeNode()
getFOEventHandler().endXXX(); // send endOfNode() notification
endOfNode
in class FONode
FOPException
- if there's a problem during processingpublic boolean generatesReferenceAreas()
FObj
generatesReferenceAreas
in class FObj
true
(BlockContainer can generate Reference Areas)public CommonAbsolutePosition getCommonAbsolutePosition()
CommonAbsolutePosition
public CommonMarginBlock getCommonMarginBlock()
CommonMarginBlock
public CommonBorderPaddingBackground getCommonBorderPaddingBackground()
CommonBorderPaddingBackground
public LengthRangeProperty getBlockProgressionDimension()
public int getDisplayAlign()
public int getBreakAfter()
getBreakAfter
in interface BreakPropertySet
public int getBreakBefore()
getBreakBefore
in interface BreakPropertySet
public KeepProperty getKeepWithNext()
public KeepProperty getKeepWithPrevious()
public KeepProperty getKeepTogether()
public LengthRangeProperty getInlineProgressionDimension()
public int getOverflow()
public int getReferenceOrientation()
public int getSpan()
public int getDisableColumnBalancing()
Constants.EN_TRUE
,
Constants.EN_FALSE
public Direction getInlineProgressionDirection()
getInlineProgressionDirection
in interface WritingModeTraitsGetter
public Direction getBlockProgressionDirection()
getBlockProgressionDirection
in interface WritingModeTraitsGetter
public Direction getColumnProgressionDirection()
getColumnProgressionDirection
in interface WritingModeTraitsGetter
public Direction getRowProgressionDirection()
getRowProgressionDirection
in interface WritingModeTraitsGetter
public Direction getShiftDirection()
getShiftDirection
in interface WritingModeTraitsGetter
public WritingMode getWritingMode()
getWritingMode
in interface WritingModeTraitsGetter
public boolean getExplicitWritingMode()
getExplicitWritingMode
in interface WritingModeTraitsGetter
public java.lang.String getLocalName()
getLocalName
in class FONode
public int getNameId()
Constants
class integer value of this node
getNameId
in class FONode
Constants.FO_BLOCK_CONTAINER
protected boolean isBidiBoundary(boolean propagate)
isBidiBoundary
in class FObj
|
fop 2.2 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |