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

Class AbstractUiWidgetTableColumn<ADAPTER extends UiWidgetAdapterTableColumn,ROW,CELL>

java.lang.Object

net.sf.mmm.client.ui.base.feature.AbstractUiFeatureValueAndValidation<VALUE>

net.sf.mmm.client.ui.base.widget.AbstractUiWidget<VALUE>

net.sf.mmm.client.ui.base.widget.AbstractUiWidgetNative<ADAPTER,CELL>

net.sf.mmm.client.ui.base.widget.complex.AbstractUiWidgetTableColumn<ADAPTER,ROW,CELL>

Type Parameters:

ADAPTER - is the generic type of AbstractUiWidgetNative.getWidgetAdapter().

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 Implemented Interfaces:

AttributeReadAriaRole, AttributeReadEditable, AttributeReadEnabled, AttributeReadHtmlId, AttributeReadMode, AttributeReadModeFixed, AttributeReadModified, AttributeReadPrimaryStyle, AttributeReadReorderable, AttributeReadResizable, AttributeReadSortable, AttributeReadSortComparator<CELL>, AttributeReadStringTitle, AttributeReadStyles, AttributeReadStylesAdvanced, AttributeReadTooltip, AttributeReadValueAdvanced<CELL>, AttributeReadVisible, AttributeReadVisibleRecursive, AttributeWriteAriaRole, AttributeWriteEditable, AttributeWriteEnabled, AttributeWriteHtmlId, AttributeWriteMode, AttributeWriteModeFixed, AttributeWriteModified, AttributeWriteOnlyFocused, AttributeWritePrimaryStyle, AttributeWriteReorderable, AttributeWriteResizable, AttributeWriteSortable, AttributeWriteSortComparator<CELL>, AttributeWriteStringTitle, AttributeWriteStyles, AttributeWriteStylesAdvanced, AttributeWriteTooltip, AttributeWriteValueAdvanced<CELL>, AttributeWriteVisible, AttributeWriteVisibleAdvanced, UiFeature, UiFeatureEvent, UiFeatureMessages, UiFeatureMode, UiFeatureValidation<CELL>, UiFeatureValue<CELL>, UiFeatureValueAndValidation<CELL>, UiWidgetTableColumn<ROW,CELL>, UiWidget, UiWidgetAbstractComposite, UiWidgetAbstractWithValue<CELL>, AttributeReadDisposed, AttributeReadId<String>, AttributeReadTitle<String>, AttributeReadValue<CELL>, AttributeWriteDisposed, AttributeWriteId<String>, AttributeWriteTitle<String>, AttributeWriteValue<CELL>, Accessibility, AbstractValidatableObject, HasValueValidators<CELL>, ValidatableObject<CELL>

Direct Known Subclasses:

UiWidgetTableColumnImpl

public abstract class AbstractUiWidgetTableColumn<ADAPTER extends UiWidgetAdapterTableColumn,ROW,CELL>
extends AbstractUiWidgetNative<ADAPTER,CELL>
implements UiWidgetTableColumn<ROW,CELL>

This is the abstract base implementation of UiWidgetTableColumn.

Since:

1.0.0

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

Nested Class Summary

Nested classes/interfaces inherited from class net.sf.mmm.client.ui.base.widget.AbstractUiWidgetNative

AbstractUiWidgetNative.SizeImpl

Nested classes/interfaces inherited from class net.sf.mmm.client.ui.base.widget.AbstractUiWidget

AbstractUiWidget.AccessHelper, AbstractUiWidget.EventSender, AbstractUiWidget.HandlerContainer

Field Summary

Fields

Modifier and Type	Field and Description
private boolean	attached
private int	currentIndex
private AbstractUiWidgetAbstractDataTable<?,?,ROW,?>	dataTable
private static int	DEFAULT_WIDTH The initial default width of a column in pixel.
private boolean	editable
static TypedProperty<Integer>	PROPERTY_ROW_NUMBER The virtual property for multi-selection.
static TypedProperty<Boolean>	PROPERTY_SELECTED The virtual property for multi-selection.
private PropertyAccessor<ROW,CELL>	propertyAccessor
private boolean	reorderable
private boolean	resizable
private boolean	sortable
private Comparator<CELL>	sortComparator
private SortOrder	sortOrder
private String	title
private TypedProperty<CELL>	typedProperty
private UiSingleWidgetFactory<? extends UiWidgetWithValue<CELL>>	widgetFactory

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

