|
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.flow.table.TableFObj
org.apache.fop.fo.flow.table.Table
public class Table
Class modelling the
fo:table
object.
Nested Class Summary |
---|
Nested classes/interfaces inherited from class org.apache.fop.fo.flow.table.TableFObj |
---|
TableFObj.ColumnNumberPropertyMaker |
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 |
Fields inherited from class org.apache.fop.fo.FONode |
---|
FO_URI, FOX_URI, locator, log, parent, siblings |
Constructor Summary | |
---|---|
Table(FONode parent)
Construct a Table instance with the given FONode
as parent. |
Method Summary | |
---|---|
protected void |
addChildNode(FONode child)
Adds a node as a child of this node. |
void |
bind(PropertyList pList)
Bind property values from the property list to the FO 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 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. |
LengthRangeProperty |
getBlockProgressionDimension()
|
int |
getBorderCollapse()
|
LengthPairProperty |
getBorderSeparation()
|
int |
getBreakAfter()
|
int |
getBreakBefore()
|
TableColumn |
getColumn(int index)
Returns the column at the given index. |
ColumnNumberManager |
getColumnNumberManager()
Returns the encapsulated ColumnNumberManage instance. |
java.util.List |
getColumns()
Returns the list of table-column elements. |
CommonBorderPaddingBackground |
getCommonBorderPaddingBackground()
|
CommonMarginBlock |
getCommonMarginBlock()
|
LengthRangeProperty |
getInlineProgressionDimension()
|
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 |
getNumberOfColumns()
Returns the number of columns of this table. |
Length |
getOrphanContentLimit()
|
Table |
getTable()
Convenience method to returns a reference to the base Table instance. |
TableFooter |
getTableFooter()
|
TableHeader |
getTableHeader()
|
Length |
getWidowContentLimit()
|
boolean |
isAutoLayout()
|
boolean |
isSeparateBorderModel()
|
boolean |
mustKeepTogether()
Convenience method to check if a keep-together constraint is specified. |
boolean |
omitFooterAtBreak()
|
boolean |
omitHeaderAtBreak()
|
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 org.apache.fop.fo.flow.table.TableFObj |
---|
getBorderPrecedence, getPtr, processNode, setCollapsedBorders |
Methods inherited from class java.lang.Object |
---|
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public Table(FONode parent)
FONode
as parent.
parent
- FONode
that is the parent of this objectMethod Detail |
---|
public void bind(PropertyList pList) throws FOPException
bind
in class TableFObj
pList
- the PropertyList where the properties can be found.
FOPException
- if there is a problem binding the valuesprotected 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 parentprotected 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 FONode
FOPException
- if there's a problem during processingpublic void finalizeNode() throws FOPException
FOEventHandler
.
The method is called by the default FONode.endOfNode()
implementation.
finalizeNode
in class FONode
FOPException
- in case there was an errorprotected void addChildNode(FONode child) throws FOPException
addChildNode
in class FObj
child
- child node to be added to the childNodes of this node
FOPException
- if there's a problem during processingpublic Table getTable()
Table
instance.
getTable
in class TableFObj
public boolean isAutoLayout()
public java.util.List getColumns()
TableColumn
elements, may contain null elementspublic TableColumn getColumn(int index)
index
- index of the column to be retrieved, 0-based
public int getNumberOfColumns()
public TableHeader getTableHeader()
public TableFooter getTableFooter()
public boolean omitHeaderAtBreak()
public boolean omitFooterAtBreak()
public LengthRangeProperty getInlineProgressionDimension()
public LengthRangeProperty getBlockProgressionDimension()
public CommonMarginBlock getCommonMarginBlock()
public CommonBorderPaddingBackground getCommonBorderPaddingBackground()
getCommonBorderPaddingBackground
in class TableFObj
public int getBreakAfter()
getBreakAfter
in interface BreakPropertySet
public int getBreakBefore()
getBreakBefore
in interface BreakPropertySet
public KeepProperty getKeepWithNext()
public KeepProperty getKeepWithPrevious()
public KeepProperty getKeepTogether()
public boolean mustKeepTogether()
public int getBorderCollapse()
public boolean isSeparateBorderModel()
public LengthPairProperty getBorderSeparation()
public Length getWidowContentLimit()
public Length getOrphanContentLimit()
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_TABLE
public FONode clone(FONode parent, boolean removeChildren) throws FOPException
clone
in class FObj
parent
- the intended parent of the cloneremoveChildren
- if true, clean the list of child nodes
FOPException
- if there's a problem while cloning the nodepublic ColumnNumberManager getColumnNumberManager()
getColumnNumberManager
in interface ColumnNumberManagerHolder
ColumnNumberManager
instance
|
fop 1.0 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |