org.docgene.model

Class XMLTable

java.lang.Object

org.docgene.model.XMLTable

All Implemented Interfaces:

Alignment, org.docgene.model.conditions.ConditionElementsContainer<XMLTableRow>, ParagraphElement, ParagraphElementParent, StyledElement

public class XMLTable
extends java.lang.Object
implements ParagraphElementParent, org.docgene.model.conditions.ConditionElementsContainer<XMLTableRow>, ParagraphElement, Alignment

Represent the content of a <table> tag.

Field Summary

Fields inherited from interface org.docgene.model.StyledElement

TYPE_NONE

Fields inherited from interface org.docgene.model.Alignment

CENTER, LEFT, RIGHT

Constructor Summary

Constructors

Constructor and Description
XMLTable()

Method Summary

Modifier and Type	Method and Description
void	addConditionElement(org.docgene.model.conditions.ConditionElement<XMLTableRow> elt) Add a condition element to the list.
void	addElement(ParagraphElement element) Add an element.
void	addRow(XMLTableRow row) Add a row to the table.
char	getAlignment() Return the alignment of the table.
char	getAlignment(XMLTableCell cell) Return the alignment of the cell in the table.
java.util.List<org.docgene.model.conditions.ConditionElement<XMLTableRow>>	getAllElements()
java.lang.String	getCaption() Return the table caption.
XMLTableColumn	getColumn(XMLTableCell cell) Return the column associated with a cell.
java.util.Set<java.lang.String>	getCustomStyles() Return the element custom classes.
java.lang.String	getDeclaration() Return the declaration ID of the element.
java.util.List<ParagraphElement>	getElements() Return the list of children elements.
XMLTableRow	getFirstRow(ArticlesModel model) Return the first row.
java.lang.String	getInlinedStyle() Return the element custom inline style.
char	getPadding() Return the padding of the table rows.
java.util.List<XMLTableRow>	getRows(ArticlesModel model) Return the rows in the table.
XMLTableHeader	getTableHeader() Return the table header.
int	getWidth() Return the table width.
boolean	hasBorders() Return true if the table has borders.
boolean	hasCaption() Return true if the table has a caption.
boolean	hasCustomRows() Return true if the table has rows with custom widths.
boolean	hasWidth() Return true if the table has a specified width.
boolean	isFixedLayout() Return true if the table has a fixed layout.
boolean	isFloat() Return true if the table element should have the "float" attribute.
boolean	isRelativeWidth() Return true if the table width is relative (in %).
boolean	isSortable() Return true if the table has arrows to sort columns by their content.
boolean	isVertical() Return true if the table is vertical.
void	setAlignment(char align) Set the alignment of the table.
void	setBorders(boolean hasBorders) Set if the table has borders.
void	setCaption(java.lang.String caption) Set the table caption.
void	setCustomStyles(java.util.Set<java.lang.String> classes) Set the element custom classes.
void	setElements(java.util.List<ParagraphElement> elements) Set the list of elements.
void	setFixedLayout(boolean fixedLayout) Set if the table has a fixed layout.
void	setFloat(boolean isFloat) Set if the table element should have the "float" attribute.
void	setInlinedStyle(java.lang.String style) Set the element custom inline style.
void	setPadding(char padding) Set the padding of the table rows.
void	setSortable(boolean isSortable) Set if the table has arrows to sort columns by their content.
void	setTableHeader(XMLTableHeader header) Set the table header.
void	setVertical(boolean isVertical) Set if the table is horizontal or vertical.
void	setWidth(int width, boolean relWidth) Set the table width.

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

getFilteredElements

Methods inherited from interface org.docgene.model.StyledElement

getStyle, hasInlinedStyle, setCustomStyles

Constructor Detail

XMLTable

public XMLTable()

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

setFloat

public void setFloat(boolean isFloat)

Set if the table element should have the "float" attribute.

Parameters:

isFloat - true if the table element should have the "float" attribute

isFloat

public boolean isFloat()

Return true if the table element should have the "float" attribute.

Returns:

true if the table element should have the "float" attribute

setAlignment

public void setAlignment(char align)

Set the alignment of the table.

Specified by:

setAlignment in interface Alignment

Parameters:

align - the alignment

See Also:

Alignment

getAlignment

public char getAlignment()

Return the alignment of the table.

Specified by:

getAlignment in interface Alignment

Returns:

the alignment

See Also:

Alignment

setPadding

public void setPadding(char padding)

Set the padding of the table rows.

Parameters:

padding - the padding

getPadding

public char getPadding()

Return the padding of the table rows.

Returns:

the padding

setTableHeader

public void setTableHeader(XMLTableHeader header)

Set the table header.

Parameters:

header - the table header

getTableHeader

public XMLTableHeader getTableHeader()

Return the table header.

