|
fop 0.94 | |||||||||
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.TableFObj
org.apache.fop.fo.flow.Table
public class Table
Class modelling the fo:table object.
Nested Class Summary |
---|
Nested classes/interfaces inherited from class org.apache.fop.fo.flow.TableFObj |
---|
TableFObj.PendingSpan |
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 |
Field Summary | |
---|---|
protected java.util.List |
columns
collection of columns in this table |
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)
|
Method Summary | |
---|---|
protected void |
addChildNode(FONode child)
Adds a node as a child of this node. |
protected void |
addDefaultColumn(Length colWidth,
int colNr)
Adds a default column to the columns list (called from TableBody.addChildNode() when the table has no explicit columns, and if processing the first row) |
void |
bind(PropertyList pList)
Bind property values from the property list to the FO node. |
FONode |
clone(FONode parent,
boolean removeChildren)
Perform a shallow cloning operation, set its parent, and optionally clean 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. |
protected void |
flagColumnIndices(int start,
int end)
Flags column indices from start to end ,
and updates the current column index. |
LengthRangeProperty |
getBlockProgressionDimension()
|
int |
getBorderCollapse()
|
LengthPairProperty |
getBorderSeparation()
|
int |
getBreakAfter()
|
int |
getBreakBefore()
|
java.util.List |
getColumns()
Returns the list of table-column elements. |
CommonBorderPaddingBackground |
getCommonBorderPaddingBackground()
|
CommonMarginBlock |
getCommonMarginBlock()
|
int |
getCurrentColumnIndex()
Returns the current column index of the Table |
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 |
Length |
getOrphanContentLimit()
|
TableBody |
getTableFooter()
|
TableBody |
getTableHeader()
|
Length |
getWidowContentLimit()
|
boolean |
isAutoLayout()
|
boolean |
isColumnNumberUsed(int colNr)
Checks if a certain column-number is already occupied |
boolean |
isSeparateBorderModel()
|
boolean |
mustKeepTogether()
Convenience method to check if a keep-together constraint is specified. |
boolean |
omitFooterAtBreak()
|
boolean |
omitHeaderAtBreak()
|
void |
setCurrentColumnIndex(int newIndex)
Sets the current column index of the given Table (used by ColumnNumberPropertyMaker.make() in case the column-number was explicitly specified) |
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 the this (parent) node (e.g., checking to see that fo:table is not an immediate child of fo:root) called within FObj constructor |
Methods inherited from class org.apache.fop.fo.flow.TableFObj |
---|
getBorderPrecedence, getTable |
Methods inherited from class java.lang.Object |
---|
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
protected java.util.List columns
Constructor Detail |
---|
public Table(FONode parent)
parent
- FONode that is the parent of this objectMethod Detail |
---|
public void bind(PropertyList pList) throws FOPException
FObj
bind
in class TableFObj
pList
- the PropertyList where the properties can be found.
FOPException
- if there is a problem binding the valuesFObj.bind(PropertyList)
protected void startOfNode() throws FOPException
FONode
startOfNode
in class FObj
FOPException
- FOP ExceptionFONode.startOfNode()
protected void validateChildNode(org.xml.sax.Locator loc, java.lang.String nsURI, java.lang.String localName) throws ValidationException
FONode
validateChildNode
in class FONode
loc
- location in the FO source filensURI
- namespace of incoming nodelocalName
- (e.g. "table" for "fo:table")
ValidationException
- if incoming node not valid for parentXSL Content Model: (marker*,table-column*,table-header?,table-footer?,table-body+)
protected void endOfNode() throws FOPException
FONode
endOfNode
in class FONode
FOPException
- if there's a problem during processingFONode.endOfNode()
protected void addChildNode(FONode child) throws FOPException
FONode
addChildNode
in class TableFObj
child
- child node to be added to the childNodes of this node
FOPException
- if there's a problem during processingFONode.addChildNode(FONode)
protected void addDefaultColumn(Length colWidth, int colNr) throws FOPException
colWidth
- the column's width (null if the default should be used)colNr
- the column-number from the cell
FOPException
- if there was an error creating the property listpublic boolean isAutoLayout()
public java.util.List getColumns()
TableColumn
elements, may contain null elementspublic TableBody getTableHeader()
public TableBody 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()
public int getBreakBefore()
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()
FONode
getLocalName
in class FONode
FONode.getLocalName()
public int getNameId()
FONode
getNameId
in class FONode
FONode.getNameId()
public int getCurrentColumnIndex()
getCurrentColumnIndex
in class TableFObj
public boolean isColumnNumberUsed(int colNr)
isColumnNumberUsed
in class TableFObj
colNr
- the column-number to check
public void setCurrentColumnIndex(int newIndex)
setCurrentColumnIndex
in class TableFObj
newIndex
- the new value for column indexprotected void flagColumnIndices(int start, int end)
TableFObj
start
to end
,
and updates the current column index.
Overridden for Table, TableBody, TableRow
flagColumnIndices
in class TableFObj
start
- start indexend
- end indexTableFObj.flagColumnIndices(int, int)
public FONode clone(FONode parent, boolean removeChildren) throws FOPException
FONode
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 nodeFONode.clone(FONode, boolean)
|
fop 0.94 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |