net.sf.mmm.client.ui.api.widget.complex

Interface UiWidgetTableColumn<ROW,CELL>

Type Parameters:

ROW - is the generic type of the element representing a row of the grid. It should be a java-bean oriented object. Immutable objects (that have no setters) can also be used but only for read-only tables.

CELL - is the generic type of the values located in the cells of this column.

All Superinterfaces:

AbstractValidatableObject, Accessibility, AttributeReadAriaRole, AttributeReadDisposed, AttributeReadEditable, AttributeReadEnabled, AttributeReadHtmlId, AttributeReadId<String>, AttributeReadMode, AttributeReadModeFixed, AttributeReadModified, AttributeReadPrimaryStyle, AttributeReadReorderable, AttributeReadResizable, AttributeReadSortable, AttributeReadSortComparator<CELL>, AttributeReadStringTitle, AttributeReadStyles, AttributeReadStylesAdvanced, AttributeReadTitle<String>, AttributeReadTooltip, AttributeReadVisible, AttributeReadVisibleRecursive, AttributeWriteDisposed, AttributeWriteEditable, AttributeWriteEnabled, AttributeWriteHtmlId, AttributeWriteId<String>, AttributeWriteMode, AttributeWriteModeFixed, AttributeWritePrimaryStyle, AttributeWriteReorderable, AttributeWriteResizable, AttributeWriteSortable, AttributeWriteSortComparator<CELL>, AttributeWriteStringTitle, AttributeWriteStyles, AttributeWriteStylesAdvanced, AttributeWriteTitle<String>, AttributeWriteTooltip, AttributeWriteVisible, AttributeWriteVisibleAdvanced, HasValueValidators<CELL>, UiFeature, UiFeatureEvent, UiFeatureMessages, UiFeatureMode, UiWidget

All Known Implementing Classes:

AbstractUiWidgetTableColumn, UiWidgetTableColumnImpl

public interface UiWidgetTableColumn<ROW,CELL>
extends UiWidget, HasValueValidators<CELL>, AttributeWriteStringTitle, AttributeWriteEditable, AttributeWriteResizable, AttributeWriteSortable, AttributeWriteReorderable, AttributeWriteSortComparator<CELL>

This is the interface for a virtual UiWidget that represents the column of a data table.

Since:

1.0.0

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

Field Summary

Fields inherited from interface net.sf.mmm.client.ui.api.widget.UiWidget

STYLE_HEADER

Fields inherited from interface net.sf.mmm.client.ui.api.attribute.AttributeReadHtmlId

HTML_ATTRIBUTE_ID, ID_SEPARATOR, PROPERTY_ID

Fields inherited from interface net.sf.mmm.client.ui.api.attribute.AttributeReadStyles

PROPERTY_STYLES, STYLE_PATTERN_MULTIPLE, STYLE_PATTERN_SINGLE

Fields inherited from interface net.sf.mmm.util.lang.api.concern.Accessibility

WAI_ARIA

Fields inherited from interface net.sf.mmm.client.ui.api.attribute.AttributeReadStringTitle

PROPERTY_TITLE

Method Summary

Modifier and Type	Method and Description
boolean	isSortable() This method determines if this object can be sorted.
void	sort() Like sort(SortOrder) but will toggle the SortOrder state of this column.
void	sort(SortOrder order) This method sorts the table-data according to this column using the sort-comparator and the given order.

Methods inherited from interface net.sf.mmm.client.ui.api.widget.UiWidget

getContext, getParent, getSize

Methods inherited from interface net.sf.mmm.client.ui.api.feature.UiFeatureMessages

clearMessages

Methods inherited from interface net.sf.mmm.client.ui.api.feature.UiFeatureEvent

addEventHandler, removeEventHandler

Methods inherited from interface net.sf.mmm.client.ui.api.attribute.AttributeWriteMode

setMode

Methods inherited from interface net.sf.mmm.client.ui.api.attribute.AttributeReadMode

getMode

Methods inherited from interface net.sf.mmm.client.ui.api.attribute.AttributeWriteModeFixed

setModeFixed

Methods inherited from interface net.sf.mmm.client.ui.api.attribute.AttributeReadModeFixed

getModeFixed

