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

Interface UiWidgetAbstractListTable<ROW>

Type Parameters:

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

All Superinterfaces:

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

All Known Subinterfaces:

UiWidgetListTable<ROW>, UiWidgetOptionListTable<ROW>

All Known Implementing Classes:

AbstractUiWidgetAbstractListTable, AbstractUiWidgetListTable, UiWidgetCustomAbstractListTable, UiWidgetCustomListTable, UiWidgetListTableGwt

public interface UiWidgetAbstractListTable<ROW>
extends UiWidgetAbstractDataTable<ROW>, UiWidgetListBase<ROW>

This is the abstract interface for a data table widget that represents a list table.
Note:
There are the following variants of this abstract list table widget:

• UiWidgetListTable
• UiWidgetOptionListTable

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

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.
int	getRowIndex(ROW row) Gets the index of the given row.
boolean	removeRow(ROW row) This method removes the given row.
boolean	replaceRow(ROW oldRow, ROW newRow) This method replaces a <ROW> in this list table.

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

Method Detail

getRowIndex

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

Parameters:

row - is the <ROW> to locate.

Returns:

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

See Also:

List.indexOf(Object)

addRow

void addRow(ROW row)

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

Parameters:

row - is the <ROW> to add.

See Also:

addRow(Object, int)

addRow

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 getRowIndex(Object).

Parameters:

row - is the <ROW> to add.

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

replaceRow

boolean replaceRow(ROW oldRow,
                   ROW newRow)

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

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

removeRow

boolean removeRow(ROW row)

This method removes the given 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).