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

Class AbstractUiWidgetAbstractListTable<ADAPTER extends UiWidgetAdapterAbstractListTable<ROW,ITEM_CONTAINER>,ROW,ITEM_CONTAINER extends ItemContainer<ROW,ITEM_CONTAINER>>

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,VALUE>

net.sf.mmm.client.ui.base.widget.AbstractUiWidgetActive<ADAPTER,VALUE>

net.sf.mmm.client.ui.base.widget.complex.AbstractUiWidgetAbstractDataSet<ADAPTER,VALUE,ROW,ITEM_CONTAINER>

net.sf.mmm.client.ui.base.widget.complex.AbstractUiWidgetAbstractDataTable<ADAPTER,List<ROW>,ROW,ITEM_CONTAINER>

net.sf.mmm.client.ui.base.widget.complex.AbstractUiWidgetAbstractListTable<ADAPTER,ROW,ITEM_CONTAINER>

Type Parameters:

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

ROW - is the generic type of a row in the value list.

ITEM_CONTAINER - is the generic type of the ItemContainer.

All Implemented Interfaces:

AttributeReadAccessKey, AttributeReadAriaRole, AttributeReadEditable, AttributeReadEnabled, AttributeReadFocused, AttributeReadHtmlId, AttributeReadMode, AttributeReadModeFixed, AttributeReadModified, AttributeReadPrimaryStyle, AttributeReadSelectedValue<ROW>, AttributeReadSelectionMode, AttributeReadStringTitle, AttributeReadStyles, AttributeReadStylesAdvanced, AttributeReadSummary, AttributeReadTitleVisible, AttributeReadTooltip, AttributeReadValueAdvanced<List<ROW>>, AttributeReadVisible, AttributeReadVisibleRecursive, AttributeWriteAccessKey, AttributeWriteAriaRole, AttributeWriteEditable, AttributeWriteEnabled, AttributeWriteFocused, AttributeWriteHtmlId, AttributeWriteMode, AttributeWriteModeFixed, AttributeWriteModified, AttributeWriteOnlyFocused, AttributeWritePrimaryStyle, AttributeWriteSelectedValue<ROW>, AttributeWriteSelectionMode, AttributeWriteStringTitle, AttributeWriteStyles, AttributeWriteStylesAdvanced, AttributeWriteSummary, AttributeWriteTitleVisible, AttributeWriteTooltip, AttributeWriteValueAdvanced<List<ROW>>, AttributeWriteVisible, AttributeWriteVisibleAdvanced, UiFeature, UiFeatureEvent, UiFeatureFocus, UiFeatureMessages, UiFeatureMode, UiFeatureSelectedValue<ROW>, UiFeatureValidation<List<ROW>>, UiFeatureValue<List<ROW>>, UiFeatureValueAndValidation<List<ROW>>, UiWidgetAbstractDataSet<ROW>, UiWidgetAbstractDataTable<ROW>, UiWidgetAbstractListTable<ROW>, UiWidget, UiWidgetAbstractComposite, UiWidgetAbstractWithValue<List<ROW>>, UiWidgetActive, UiWidgetListBase<ROW>, UiWidgetListContainer<ROW>, UiWidgetRegular, UiWidgetWithSelectedValue<ROW>, UiWidgetWithValue<List<ROW>>, AttributeReadDisposed, AttributeReadId<String>, AttributeReadTitle<String>, AttributeReadValue<List<ROW>>, AttributeWriteDisposed, AttributeWriteId<String>, AttributeWriteTitle<String>, AttributeWriteValue<List<ROW>>, Accessibility, AbstractValidatableObject, HasValueValidators<List<ROW>>, ValidatableObject<List<ROW>>

Direct Known Subclasses:

AbstractUiWidgetListTable

public abstract class AbstractUiWidgetAbstractListTable<ADAPTER extends UiWidgetAdapterAbstractListTable<ROW,ITEM_CONTAINER>,ROW,ITEM_CONTAINER extends ItemContainer<ROW,ITEM_CONTAINER>>
extends AbstractUiWidgetAbstractDataTable<ADAPTER,List<ROW>,ROW,ITEM_CONTAINER>
implements UiWidgetAbstractListTable<ROW>

This is the abstract base implementation of UiWidgetAbstractListTable.

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 ColumnContainerComparator<ROW>	comparator The ColumnContainerComparator for this table.
private Map<HashKey<ROW>,ITEM_CONTAINER>	rowMap
private List<ITEM_CONTAINER>	rows

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

STYLE_DATA_TABLE

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

PROPERTY_SUMMARY

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

PROPERTY_TITLE

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

ACCESS_KEY_NONE, HTML_ATTRIBUTE_ACCESS_KEY

Constructor Summary

Constructors

Constructor and Description
AbstractUiWidgetAbstractListTable(UiContext context, ADAPTER widgetAdapter) The constructor.

Method Summary

