org.docgene.model

Class XMLTableRow

java.lang.Object

org.docgene.model.AbstractStyledElement

org.docgene.model.XMLTableRow

All Implemented Interfaces:

org.docgene.model.conditions.ConditionElement<XMLTableRow>, ParagraphElement, StyledElement

Direct Known Subclasses:

XMLSizedTableRow

public class XMLTableRow
extends org.docgene.model.AbstractStyledElement
implements org.docgene.model.conditions.ConditionElement<XMLTableRow>

Represent a Table Row.

Field Summary

Fields inherited from interface org.docgene.model.StyledElement

TYPE_NONE

Constructor Summary

Constructors

Constructor and Description
XMLTableRow()

Method Summary

Modifier and Type	Method and Description
int	addCell(XMLTableCell cell) Add a cell to the table row.
XMLTableCell	addEmptyCell() Add an empty cell to the table row.
int	countCells() Return the number of cells.
short	getBottomBorderType() Return the bottom border type.
XMLTableCell	getCell(int index) Return the cell at a specified index.
java.util.List<XMLTableCell>	getCells() Return the cells in the table row.
java.lang.String	getColor() Return the row background color.
java.util.List<XMLTableRow>	getConditionElementsList() Return the list of elements for a condition.
XMLTableRow	getConditionUniqueElement() Return the unique element for a condition.
java.lang.String	getDeclaration() Return the declaration ID of the element.
short	getTopBorderType() Return the top border type.
int	getWidth(int cellIndex) Return the specified width for one cell.
java.util.List<java.lang.Integer>	getWidths() Return the row specified widths for its cells.
boolean	hasBorders() Return true if the table cells of the row have borders.
boolean	hasHorizontalBorders() Return true if the table cells of the row have horizontal borders.
boolean	hasNoBorders() Return true if the table cells of the row have no borders.
boolean	hasUniqueElement() Return true.
boolean	hasVerticalBorders() Return true if the table cells of the row have vertical borders.
boolean	hasWidth(int cellIndex) Return true if the row has a specified width for one cell.
boolean	hasWidths() Return true if the row has specified widths for its cells.
boolean	isRelativeWidth() Return true if the row widths are relative (in %).
void	setBorders(boolean hasBorders) Set if the table cells of the row have borders.
void	setBottomBorderType(short borderType) Set the bottom border type.
void	setColor(java.lang.String color) Set the row background color.
void	setHorizontalBorders(boolean hasHorizontalBorders) Set if the table cells of the row have horizontal borders.
void	setTopBorderType(short borderType) Set the top border type.
void	setVerticalBorders(boolean hasVerticalBorders) Set if the table cells of the row have vertical borders.

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.conditions.ConditionElement

getCondition

Methods inherited from interface org.docgene.model.StyledElement

getStyle, hasInlinedStyle, setCustomStyles

Constructor Detail

XMLTableRow

public XMLTableRow()

Method Detail

getDeclaration

public java.lang.String getDeclaration()

Return the declaration ID of the element.

Specified by:

getDeclaration in interface StyledElement

Returns:

the declaration ID of the element

setColor

public void setColor(java.lang.String color)

Set the row background color.

Parameters:

color - the background color

getColor

public java.lang.String getColor()

Return the row background color.

Returns:

the background color

setBorders

public void setBorders(boolean hasBorders)

Set if the table cells of the row have borders.

Parameters:

hasBorders - true if the table cells of the row have borders

hasBorders

public boolean hasBorders()

Return true if the table cells of the row have borders.

Returns:

true if the table cells of the row have borders

hasNoBorders

public boolean hasNoBorders()

Return true if the table cells of the row have no borders.

Returns:

true if the table cells of the row have no borders

setHorizontalBorders

public void setHorizontalBorders(boolean hasHorizontalBorders)

Set if the table cells of the row have horizontal borders.

Parameters:

hasHorizontalBorders - true if the table cells of the row have horizontal borders

hasHorizontalBorders

public boolean hasHorizontalBorders()

Return true if the table cells of the row have horizontal borders.

Returns:

true if the table cells of the row have horizontal borders

setVerticalBorders

public void setVerticalBorders(boolean hasVerticalBorders)

Set if the table cells of the row have vertical borders.

Parameters:

hasVerticalBorders - true if the table cells of the row have vertical borders

hasVerticalBorders

public boolean hasVerticalBorders()

Return true if the table cells of the row have vertical borders.

Returns:

true if the table cells of the row have vertical borders

setTopBorderType

public void setTopBorderType(short borderType)

Set the top border type.

Parameters:

borderType - the top border type

See Also:

RowBorderType

getTopBorderType

public short getTopBorderType()

Return the top border type.

Returns:

the top border type

See Also:

RowBorderType

setBottomBorderType

public void setBottomBorderType(short borderType)

Set the bottom border type.

Parameters:

borderType - the bottom border type

See Also:

RowBorderType

getBottomBorderType

public short getBottomBorderType()

Return the bottom border type.

Returns:

the bottom border type

See Also:

RowBorderType

addCell

public int addCell(XMLTableCell cell)

Add a cell to the table row.

Parameters:

cell - the cell

Returns:

the cell index in the row

addEmptyCell

public XMLTableCell addEmptyCell()

Add an empty cell to the table row.

Returns:

the cell

getCells

public java.util.List<XMLTableCell> getCells()

Return the cells in the table row.

Returns:

the cells

getCell

public XMLTableCell getCell(int index)

Return the cell at a specified index.

Parameters:

index - the index

Returns:

the cell

countCells

public int countCells()

Return the number of cells.

Returns:

the number of cells

isRelativeWidth

public boolean isRelativeWidth()

Return true if the row widths are relative (in %).

Returns:

true if the row widths are relative

getWidths

public java.util.List<java.lang.Integer> getWidths()

Return the row specified widths for its cells. Return null by default.

Returns:

the row specified widths for its cells

getWidth

public int getWidth(int cellIndex)

Return the specified width for one cell. Return -1 by default.

Parameters:

cellIndex - the cell index

Returns:

the with

hasWidth

public boolean hasWidth(int cellIndex)

Return true if the row has a specified width for one cell. Return -1 by default.

Parameters:

cellIndex - the cell index

Returns:

true if the row has a specified width for its cell

hasWidths

public boolean hasWidths()

Return true if the row has specified widths for its cells.

Returns:

true if the row has specified widths for its cells

hasUniqueElement

public boolean hasUniqueElement()

Return true.

Specified by:

hasUniqueElement in interface org.docgene.model.conditions.ConditionElement<XMLTableRow>

Returns:

true

getConditionUniqueElement

public XMLTableRow getConditionUniqueElement()

Return the unique element for a condition.

Specified by:

getConditionUniqueElement in interface org.docgene.model.conditions.ConditionElement<XMLTableRow>

Returns:

the unique element.

getConditionElementsList

public java.util.List<XMLTableRow> getConditionElementsList()

Return the list of elements for a condition.

Specified by:

getConditionElementsList in interface org.docgene.model.conditions.ConditionElement<XMLTableRow>

Returns:

the list of elements