Returns:

the table header

getAlignment

public char getAlignment(XMLTableCell cell)

Return the alignment of the cell in the table.

Parameters:

cell - the cell

Returns:

the alignment

getColumn

public XMLTableColumn getColumn(XMLTableCell cell)

Return the column associated with a cell. The column may be null if no table column is defined for the table.

Parameters:

cell - the cell

Returns:

the column

setFixedLayout

public void setFixedLayout(boolean fixedLayout)

Set if the table has a fixed layout.

Parameters:

fixedLayout - true if the table has a fixed layout

isFixedLayout

public boolean isFixedLayout()

Return true if the table has a fixed layout.

Returns:

true if the table has a fixed layout

setSortable

public void setSortable(boolean isSortable)

Set if the table has arrows to sort columns by their content.

Parameters:

isSortable - true if the table has arrows to sort columns by their content

isSortable

public boolean isSortable()

Return true if the table has arrows to sort columns by their content.

Returns:

true if the table has arrows to sort columns by their content

hasCustomRows

public boolean hasCustomRows()

Return true if the table has rows with custom widths.

Returns:

true if the table has rows with custom widths

setBorders

public void setBorders(boolean hasBorders)

Set if the table has borders.

Parameters:

hasBorders - true if the table has borders

hasBorders

public boolean hasBorders()

Return true if the table has borders.

Returns:

true if the table has borders

setWidth

public void setWidth(int width,
                     boolean relWidth)

Set the table width.

Parameters:

width - the table width

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

isRelativeWidth

public boolean isRelativeWidth()

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

Returns:

true if the table width is relative

getWidth

public int getWidth()

Return the table width.

Returns:

the table width

hasWidth

public boolean hasWidth()

Return true if the table has a specified width.

Returns:

true if the table has a specified width

isVertical

public boolean isVertical()

Return true if the table is vertical.

Returns:

true if the table is vertical

setVertical

public void setVertical(boolean isVertical)

Set if the table is horizontal or vertical.

Parameters:

isVertical - true if the table is vertical

setInlinedStyle

public void setInlinedStyle(java.lang.String style)

Set the element custom inline style. It correspond to the html "style" attribute.

Specified by:

setInlinedStyle in interface StyledElement

Parameters:

style - the element custom inline style

getInlinedStyle

public java.lang.String getInlinedStyle()

Return the element custom inline style. It correspond to the html "style" attribute.

Specified by:

getInlinedStyle in interface StyledElement

Returns:

the element custom inline style

setCustomStyles

public void setCustomStyles(java.util.Set<java.lang.String> classes)

Set the element custom classes.

Specified by:

setCustomStyles in interface StyledElement

Parameters:

classes - the custom element classes

getCustomStyles

public java.util.Set<java.lang.String> getCustomStyles()

Return the element custom classes.

Specified by:

getCustomStyles in interface StyledElement

Returns:

the custom classes

addRow

public void addRow(XMLTableRow row)

Add a row to the table.

Parameters:

row - the row

getFirstRow

public XMLTableRow getFirstRow(ArticlesModel model)

Return the first row.

Parameters:

model - the articles model

Returns:

the row

getRows

public java.util.List<XMLTableRow> getRows(ArticlesModel model)

Return the rows in the table.

Parameters:

model - the articles model

Returns:

the rows

getAllElements

public java.util.List<org.docgene.model.conditions.ConditionElement<XMLTableRow>> getAllElements()

Specified by:

getAllElements in interface org.docgene.model.conditions.ConditionElementsContainer<XMLTableRow>

setCaption

public void setCaption(java.lang.String caption)

Set the table caption.

Parameters:

caption - the caption

getCaption

public java.lang.String getCaption()

Return the table caption.

Returns:

the caption

hasCaption

public boolean hasCaption()

Return true if the table has a caption.

Returns:

true if the table has a caption

addConditionElement

public void addConditionElement(org.docgene.model.conditions.ConditionElement<XMLTableRow> elt)

Add a condition element to the list.

Specified by:

addConditionElement in interface org.docgene.model.conditions.ConditionElementsContainer<XMLTableRow>

Parameters:

elt - the condition element

addElement

public void addElement(ParagraphElement element)

Description copied from interface: ParagraphElementParent

Add an element.

Specified by:

addElement in interface ParagraphElementParent

Parameters:

element - the element

getElements

public java.util.List<ParagraphElement> getElements()

Description copied from interface: ParagraphElementParent

Return the list of children elements.

Specified by:

getElements in interface ParagraphElementParent

Returns:

the list of children elements

setElements

public void setElements(java.util.List<ParagraphElement> elements)

Description copied from interface: ParagraphElementParent

Set the list of elements.

Specified by:

setElements in interface ParagraphElementParent

Parameters:

elements - the list of elements