Modifier and Type	Method and Description
void	addRow(ROW row) Adds the given row at the end of this list table.
void	addRow(ROW row, int index) Adds the given row to this list table.
protected void	doSetSelected(ITEM_CONTAINER container, boolean selected) Internal method to set the selection of the item in the given container.
List<ITEM_CONTAINER>	getAllAvailableItems() Internal method to get the Collection with all items (currently) available in this widget.
protected ITEM_CONTAINER	getItemContainer(ROW item) Gets the existing container for the given item.
protected ITEM_CONTAINER	getLastAvailableItem()
int	getRowIndex(ROW row) Gets the index of the given row.
protected Class<List<ROW>>	getValueClass()
protected void	initializeWidgetAdapter(ADAPTER adapter) This method is called from AbstractUiWidgetNative.getWidgetAdapter() to initialize the UiWidgetAdapter.
boolean	removeRow(ROW row) This method removes the given row.
private ITEM_CONTAINER	removeRowFromMap(ROW row) Removes the given row from the internal Map.
boolean	replaceRow(ROW oldRow, ROW newRow) This method replaces a <ROW> in this list table.
(package private) void	sort(AbstractUiWidgetTableColumn<?,ROW,?> column, SortOrder sortOrder) This method sorts this list according to the given column.

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

createColumn, createColumn, createRowContainer, createRowContainer, createSelectionColumn, createTableColumnAdapter, dragColumn, getColumn, getColumnById, getColumnCount, getItem, getRowNumberColumn, getSelectionColumn, getSortColumn, hasRowNumberColumn, setColumns, setDragOverColumn

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

addSelectionHandler, asFeatureSelectedValue, clearSelection, doGetSelected, getFirstAvailableItem, getSelectedValue, getSelectedValues, getSelectedValuesInternal, getSelectionCount, getSelectionMode, getSummary, getTitle, hasSelectedValue, isEditable, isSelected, isTitleVisible, onItemSelection, removeSelectionHandler, setEditable, setSelectedValue, setSelectedValues, setSelectedValues, setSelection, setSelection, setSelectionMode, setSummary, setTitle, setTitleVisible

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

addFocusHandler, getAccessKey, isFocused, onAccessKeyPressed, removeFocusHandler, setAccessKey, setFocused, setFocused

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, 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, 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.complex.UiWidgetAbstractDataTable

createColumn, createColumn, getColumn, getColumnById, getColumnCount, getRowNumberColumn, getSelectionColumn, setColumns

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

getTitle, setTitle

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

addSelectionHandler, isSelected, removeSelectionHandler, setSelection

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

setSelectedValue, setSelectedValues

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

getSelectedValue, getSelectedValues, getSelectionCount, hasSelectedValue

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

setSelectionMode

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

getSelectionMode

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

setSummary

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

getSummary

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

setTitleVisible

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

isTitleVisible

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.widget.UiWidgetWithSelectedValue

asFeatureSelectedValue

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

getValue

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

getValueAndValidate, getValueDirect

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

addChangeHandler, removeChangeHandler

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

resetValue, setValue, setValue, setValueForUser

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

getOriginalValue, getValueOrException

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

addValidatorMandatory, isMandatory

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

addValidator, removeValidator

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

validate

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

Field Detail

rows

private final List<ITEM_CONTAINER extends ItemContainer<ROW,ITEM_CONTAINER>> rows

See Also:

getAllAvailableItems()

rowMap

private final Map<HashKey<ROW>,ITEM_CONTAINER extends ItemContainer<ROW,ITEM_CONTAINER>> rowMap

See Also:

getItemContainer(Object)

comparator

private final ColumnContainerComparator<ROW> comparator

The ColumnContainerComparator for this table.

Constructor Detail

AbstractUiWidgetAbstractListTable

public AbstractUiWidgetAbstractListTable(UiContext context,
                                         ADAPTER widgetAdapter)

The constructor.

Parameters:

context - is the context.

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

Method Detail

getValueClass

protected Class<List<ROW>> getValueClass()

Overrides:

getValueClass in class AbstractUiWidget<List<ROW>>

Returns:

the Class reflecting <VALUE>. May also be null for Void.

getAllAvailableItems

public List<ITEM_CONTAINER> getAllAvailableItems()

Internal method to get the Collection with all items (currently) available in this widget. In case of lazy loading only those that have already been loaded.
ATTENTION:
The Collection must NOT be modified if retrieved via this method. Implementations will provide separate addItem and removeItem methods.

Specified by:

getAllAvailableItems in class AbstractUiWidgetAbstractDataSet<ADAPTER extends UiWidgetAdapterAbstractListTable<ROW,ITEM_CONTAINER>,List<ROW>,ROW,ITEM_CONTAINER extends ItemContainer<ROW,ITEM_CONTAINER>>

Returns:

the Collection with all items (currently) available in this widget. In case of lazy loading only those that have already been loaded.

