|
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.TableColumn
Class modelling the
fo:table-column object.
| Nested Class Summary |
| Nested classes inherited from class org.apache.fop.fo.flow.table.TableFObj |
TableFObj.ColumnNumberPropertyMaker |
| 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.FObj |
firstChild |
| Fields inherited from class org.apache.fop.fo.FONode |
FO_URI, FOX_URI, locator, log, parent, siblings |
| Constructor Summary | |
TableColumn(FONode parent)
Create a TableColumn instance with the given FONode
as parent. |
|
TableColumn(FONode parent,
boolean implicit)
Create a TableColumn instance with the given FONode
as parent |
|
| 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. |
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 |
getColumnNumber()
Get the value of the column-number property |
Length |
getColumnWidth()
Get a Length instance corresponding to the
column-width property. |
CommonBorderPaddingBackground |
getCommonBorderPaddingBackground()
Get the CommonBorderPaddingBackground instance
attached to this TableColumn. |
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 |
getNumberColumnsRepeated()
|
int |
getNumberColumnsSpanned()
|
Property |
getProperty(int propId)
Retrieve a property value through its Id; used by from-table-column() function |
boolean |
isImplicitColumn()
Indicates whether this table-column has been created as default column for this table in case no table-columns have been defined. |
protected void |
releasePropertyList()
Clear the reference to the PropertyList (retained for from-table-column()) |
protected void |
setColumnNumber(int columnNumber)
Used for setting the column-number for an implicit column |
void |
setColumnWidth(Length columnWidth)
Sets the column width. |
void |
startOfNode()
Called after processNode() is called. Subclasses can do additional processing. |
java.lang.String |
toString()
|
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: empty |
| Methods inherited from class org.apache.fop.fo.flow.table.TableFObj |
getBorderPrecedence, getPtr, getTable, processNode, setCollapsedBorders |
| Methods inherited from class java.lang.Object |
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
| Constructor Detail |
public TableColumn(FONode parent)
FONode
as parent.
parent - FONode that is the parent of this object
public TableColumn(FONode parent,
boolean implicit)
FONode
as parent
parent - FONode that is the parent of this objectimplicit - true if this table-column has automatically been created (does not
correspond to an explicit fo:table-column in the input document)| Method Detail |
public void bind(PropertyList pList)
throws FOPException
bind in class TableFObjFOPException
public void startOfNode()
throws FOPException
startOfNode in class FObjFOPException - FOP Exception
public 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 FONodeFOPException - if there's a problem during processing
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 CommonBorderPaddingBackground getCommonBorderPaddingBackground()
CommonBorderPaddingBackground instance
attached to this TableColumn.
getCommonBorderPaddingBackground in class TableFObjCommonBorderPaddingBackground instancepublic Length getColumnWidth()
Length instance corresponding to the
column-width property.
public void setColumnWidth(Length columnWidth)
columnWidth - the column widthpublic int getColumnNumber()
column-number property
protected void setColumnNumber(int columnNumber)
columnNumber - the number to setpublic int getNumberColumnsRepeated()
public int getNumberColumnsSpanned()
public java.lang.String getLocalName()
getLocalName in class FONodepublic int getNameId()
Constants class integer value of this node
getNameId in class FONodeConstants.FO_TABLE_COLUMNpublic boolean isImplicitColumn()
public java.lang.String toString()
toString in class FObj
public Property getProperty(int propId)
throws PropertyException
propId - the id for the property to retrieve
PropertyException - if there is a problem evaluating the propertyprotected void releasePropertyList()
|
fop 1.0 | ||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||||