org.itsnat.comp.table

Interface ItsNatTableHeaderUI

All Superinterfaces:

ItsNatComponentUI, ItsNatElementComponentUI

All Known Subinterfaces:

ItsNatHTMLTableHeaderUI

public interface ItsNatTableHeaderUI
extends ItsNatElementComponentUI

Is the base interface of the User Interface of a table header.

A table header is managed as a DOM element list, using the current table structure and renderer.

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

Author:

Jose Maria Arranz Santamaria

See Also:

ItsNatTableHeader.getItsNatTableHeaderUI(), ItsNatTableHeader.getItsNatTableHeaderCellRenderer(), ItsNatTable.getItsNatTableStructure(), ElementList

Method Summary

Methods

Modifier and Type	Method and Description
org.w3c.dom.Element	getContentElementAt(int index) Returns the "content" element, this element is used to render below the associated value of the header column element.
org.w3c.dom.Element	getElementAt(int index) Returns the header column element at the specified index.
ItsNatTableHeader	getItsNatTableHeader() Returns the associated component object.
ItsNatTableHeaderCellUI	getItsNatTableHeaderCellUIAt(int index) Returns an object info of the header column element at the specified position.
ItsNatTableHeaderCellUI	getItsNatTableHeaderCellUIFromNode(org.w3c.dom.Node node) Returns an object info of the header column element containing the specified node (or the node is itself an element of the list).
int	getLength() Returns the number of header columns.
boolean	isEmpty() Informs whether the table header is empty (no columns).
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

getItsNatTableHeader

ItsNatTableHeader getItsNatTableHeader()

Returns the associated component object.

Returns:

the component object.

getLength

int getLength()

Returns the number of header columns.

Returns:

the number of header columns.

See Also:

NodeList.getLength()

isEmpty

boolean isEmpty()

Informs whether the table header is empty (no columns).

Returns:

true if the table header is empty.

See Also:

ElementListBase.isEmpty()

getElementAt

org.w3c.dom.Element getElementAt(int index)

Returns the header column element at the specified index.

Parameters:

index - index of the header column to search.

Returns:

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

See Also:

ElementListBase.getElementAt(int)

getContentElementAt

org.w3c.dom.Element getContentElementAt(int index)

Returns the "content" element, this element is used to render below the associated value of the header column element. This element is obtained using the current structure.

Parameters:

index - index of the element.

Returns:

the content element.

See Also:

ItsNatTableStructure.getHeaderColumnContentElement(ItsNatTableHeader,int,Element), ElementList.getContentElementAt(int)

getItsNatTableHeaderCellUIAt

ItsNatTableHeaderCellUI getItsNatTableHeaderCellUIAt(int index)

Returns an object info of the header column element at the specified position.

Parameters:

index - index of the element to search for.

Returns:

the object info of the matched column element. Null if index is out of range.

See Also:

getItsNatTableHeaderCellUIFromNode(Node), ElementListBase.getListElementInfoAt(int)

getItsNatTableHeaderCellUIFromNode

ItsNatTableHeaderCellUI getItsNatTableHeaderCellUIFromNode(org.w3c.dom.Node node)

Returns an object info of the header column element containing the specified node (or the node is itself an element of the list).

Parameters:

node - the node to search for.

Returns:

the object info of the matched column element. Null if this node is not contained by the list.

See Also:

getItsNatTableHeaderCellUIAt(int), ElementListBase.getListElementInfoFromNode(Node)

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()