Constructor Summary

Constructors

Constructor and Description
AbstractUiWidgetTableColumn(UiContext context, AbstractUiWidgetAbstractDataTable<?,?,ROW,?> listTable, TypedProperty<CELL> typedProperty, ADAPTER widgetAdapter) The constructor.

Method Summary

Modifier and Type	Method and Description
int	getCurrentIndex()
AbstractUiWidgetAbstractDataTable<?,?,ROW,?>	getDataTable()
PropertyAccessor<ROW,CELL>	getPropertyAccessor()
Comparator<CELL>	getSortComparator() This method gets the Comparator used to compare and sort the values.
SortOrder	getSortOrder()
String	getTitle() This method gets the title of this object.
TypedProperty<CELL>	getTypedProperty()
UiSingleWidgetFactory<? extends UiWidgetWithValue<CELL>>	getWidgetFactory()
protected void	initializeWidgetAdapter(ADAPTER adapter) This method is called from AbstractUiWidgetNative.getWidgetAdapter() to initialize the UiWidgetAdapter.
(package private) boolean	isAttached()
boolean	isEditable() This method gets the editable status of this object.
boolean	isReorderable() This method determines if this object can be reordered.
boolean	isResizable() This method determines if this object is resizable.
boolean	isSortable() This method determines if this object can be sorted.
(package private) void	setAttached(boolean attached)
void	setCurrentIndex(int currentIndex)
void	setEditable(boolean editableFlag) This method set the editable status.
(package private) void	setPropertyAccessor(PropertyAccessor<ROW,CELL> propertyAccessor)
void	setReorderable(boolean reorderable) This method sets the reorderable attribute.
void	setResizable(boolean resizable) This method sets the resizable attribute.
void	setSortable(boolean sortable) This method sets the sortable attribute.
void	setSortComparator(Comparator<CELL> sortComparator) This method sets the sort-comparator attribute.
void	setSortOrder(SortOrder order)
void	setTitle(String title) This method sets the title of this object.
(package private) void	setWidgetFactory(UiSingleWidgetFactory<? extends UiWidgetWithValue<CELL>> widgetFactory)
void	sort() Like UiWidgetTableColumn.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 class net.sf.mmm.client.ui.base.widget.AbstractUiWidgetNative

addChangeHandler, addStyle, clearMessages, clearValidity, createSize, createUniqueId, createWidgetAdapter, dispose, doGetValue, doSetMode, doSetValue, doValidate, getAriaRole, getAriaRoleFixedType, getChild, getChild, getChildCount, getChildIndex, getId, getIndexOfStyle, getMode, getModeFixed, getParent, getPrimaryStyle, getSize, getStyles, getTooltip, getVisibleFlag, getWidgetAdapter, getWidgetAdapter, hasStyle, hasWidgetAdapter, isDisposed, isEnabled, isModifiedRecursive, isVisible, isVisibleRecursive, removeChangeHandler, removeFromParent, removeStyle, setAriaRole, setEnabled, setFocused, setId, setIdPrefix, setMode, setMode, setModeFixed, setParent, setPrimaryStyle, setStyles, setTooltip, setVisible, setVisible, toString, visibilityChanged

Methods inherited from class net.sf.mmm.client.ui.base.widget.AbstractUiWidget

addEventHandler, addValidator, clearMessagesLocal, clearValidationFailure, convertValueToString, fireEvent, fireValueChange, getBasicUtil, getContext, getDataBinding, getDataBinding, getDataBindingForWidget, getEventSender, getFactory, getLogger, getObserverSource, getOriginalValue, getRecentValue, getSource, getValueClass, getValueDirect, getValueOrException, getWidgetAdapter, hasEventSender, isMandatory, isModified, removeEventHandler, removeFromParent, removeValidator, setMandatory, setModified, setParent, setValue

Methods inherited from class net.sf.mmm.client.ui.base.feature.AbstractUiFeatureValueAndValidation

addValidatorMandatory, createValidationFailure, getValue, getValueAndValidate, handleGetValueError, resetValue, setValue, setValueForUser, validate

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

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.AttributeWriteValueAdvanced

resetValue, setValue, setValueForUser

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

getValue

Field Detail

