org.itsnat.comp.table

Interface ItsNatTableUI

All Superinterfaces:

ItsNatComponentUI, ItsNatElementComponentUI

All Known Subinterfaces:

ItsNatHTMLTableUI

public interface ItsNatTableUI
extends ItsNatElementComponentUI

Is the base interface of the User Interface of a table body component.

Table cells are managed as a DOM element table, using the current table structure and renderer.

Current implementation does not use the data model and relays heavily on ElementTable.

Rows and column indexes are 0 based.

Author:

Jose Maria Arranz Santamaria

See Also:

ItsNatTable.getItsNatTableUI(), ItsNatTable.getItsNatTableCellRenderer(), ItsNatTable.getItsNatTableStructure(), ItsNatTableHeaderUI

Method Summary

Methods

Modifier and Type	Method and Description
org.w3c.dom.Element	getBodyElement() Returns the element used as parent of the table body.
org.w3c.dom.Element	getCellContentElementAt(int row, int column) Returns the content element of the cell.
org.w3c.dom.Element	getCellElementAt(int row, int column) Returns the cell element at the specified row and column.
org.w3c.dom.Element[]	getCellElementsOfColumn(int column) Returns the cell elements of the specified column as an array.
org.w3c.dom.Element[]	getCellElementsOfRow(int row) Returns the cell elements of the specified row as an array.
int	getColumnCount() Returns the number of columns.
ItsNatTable	getItsNatTable() Returns the associated component object.
ItsNatTableCellUI	getItsNatTableCellUIAt(int row, int column) Returns an object info of the cell element at the specified row and column.
ItsNatTableCellUI	getItsNatTableCellUIFromNode(org.w3c.dom.Node node) Returns an object info of the cell element containing the specified node (or the node is itself an element of the table body).
ItsNatTableHeaderUI	getItsNatTableHeaderUI() Returns the header user interface manager of this component.
org.w3c.dom.Element	getRowContentElementAt(int row) Returns the content row element.
int	getRowCount() Returns the number of rows.
org.w3c.dom.Element	getRowElementAt(int row) Returns the row element at the specified index.
boolean	isUsePatternMarkupToRender() Informs whether the original (saved as pattern) markup is used to render.
void	setUsePatternMarkupToRender(boolean value) Sets whether the original (saved as pattern) markup is used to render.

Methods inherited from interface org.itsnat.comp.ItsNatElementComponentUI

getItsNatElementComponent

Methods inherited from interface org.itsnat.comp.ItsNatComponentUI

getItsNatComponent

Method Detail

getItsNatTable

ItsNatTable getItsNatTable()

Returns the associated component object.

Returns:

the component object.

getItsNatTableHeaderUI

ItsNatTableHeaderUI getItsNatTableHeaderUI()

Returns the header user interface manager of this component.

Returns:

the header user interface manager. Null if this table has not a header.

getRowCount

int getRowCount()

Returns the number of rows.

Returns:

the number of rows.

See Also:

ElementTableBase.getRowCount()

getColumnCount

int getColumnCount()

Returns the number of columns.

Returns:

the number of columns.

See Also:

ElementTable.getColumnCount()

getItsNatTableCellUIAt

ItsNatTableCellUI getItsNatTableCellUIAt(int row,
                                       int column)

Returns an object info of the cell element at the specified row and column.

Parameters:

row - row index of the cell element.

column - column index of the cell element.

Returns:

the object info of the matched table cell element. Null if row or column is out of range. This object is ever the same per cell and may be used to save any context data.

See Also:

getItsNatTableCellUIFromNode(Node), ElementTableBase.getTableCellElementInfoAt(int,int)

getItsNatTableCellUIFromNode

ItsNatTableCellUI getItsNatTableCellUIFromNode(org.w3c.dom.Node node)

Returns an object info of the cell element containing the specified node (or the node is itself an element of the table body).

Parameters:

node - the node to search for.

Returns:

the object info of the matched child element. Null if this node is not contained by the table. This object is ever the same per cell and may be used to save any context data.

See Also:

getItsNatTableCellUIAt(int,int), ElementTableBase.getTableCellElementInfoFromNode(Node)

getBodyElement

org.w3c.dom.Element getBodyElement()

Returns the element used as parent of the table body. In an HTML <table> returns the <tbody>

Returns:

the body parent element.

getRowElementAt

org.w3c.dom.Element getRowElementAt(int row)

Returns the row element at the specified index.

Parameters:

row - index of the row element to search.

Returns:

the row element in this position or null if index is out of range.

See Also:

ElementTableBase.getRowElementAt(int)

getRowContentElementAt

org.w3c.dom.Element getRowContentElementAt(int row)

Returns the content row element. This element is obtained using the current structure.

Parameters:

row - index of the row element.

Returns:

the content element.

See Also:

ItsNatTableStructure.getRowContentElement(ItsNatTable,int,Element), ElementTable.getRowContentElementAt(int)

getCellElementsOfRow

org.w3c.dom.Element[] getCellElementsOfRow(int row)

Returns the cell elements of the specified row as an array.

Parameters:

row - the row index.

Returns:

the cell element array or null if index is out of range.

See Also:

ElementTableBase.getCellElementsOfRow(int)

getCellElementsOfColumn

org.w3c.dom.Element[] getCellElementsOfColumn(int column)

Returns the cell elements of the specified column as an array.

Parameters:

column - the column index.

Returns:

the cell element array or null if index is out of range.

See Also:

ElementTableBase.getCellElementsOfColumn(int)

getCellElementAt

org.w3c.dom.Element getCellElementAt(int row,
                                   int column)

Returns the cell element at the specified row and column.

Parameters:

row - the row index of the cell element to search.

column - the column index of the cell element to search.

Returns:

the element in this position or null if some index is out of range.

See Also:

ElementTableBase.getCellElementAt(int,int)

getCellContentElementAt

org.w3c.dom.Element getCellContentElementAt(int row,
                                          int column)

Returns the content element of the cell. This element is obtained using the current structure.

Parameters:

row - index of the row.

Returns:

the content element of the row.

See Also:

ElementTable.getCellContentElementAt(int,int)

isUsePatternMarkupToRender

boolean isUsePatternMarkupToRender()

Informs whether the original (saved as pattern) markup is used to render.

The default value is defined by ItsNatDocument.isUsePatternMarkupToRender()

Returns:

true if the original markup is used.

See Also:

setUsePatternMarkupToRender(boolean)

setUsePatternMarkupToRender

void setUsePatternMarkupToRender(boolean value)

Sets whether the original (saved as pattern) markup is used to render.

Parameters:

value - true to enable the use of original markup to render.

See Also:

isUsePatternMarkupToRender()