getLastAvailableItem

protected ITEM_CONTAINER getLastAvailableItem()

Specified by:

getLastAvailableItem in class AbstractUiWidgetAbstractDataSet<ADAPTER extends UiWidgetAdapterAbstractListTable<ROW,ITEM_CONTAINER>,List<ROW>,ROW,ITEM_CONTAINER extends ItemContainer<ROW,ITEM_CONTAINER>>

Returns:

the last of the available items.

getItemContainer

protected ITEM_CONTAINER getItemContainer(ROW item)

Gets the existing container for the given item. This method has to be very efficient. You should use a Map for this purpose.

Specified by:

getItemContainer in class AbstractUiWidgetAbstractDataSet<ADAPTER extends UiWidgetAdapterAbstractListTable<ROW,ITEM_CONTAINER>,List<ROW>,ROW,ITEM_CONTAINER extends ItemContainer<ROW,ITEM_CONTAINER>>

Parameters:

item - is the item to lookup.

Returns:

the container for the given item or null if no such container exists.

doSetSelected

protected void doSetSelected(ITEM_CONTAINER container,
                             boolean selected)

Internal method to set the selection of the item in the given container. Shall not do anything else (e.g. firing event).

Specified by:

doSetSelected in class AbstractUiWidgetAbstractDataSet<ADAPTER extends UiWidgetAdapterAbstractListTable<ROW,ITEM_CONTAINER>,List<ROW>,ROW,ITEM_CONTAINER extends ItemContainer<ROW,ITEM_CONTAINER>>

Parameters:

container - is the container with the item to mark.

selected - - true to select, false to deselect.

addRow

public void addRow(ROW row)

Adds the given row at the end of this list table.

Specified by:

addRow in interface UiWidgetAbstractListTable<ROW>

Parameters:

row - is the <ROW> to add.

See Also:

UiWidgetAbstractListTable.addRow(Object, int)

addRow

public void addRow(ROW row,
                   int index)

Adds the given row to this list table.
ATTENTION:
Be careful when dealing with indices. The index of a row can change at any time due to sorting or other features. You may use this method in combination of recent calls to UiWidgetAbstractListTable.getRowIndex(Object).

Specified by:

addRow in interface UiWidgetAbstractListTable<ROW>

Parameters:

row - is the <ROW> to add.

index - is the index where to add the given row.

removeRow

public boolean removeRow(ROW row)

This method removes the given row.

Specified by:

removeRow in interface UiWidgetAbstractListTable<ROW>

Parameters:

row - is the <ROW> to remove.

Returns:

true if the row was found and removed, false otherwise (if this list table does not contain oldRow and nothing was changed).

removeRowFromMap

private ITEM_CONTAINER removeRowFromMap(ROW row)

Removes the given row from the internal Map.

Parameters:

row - is the <ROW> to remove or replace.

Returns:

the ItemContainer for the given row that has been removed or null if none was found.

getRowIndex

public int getRowIndex(ROW row)

Gets the index of the given row.
ATTENTION:
The index of a row is not stable and may change at any time due to sorting or other features. You should only retrieve an index to immediately use it e.g. for UiWidgetAbstractListTable.addRow(Object, int) to insert a row before or after a given row such as the selected row. Please avoid storing such index and use it later as this can cause fatal bugs.

Specified by:

getRowIndex in interface UiWidgetAbstractListTable<ROW>

Parameters:

row - is the <ROW> to locate.

Returns:

the index of the given row or -1 if not found.

See Also:

List.indexOf(Object)

replaceRow

public boolean replaceRow(ROW oldRow,
                          ROW newRow)

This method replaces a <ROW> in this list table.

Specified by:

replaceRow in interface UiWidgetAbstractListTable<ROW>

Parameters:

oldRow - is the old <ROW> to replace.

newRow - is the new <ROW> to insert in place of the old one.

Returns:

true if oldRow was found and replaced, false otherwise (if this list table does not contain oldRow and nothing was changed).

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 AbstractUiWidgetAbstractDataTable<ADAPTER extends UiWidgetAdapterAbstractListTable<ROW,ITEM_CONTAINER>,List<ROW>,ROW,ITEM_CONTAINER extends ItemContainer<ROW,ITEM_CONTAINER>>

Parameters:

adapter - is the UiWidgetAdapter to initialize.

sort

void sort(AbstractUiWidgetTableColumn<?,ROW,?> column,
          SortOrder sortOrder)

This method sorts this list according to the given column.

Overrides:

sort in class AbstractUiWidgetAbstractDataTable<ADAPTER extends UiWidgetAdapterAbstractListTable<ROW,ITEM_CONTAINER>,List<ROW>,ROW,ITEM_CONTAINER extends ItemContainer<ROW,ITEM_CONTAINER>>

Parameters:

column - is the AbstractUiWidgetTableColumn to sort by.

sortOrder - is the SortOrder.