DEFAULT_WIDTH

private static final int DEFAULT_WIDTH

The initial default width of a column in pixel.

See Also:

Constant Field Values

PROPERTY_SELECTED

public static final TypedProperty<Boolean> PROPERTY_SELECTED

The virtual property for multi-selection.

PROPERTY_ROW_NUMBER

public static final TypedProperty<Integer> PROPERTY_ROW_NUMBER

The virtual property for multi-selection.

dataTable

private final AbstractUiWidgetAbstractDataTable<?,?,ROW,?> dataTable

See Also:

getDataTable()

typedProperty

private final TypedProperty<CELL> typedProperty

See Also:

getTypedProperty()

propertyAccessor

private PropertyAccessor<ROW,CELL> propertyAccessor

See Also:

setPropertyAccessor(PropertyAccessor)

sortComparator

private Comparator<CELL> sortComparator

See Also:

getSortComparator()

title

private String title

See Also:

getTitle()

reorderable

private boolean reorderable

See Also:

isReorderable()

editable

private boolean editable

See Also:

isEditable()

resizable

private boolean resizable

See Also:

isResizable()

sortable

private boolean sortable

See Also:

isSortable()

widgetFactory

private UiSingleWidgetFactory<? extends UiWidgetWithValue<CELL>> widgetFactory

See Also:

getWidgetFactory()

sortOrder

private SortOrder sortOrder

See Also:

getSortOrder()

attached

private boolean attached

See Also:

isAttached()

currentIndex

private int currentIndex

See Also:

getCurrentIndex()

Constructor Detail

AbstractUiWidgetTableColumn

public AbstractUiWidgetTableColumn(UiContext context,
                                   AbstractUiWidgetAbstractDataTable<?,?,ROW,?> listTable,
                                   TypedProperty<CELL> typedProperty,
                                   ADAPTER widgetAdapter)

The constructor.

Parameters:

context - is the context.

listTable - is the list table this column is connected to.

typedProperty - is the typed property of the column to create. May be null.

widgetAdapter - is the widget adapter. Typically null for lazy initialization.

Method Detail

initializeWidgetAdapter

protected void initializeWidgetAdapter(ADAPTER adapter)

This method is called from AbstractUiWidgetNative.getWidgetAdapter() to initialize the UiWidgetAdapter. All attributes of this widget need to be set in the UiWidgetAdapter.

Overrides:

initializeWidgetAdapter in class AbstractUiWidgetNative<ADAPTER extends UiWidgetAdapterTableColumn,CELL>

Parameters:

adapter - is the UiWidgetAdapter to initialize.

getTypedProperty

public TypedProperty<CELL> getTypedProperty()

Returns:

the TypedProperty identifying the property managed with this column. May be null if the column was created with an explicit property accessor. In such case the widget factory shall not be null or cells with null values can not be handled.

getPropertyAccessor

public PropertyAccessor<ROW,CELL> getPropertyAccessor()

Returns:

the PropertyAccessor.

setPropertyAccessor

void setPropertyAccessor(PropertyAccessor<ROW,CELL> propertyAccessor)

Parameters:

propertyAccessor - is the propertyAccessor to set

getWidgetFactory

public UiSingleWidgetFactory<? extends UiWidgetWithValue<CELL>> getWidgetFactory()

Returns:

the UiSingleWidgetFactory used to create widgets to view (and potentially edit) the values of a cell in this column.

See Also:

UiWidgetAbstractDataTable.createColumn(PropertyAccessor, UiSingleWidgetFactory, Comparator)

setWidgetFactory

void setWidgetFactory(UiSingleWidgetFactory<? extends UiWidgetWithValue<CELL>> widgetFactory)

Parameters:

widgetFactory - is the new widget factory.

isAttached

boolean isAttached()

Returns:

the attached

setAttached

void setAttached(boolean attached)

Parameters:

attached - is the attached to set

getTitle

public String getTitle()

This method gets the title of this object. The detailed meaning of the title depends on the type of object. E.g. a window will have the title in the top-level bar.

Specified by:

getTitle in interface AttributeReadStringTitle

Specified by:

getTitle in interface AttributeReadTitle<String>

Returns:

the title.

setTitle

public void setTitle(String title)

This method sets the title of this object.

Specified by:

setTitle in interface AttributeWriteStringTitle

Specified by:

setTitle in interface AttributeWriteTitle<String>

Parameters:

title - is the new title.

See Also:

AttributeReadStringTitle.getTitle()

isReorderable

public boolean isReorderable()

This method determines if this object can be reordered.

Specified by:

isReorderable in interface AttributeReadReorderable

Returns:

true if the object can be reordered (by the end-user) - typically via drag and drop, false otherwise.

setReorderable

public void setReorderable(boolean reorderable)

This method sets the reorderable attribute.

Specified by:

setReorderable in interface AttributeWriteReorderable

Parameters:

reorderable - is the new value of AttributeReadReorderable.isReorderable().

isEditable

public boolean isEditable()

This method gets the editable status of this object. Editable means that the end-user can edit the data of the object if also in edit mode (e.g. a data table that allows inline editing). If the editable feature is turned off, the user can no longer edit the data.
This is closely related to AttributeReadEnabled.isEnabled(). However turning off the editable-flag is weaker than disabling a UI object. An enabled but NOT editable object may still allow user-interaction (e.g. a combobox that still allows selection out of a predefined list but no editing of the text). Further the visualization is softer (no grey out of the entire object).
ATTENTION:
There may be other aspects that have influence if the user can currently edit this object such as the mode or enabled flag. This method only returns the editable flag (as set via AttributeWriteEditable.setEditable(boolean)) and therefore only tells if the object is potentially editable.

Specified by:

isEditable in interface AttributeReadEditable

Returns:

true if this object is editable, false otherwise.

setEditable

public void setEditable(boolean editableFlag)

This method set the editable status.

Specified by:

setEditable in interface AttributeWriteEditable

Parameters:

editableFlag - if true the object will become editable, if false the object will become un-editable.

isResizable

public boolean isResizable()

This method determines if this object is resizable.

Specified by:

isResizable in interface AttributeReadResizable

Returns:

true if the object can be resized (by the end-user), false otherwise.

setResizable

public void setResizable(boolean resizable)

This method sets the resizable attribute.

Specified by:

setResizable in interface AttributeWriteResizable

Parameters:

resizable - is the new value of AttributeReadResizable.isResizable().

setSortComparator

public void setSortComparator(Comparator<CELL> sortComparator)

This method sets the sort-comparator attribute. If <VALUE> implements Comparable you may simple provide ComparableComparator.getInstance() as argument (unless a more specific sorting is required here).

Specified by:

setSortComparator in interface AttributeWriteSortComparator<CELL>

Parameters:

sortComparator - is the new value of AttributeReadSortComparator.getSortComparator(). May be null to disable sorting.

getSortComparator

public Comparator<CELL> getSortComparator()

This method gets the Comparator used to compare and sort the values.

Specified by:

getSortComparator in interface AttributeReadSortComparator<CELL>

Returns:

the Comparator used to sort the values. May be null if NOT set what will prevent sorting.

isSortable

public boolean isSortable()

This method determines if this object can be sorted.

Specified by:

isSortable in interface AttributeReadSortable

Specified by:

isSortable in interface UiWidgetTableColumn<ROW,CELL>

Returns:

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

setSortable

public void setSortable(boolean sortable)

This method sets the sortable attribute.

Specified by:

setSortable in interface AttributeWriteSortable

Parameters:

sortable - is the new value of AttributeReadSortable.isSortable().

sort

public void sort()

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

Specified by:

sort in interface UiWidgetTableColumn<ROW,CELL>

sort

public void sort(SortOrder order)

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

Specified by:

sort in interface UiWidgetTableColumn<ROW,CELL>

Parameters:

order - is the SortOrder.

getSortOrder

public SortOrder getSortOrder()

Returns:

the current SortOrder of this column. May be null for no order.

setSortOrder

public void setSortOrder(SortOrder order)

Parameters:

order - is the new SortOrder. May be null to remove order.

getDataTable

public AbstractUiWidgetAbstractDataTable<?,?,ROW,?> getDataTable()

Returns:

the list table owning this column.

getCurrentIndex

public int getCurrentIndex()

Returns:

the current index of this column according to the actual order of the columns. This may change due to reordering or internal technical columns (e.g. row-numbers or checkboxes for multi-selection).

setCurrentIndex

public void setCurrentIndex(int currentIndex)

Parameters:

currentIndex - is the new value of getCurrentIndex().