Methods inherited from interface net.sf.mmm.client.ui.api.attribute.AttributeWriteHtmlId

setId

Methods inherited from interface net.sf.mmm.client.ui.api.attribute.AttributeReadHtmlId

getId

Methods inherited from interface net.sf.mmm.client.ui.api.attribute.AttributeWriteTooltip

setTooltip

Methods inherited from interface net.sf.mmm.client.ui.api.attribute.AttributeReadTooltip

getTooltip

Methods inherited from interface net.sf.mmm.client.ui.api.attribute.AttributeWriteVisibleAdvanced

getVisibleFlag, isVisible, setVisible, setVisible

Methods inherited from interface net.sf.mmm.client.ui.api.attribute.AttributeReadVisibleRecursive

isVisibleRecursive

Methods inherited from interface net.sf.mmm.client.ui.api.attribute.AttributeWriteEnabled

setEnabled

Methods inherited from interface net.sf.mmm.client.ui.api.attribute.AttributeReadEnabled

isEnabled

Methods inherited from interface net.sf.mmm.client.ui.api.attribute.AttributeWriteStylesAdvanced

addStyle, removeStyle

Methods inherited from interface net.sf.mmm.client.ui.api.attribute.AttributeReadStylesAdvanced

hasStyle

Methods inherited from interface net.sf.mmm.client.ui.api.attribute.AttributeWriteStyles

setStyles

Methods inherited from interface net.sf.mmm.client.ui.api.attribute.AttributeReadStyles

getStyles

Methods inherited from interface net.sf.mmm.client.ui.api.attribute.AttributeWritePrimaryStyle

setPrimaryStyle

Methods inherited from interface net.sf.mmm.client.ui.api.attribute.AttributeReadPrimaryStyle

getPrimaryStyle

Methods inherited from interface net.sf.mmm.util.lang.api.attribute.AttributeWriteDisposed

dispose

Methods inherited from interface net.sf.mmm.util.lang.api.attribute.AttributeReadDisposed

isDisposed

Methods inherited from interface net.sf.mmm.client.ui.api.attribute.AttributeReadModified

isModified

Methods inherited from interface net.sf.mmm.client.ui.api.attribute.AttributeReadAriaRole

getAriaRole

Methods inherited from interface net.sf.mmm.util.validation.api.AbstractValidatableObject

validate

Methods inherited from interface net.sf.mmm.util.validation.api.HasValueValidators

addValidator, removeValidator

Methods inherited from interface net.sf.mmm.client.ui.api.attribute.AttributeWriteStringTitle

setTitle

Methods inherited from interface net.sf.mmm.client.ui.api.attribute.AttributeReadStringTitle

getTitle

Methods inherited from interface net.sf.mmm.client.ui.api.attribute.AttributeWriteEditable

setEditable

Methods inherited from interface net.sf.mmm.client.ui.api.attribute.AttributeReadEditable

isEditable

Methods inherited from interface net.sf.mmm.client.ui.api.attribute.AttributeWriteResizable

setResizable

Methods inherited from interface net.sf.mmm.client.ui.api.attribute.AttributeReadResizable

isResizable

Methods inherited from interface net.sf.mmm.client.ui.api.attribute.AttributeWriteSortable

setSortable

Methods inherited from interface net.sf.mmm.client.ui.api.attribute.AttributeWriteReorderable

setReorderable

Methods inherited from interface net.sf.mmm.client.ui.api.attribute.AttributeReadReorderable

isReorderable

Methods inherited from interface net.sf.mmm.client.ui.api.attribute.AttributeWriteSortComparator

setSortComparator

Methods inherited from interface net.sf.mmm.client.ui.api.attribute.AttributeReadSortComparator

getSortComparator

Method Detail

sort

void sort()

Like sort(SortOrder) but will toggle the SortOrder state of this column.

sort

void sort(SortOrder order)

This method sorts the table-data according to this column using the sort-comparator and the given order.

Parameters:

order - is the SortOrder.

isSortable

boolean isSortable()

Description copied from interface: AttributeReadSortable

This method determines if this object can be sorted.

Specified by:

isSortable in interface AttributeReadSortable

Returns:

true if a sort comparator is set and this column allows sorting, false otherwise (if AttributeReadSortComparator.getSortComparator() is null).