org.docgene.model

Class XMLTableColumn

java.lang.Object

org.docgene.model.AbstractStyledElement

org.docgene.model.XMLTableCell

org.docgene.model.XMLTableColumn

All Implemented Interfaces:

Alignment, ParagraphElement, ParagraphElementParent, StyledElement

public class XMLTableColumn
extends XMLTableCell

Represent a table column.

Field Summary

Fields inherited from interface org.docgene.model.Alignment

CENTER, LEFT, RIGHT

Fields inherited from interface org.docgene.model.StyledElement

TYPE_NONE

Constructor Summary

Constructors

Constructor and Description
XMLTableColumn()

Method Summary

Modifier and Type	Method and Description
int	getColumnWidth() Return the column width (-1 is the width is not fixed)
java.lang.String	getDeclaration() Return the declaration ID of the element.
java.lang.String	getEffectiveWidth() Return the column effective width, if the width is specified for a column element.
boolean	hasEffectiveWidth() Return true if the column has an effective width.
boolean	hasWidth() Return true if the column has a specified width.
boolean	isRelativeWidth() Return true if the column width is relative (in %).
void	setEffectiveWidth(java.lang.String width) Set the column effective width, if the width is specified for a column element.
void	setWidth(int width, boolean relWidth) Set the column width.

Methods inherited from class org.docgene.model.XMLTableCell

addElement, getAlignment, getColor, getColSpan, getElements, getRowIndex, getRowSpan, hasAlignment, setAlignment, setColor, setColSpan, setElements, setRowSpan

Methods inherited from class org.docgene.model.AbstractStyledElement

getCustomStyles, getInlinedStyle, setCustomStyles, setInlinedStyle

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.docgene.model.ParagraphElementParent

countElements, getElement, getFirstElement, getLastElement, hasElements, isEmpty

Methods inherited from interface org.docgene.model.StyledElement

getStyle, hasInlinedStyle, setCustomStyles

Constructor Detail

XMLTableColumn

public XMLTableColumn()

Method Detail

getDeclaration

public java.lang.String getDeclaration()

Return the declaration ID of the element.

Specified by:

getDeclaration in interface StyledElement

Overrides:

getDeclaration in class XMLTableCell

Returns:

the declaration ID of the element

hasWidth

public boolean hasWidth()

Return true if the column has a specified width.

Returns:

true if the column has a specified width

setWidth

public void setWidth(int width,
                     boolean relWidth)

Set the column width.

Parameters:

width - the width

relWidth - true if the width is relative (in %)

getColumnWidth

public int getColumnWidth()

Return the column width (-1 is the width is not fixed)

Returns:

the column width

setEffectiveWidth

public void setEffectiveWidth(java.lang.String width)

Set the column effective width, if the width is specified for a column element. This will be the case if at least one column has a specified width.

Parameters:

width - the column effective width

hasEffectiveWidth

public boolean hasEffectiveWidth()

Return true if the column has an effective width. This will be the case if at least one column has a specified width.

Returns:

true if the column has an effective width

getEffectiveWidth

public java.lang.String getEffectiveWidth()

Return the column effective width, if the width is specified for a column element. This will be the case if at least one column has a specified width.

Returns:

the column effective width

isRelativeWidth

public boolean isRelativeWidth()

Return true if the column width is relative (in %).

Returns:

true if the column width is relative