org.itsnat.comp.table

Interface ItsNatTableHeaderCellRenderer

public interface ItsNatTableHeaderCellRenderer

Is used to render column values of table headers as markup into DOM elements.

Author:

Jose Maria Arranz Santamaria

See Also:

ItsNatComponentManager.createDefaultItsNatTableHeaderCellRenderer(), ItsNatTableHeader.getItsNatTableHeaderCellRenderer(), ItsNatTableHeader.setItsNatTableHeaderCellRenderer(ItsNatTableHeaderCellRenderer)

Method Summary

Methods

Modifier and Type	Method and Description
void	renderTableHeaderCell(ItsNatTableHeader tableHeader, int column, java.lang.Object value, boolean isSelected, boolean hasFocus, org.w3c.dom.Element columnContentElem, boolean isNew) Renders as markup the specified column value of the table header into the specified element, usually as a text node.
void	unrenderTableHeaderCell(ItsNatTableHeader tableHeader, int column, org.w3c.dom.Element columnContentElem) Unrenders the markup of the specified header column.

Method Detail

renderTableHeaderCell

void renderTableHeaderCell(ItsNatTableHeader tableHeader,
                         int column,
                         java.lang.Object value,
                         boolean isSelected,
                         boolean hasFocus,
                         org.w3c.dom.Element columnContentElem,
                         boolean isNew)

Renders as markup the specified column value of the table header into the specified element, usually as a text node.

Default implementation delegates to the default ElementRenderer.

Default implementation ignores isSelected and hasFocus (current implementation of ItsNat tables does not handle focus on table header columns, ever is false).

Parameters:

tableHeader - the table header component, may be used to provide contextual information. Default implementation ignores it.

column - the column index.

value - the value to render.

isSelected - true if the column is selected.

hasFocus - true if the column has the focus.

columnContentElem - the table column content element to render the value into. Is a hint, if provided should be obtained by calling tableHeader.getItsNatTableHeaderUI().getColumnContentElementAt(column).

isNew - true if this is the first time the markup is rendered. Default implementation ignores this parameter.

unrenderTableHeaderCell

void unrenderTableHeaderCell(ItsNatTableHeader tableHeader,
                           int column,
                           org.w3c.dom.Element columnContentElem)

Unrenders the markup of the specified header column. This method is called before the markup is removed.

Default implementation does nothing.

Parameters:

tableHeader - the table header component, may be used to provide contextual information. Default implementation ignores it.

column - the column index.

columnContentElem - the table column content element to render the value into. Is a hint, if provided should be obtained by calling tableHeader.getItsNatTableHeaderUI().getColumnContentElementAt(column).