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

Class UiWidgetCustomAbstractListTable<ROW,DELEGATE extends UiWidgetAbstractListTable<ROW>>

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.custom.UiWidgetCustom<List<ROW>,DELEGATE>

net.sf.mmm.client.ui.base.widget.custom.complex.UiWidgetCustomAbstractListTable<ROW,DELEGATE>

Type Parameters:

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

DELEGATE - is the generic type of the delegate.

All Implemented Interfaces:

AttributeReadAriaRole, AttributeReadEditable, AttributeReadEnabled, AttributeReadHtmlId, AttributeReadMode, AttributeReadModeFixed, AttributeReadModified, AttributeReadPrimaryStyle, AttributeReadSelectedValue<ROW>, AttributeReadSelectionMode, AttributeReadStringTitle, AttributeReadStyles, AttributeReadStylesAdvanced, AttributeReadSummary, AttributeReadTitleVisible, AttributeReadTooltip, AttributeReadValueAdvanced<List<ROW>>, AttributeReadVisible, AttributeReadVisibleRecursive, AttributeWriteEditable, AttributeWriteEnabled, AttributeWriteHtmlId, AttributeWriteMode, AttributeWriteModeFixed, AttributeWriteModified, AttributeWriteOnlyFocused, AttributeWritePrimaryStyle, AttributeWriteSelectedValue<ROW>, AttributeWriteSelectionMode, AttributeWriteStringTitle, AttributeWriteStyles, AttributeWriteStylesAdvanced, AttributeWriteSummary, AttributeWriteTitleVisible, AttributeWriteTooltip, AttributeWriteValueAdvanced<List<ROW>>, AttributeWriteVisible, AttributeWriteVisibleAdvanced, UiFeature, UiFeatureEvent, UiFeatureMessages, UiFeatureMode, UiFeatureSelectedValue<ROW>, UiFeatureValidation<List<ROW>>, UiFeatureValue<List<ROW>>, UiFeatureValueAndValidation<List<ROW>>, UiWidgetAbstractDataSet<ROW>, UiWidgetAbstractDataTable<ROW>, UiWidgetAbstractListTable<ROW>, UiWidget, UiWidgetAbstractWithValue<List<ROW>>, 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:

UiWidgetCustomListTable

public abstract class UiWidgetCustomAbstractListTable<ROW,DELEGATE extends UiWidgetAbstractListTable<ROW>>
extends UiWidgetCustom<List<ROW>,DELEGATE>
implements UiWidgetAbstractListTable<ROW>

This is the abstract base class for a custom widget implementing 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.AbstractUiWidget

AbstractUiWidget.AccessHelper, AbstractUiWidget.EventSender, AbstractUiWidget.HandlerContainer

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

Constructor Summary

Constructors

Constructor and Description
UiWidgetCustomAbstractListTable(UiContext context, DELEGATE delegate) 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.
void	addSelectionHandler(UiHandlerEventSelection<ROW> handler) This method adds the given UiHandlerEventSelection to this object.
UiFeatureSelectedValue<ROW>	asFeatureSelectedValue()
<CELL> UiWidgetTableColumn<ROW,CELL>	createColumn(PropertyAccessor<ROW,CELL> rowAccessor, UiSingleWidgetFactory<? extends UiWidgetWithValue<CELL>> widgetFactory, Comparator<CELL> sortComparator) This method creates a new column for this table.
<CELL> UiWidgetTableColumn<ROW,CELL>	createColumn(TypedProperty<CELL> rowProperty, UiSingleWidgetFactory<? extends UiWidgetWithValue<CELL>> widgetFactory, Comparator<CELL> sortComparator) This method creates a new column for this table.
UiWidgetTableColumn<ROW,?>	getColumn(int index) This method gets the column at the given index.
UiWidgetTableColumn<ROW,?>	getColumnById(String columnId, boolean required) This method gets the column with the given columnId.
int	getColumnCount()
protected UiDataBinding<List<ROW>>	getDataBinding(List<ROW> example)
int	getRowIndex(ROW row) Gets the index of the given row.
UiWidgetTableColumn<?,Integer>	getRowNumberColumn() Gets implicit column that shows the row-numbers.
ROW	getSelectedValue() This method gets the currently selected value (item).
Collection<ROW>	getSelectedValues() This method gets the currently selected values.
UiWidgetTableColumn<?,Boolean>	getSelectionColumn() Gets implicit column that shows the checkboxes or radios for the selection of a row.
int	getSelectionCount() Logically the same as AttributeReadSelectedValue.getSelectedValues().size() but more efficient.
SelectionMode	getSelectionMode() This method gets the SelectionMode.
String	getSummary() This method gets the summary of this object.
String	getTitle() This method gets the title of this object.
boolean	hasSelectedValue()
boolean	isEditable() This method gets the editable status of this object.
boolean	isSelected(SelectionChoice choice) This method determines if the given logical SelectionChoice is currently selected.
boolean	isTitleVisible() This method determines if the title of this object is visible.
boolean	removeRow(ROW row) This method removes the given row.
boolean	removeSelectionHandler(UiHandlerEventSelection<ROW> handler) This method removes the given UiHandlerEventSelection from this object.
boolean	replaceRow(ROW oldRow, ROW newRow) This method replaces a <ROW> in this list table.
void	setColumns(List<? extends UiWidgetTableColumn<ROW,?>> columns) This method sets the columns for the table of this model.
void	setEditable(boolean editableFlag) This method set the editable status.
boolean	setSelectedValue(ROW selectedValue) This method sets the value currently selected.
boolean	setSelectedValues(Collection<ROW> selectedValues) This method sets the values currently selected.
boolean	setSelection(SelectionChoice choice, SelectionOperation operation) This method allows to change the selection of a logical SelectionChoice in a generic way.
void	setSelectionMode(SelectionMode selectionMode) This method sets the selection mode.
void	setSummary(String summary) This method sets the summary of this object.
void	setTitle(String title) This method sets the title of this object.
void	setTitleVisible(boolean titleVisible) This method sets the titleVisible flag of this object.

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

addStyle, clearMessages, clearValidity, dispose, doInitialize, doSetMode, doValidate, getAriaRole, getDelegate, getDelegate, getId, getMode, getModeFixed, getParent, getPrimaryStyle, getSize, getSource, getStyles, getTooltip, getValueClass, getVisibleFlag, getWidgetAdapter, hasStyle, hasWidgetAdapter, initialize, isDisposed, isEnabled, isModifiedRecursive, isVisible, isVisibleRecursive, removeFromParent, removeStyle, setEnabled, setFocused, setId, setMode, setMode, setModeFixed, setParent, setPrimaryStyle, setStyles, setTooltip, setVisible, setVisible

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

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

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

Constructor Detail

UiWidgetCustomAbstractListTable

public UiWidgetCustomAbstractListTable(UiContext context,
                                       DELEGATE delegate)

The constructor.

Parameters:

context - is the context.

delegate - is the delegate.

Method Detail

getDataBinding

protected UiDataBinding<List<ROW>> getDataBinding(List<ROW> example)

Overrides:

getDataBinding in class AbstractUiWidget<List<ROW>>

Parameters:

example - is an example value that may be used to determine the value class if not available. May be null.

Returns:

the data binding.

See Also:

AbstractUiWidget.getDataBinding()

createColumn

public <CELL> UiWidgetTableColumn<ROW,CELL> createColumn(TypedProperty<CELL> rowProperty,
                                                         UiSingleWidgetFactory<? extends UiWidgetWithValue<CELL>> widgetFactory,
                                                         Comparator<CELL> sortComparator)

This method creates a new column for this table.
ATTENTION:
The column is not automatically added to the table. You need to call UiWidgetAbstractDataTable.setColumns(List) for all columns that should appear in the UI.

Specified by:

createColumn in interface UiWidgetAbstractDataTable<ROW>

Type Parameters:

CELL - is the generic type of the property type.

Parameters:

rowProperty - is the TypedProperty identifying which property of <ROW> to show in the column.

widgetFactory - is the factory to create widgets for this column. ATTENTION: These widgets might be reused for performance-reasons for a different row just by setting its value. They should NOT contain additional state information (what is generally a bad idea). This parameter may be null to fall back to datatype based creation.

sortComparator - is the sort-comparator to set.

Returns:

a new UiWidgetTableColumn.

createColumn

public <CELL> UiWidgetTableColumn<ROW,CELL> createColumn(PropertyAccessor<ROW,CELL> rowAccessor,
                                                         UiSingleWidgetFactory<? extends UiWidgetWithValue<CELL>> widgetFactory,
                                                         Comparator<CELL> sortComparator)

This method creates a new column for this table.
ATTENTION:
The column is not automatically added to the table. You need to call UiWidgetAbstractDataTable.setColumns(List) for all columns that should appear in the UI.

Specified by:

createColumn in interface UiWidgetAbstractDataTable<ROW>

Type Parameters:

CELL - is the generic type of the property value.

Parameters:

rowAccessor - is the PropertyAccessor to access the property of <ROW> to show in the column.

widgetFactory - is the factory to create widgets for this column. ATTENTION: These widgets might be reused for performance-reasons for a different row just by setting its value. They should NOT contain additional state information (what is generally a bad idea). This parameter may be null to fall back to datatype based creation.

sortComparator - is the sort-comparator to set.

Returns:

a new UiWidgetTableColumn.

setColumns

public void setColumns(List<? extends UiWidgetTableColumn<ROW,?>> columns)

This method sets the columns for the table of this model.
You typically will call this method like this:

list.setColumns(Arrays.asList(column1, column2, column3))

Unfortunately varargs with generics cause trouble in interfaces.
ATTENTION:
This method should typically be called only once during initialization of this table. Multiple calls of this method for dynamic changes of the UI may NOT be completely supported by all underlying implementations. We recommend to test your code with all relevant implementations before investing in multiple dynamic changes. Consider AttributeWriteVisibleAdvanced.setVisible(boolean) instead if possible.

Specified by:

setColumns in interface UiWidgetAbstractDataTable<ROW>

Parameters:

columns - are the columns to set. Use createColumn to create before.

See Also:

UiWidgetAbstractDataTable.createColumn(TypedProperty, UiSingleWidgetFactory, Comparator), UiWidgetAbstractDataTable.createColumn(PropertyAccessor, UiSingleWidgetFactory, Comparator)

getColumnCount

public int getColumnCount()

Specified by:

getColumnCount in interface UiWidgetAbstractDataTable<ROW>

Returns:

the number of columns that are currently set.

See Also:

List.size()

getColumn

public UiWidgetTableColumn<ROW,?> getColumn(int index)

This method gets the column at the given index.

Specified by:

getColumn in interface UiWidgetAbstractDataTable<ROW>

Parameters:

index - is the index of the requested column. The index corresponds to the index when the columns have been set. Reordering or hiding columns in the UI has no effect on the index. The value has to be in the range from 0 to UiWidgetAbstractDataTable.getColumnCount() - 1.

Returns:

the requested column.

See Also:

List.get(int)

getSelectionColumn

public UiWidgetTableColumn<?,Boolean> getSelectionColumn()

Gets implicit column that shows the checkboxes or radios for the selection of a row.
ATTENTION:
This is available for advanced flexibility. Please avoid changing title, reorderable, resizable, or sortable.

Specified by:

getSelectionColumn in interface UiWidgetAbstractDataTable<ROW>

Returns:

the implicit column that shows the checkboxes or radios for the selection of a row.

getRowNumberColumn

public UiWidgetTableColumn<?,Integer> getRowNumberColumn()

Gets implicit column that shows the row-numbers.
ATTENTION:
This is available for advanced flexibility. Please avoid changing title, reorderable, resizable, or sortable.
This column may be lazily created. Only use if you want to make it visible.

Specified by:

getRowNumberColumn in interface UiWidgetAbstractDataTable<ROW>

Returns:

the implicit column that shows the row-numbers.

getColumnById

public UiWidgetTableColumn<ROW,?> getColumnById(String columnId,
                                                boolean required)
                                         throws ObjectNotFoundException

This method gets the column with the given columnId.

Specified by:

getColumnById in interface UiWidgetAbstractDataTable<ROW>

Parameters:

columnId - is the ID of the requested column.

required - - if true and the requested column does not exist, an exception is thrown, false otherwise (null will be returned for non existent columns).

Returns:

the requested column or null if no such column exists and required is false.

Throws:

ObjectNotFoundException - if no column exists with the given columnId and required is true.

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. The title may also be called caption (technically in HTML).

Specified by:

getTitle in interface AttributeReadStringTitle

Specified by:

getTitle in interface UiWidgetAbstractDataSet<ROW>

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 UiWidgetAbstractDataSet<ROW>

Specified by:

setTitle in interface AttributeWriteTitle<String>

Parameters:

title - is the new title.

See Also:

AttributeWriteTitleVisible.setTitleVisible(boolean)

addSelectionHandler

public void addSelectionHandler(UiHandlerEventSelection<ROW> handler)

This method adds the given UiHandlerEventSelection to this object.

Specified by:

addSelectionHandler in interface UiFeatureSelectedValue<ROW>

Parameters:

handler - is the UiHandlerEventSelection to add.

removeSelectionHandler

public boolean removeSelectionHandler(UiHandlerEventSelection<ROW> handler)

This method removes the given UiHandlerEventSelection from this object.

Specified by:

removeSelectionHandler in interface UiFeatureSelectedValue<ROW>

Parameters:

handler - is the UiHandlerEventSelection to remove.

Returns:

true if the handler has been removed successfully, false if it was NOT registered and nothing has changed.

setSelection

public boolean setSelection(SelectionChoice choice,
                            SelectionOperation operation)

This method allows to change the selection of a logical SelectionChoice in a generic way. The following table shows the combinations and their effect:

choice	operation	setSelection(choice, operation)	multi selection only
SelectionChoice.ALL	SelectionOperation.SET	selects all items.	yes
SelectionChoice.ALL	SelectionOperation.ADD	same effect as above.	yes
SelectionChoice.ALL	SelectionOperation.REMOVE	de-selects all items so none is selected.	yes
SelectionChoice.ALL	SelectionOperation.TOGGLE	toggles the selection of all items so the selection gets inverted.	yes
SelectionChoice.FIRST	SelectionOperation.SET	clears the selection and then selects the first item.	no
SelectionChoice.FIRST	SelectionOperation.ADD	Adds the first item to the current selection.	yes
SelectionChoice.FIRST	SelectionOperation.REMOVE	Removes the first item from the current selection.	no
SelectionChoice.FIRST	SelectionOperation.TOGGLE	Toggles the selection of the first item.	no
SelectionChoice.LAST	SelectionOperation.SET	clears the selection and then selects the last item.	no
SelectionChoice.LAST	SelectionOperation.ADD	Adds the last item to the current selection.	yes
SelectionChoice.LAST	SelectionOperation.REMOVE	Removes the last item from the current selection.	no
SelectionChoice.LAST	SelectionOperation.TOGGLE	Toggles the selection of the last item.	no

Specified by:

setSelection in interface UiFeatureSelectedValue<ROW>

Parameters:

choice - is the SelectionChoice indicating the items to select or deselect.

operation - is the SelectionOperation indicating what to do with the choice.

Returns:

true if the operation was successful, false otherwise. If there are no items at all true is returned in case of SelectionChoice.ALL and false otherwise.

isSelected

public boolean isSelected(SelectionChoice choice)

This method determines if the given logical SelectionChoice is currently selected.

Specified by:

isSelected in interface UiFeatureSelectedValue<ROW>

Parameters:

choice - is the SelectionChoice to check.

Returns:

true if the items identified by the given choice are currently selected, false otherwise (if at least one of them is NOT selected).

setSelectedValue

public boolean setSelectedValue(ROW selectedValue)

This method sets the value currently selected. If the given value is NOT available, the method will have NO effect. Otherwise this method will deselect all currently selected values and select the given value.

Specified by:

setSelectedValue in interface AttributeWriteSelectedValue<ROW>

Parameters:

selectedValue - is the value to select.

Returns:

true if the operation was successful, false otherwise (the given selectedValue is not contained in this object and cannot be selected).

setSelectedValues

public boolean setSelectedValues(Collection<ROW> selectedValues)

This method sets the values currently selected. All values that are NOT available, will be ignored.
ATTENTION:
In case of SelectionMode.SINGLE_SELECTION you shall not provide a Collection with more than one element. So you should then use AttributeWriteSelectedValue.setSelectedValue(Object) instead.
Further, if you call AttributeReadSelectedValue.getSelectedValues() after this method the items may be in a different order. Additionally the result of AttributeReadSelectedValue.getSelectedValue() will contain elements that are actually items available in this object. So e.g. if you have a list of items and call this method to select two items but only one of them is actually available in the list, then only that one is selected and therefore returned by AttributeReadSelectedValue.getSelectedValues().

Specified by:

setSelectedValues in interface AttributeWriteSelectedValue<ROW>

Parameters:

selectedValues - is the Collection with the values to select.

Returns:

true if the operation was successful and all selectedValues have been selected, false otherwise (at least one item out of selectedValues is not contained in this object and cannot be selected).

hasSelectedValue

public boolean hasSelectedValue()

Specified by:

hasSelectedValue in interface AttributeReadSelectedValue<ROW>

Returns:

true if at least one value is selected, false otherwise.

getSelectedValue

public ROW getSelectedValue()

This method gets the currently selected value (item).

Specified by:

getSelectedValue in interface AttributeReadSelectedValue<ROW>

Returns:

the selected value or null if no value is selected.

getSelectedValues

public Collection<ROW> getSelectedValues()

This method gets the currently selected values. The order of the returned Collection is unspecified.

Specified by:

getSelectedValues in interface AttributeReadSelectedValue<ROW>

Returns:

the Collection with all selected values. Will be empty if nothing is selected.

See Also:

AttributeReadSelectedValue.getSelectedValue()

getSelectionCount

public int getSelectionCount()

Logically the same as AttributeReadSelectedValue.getSelectedValues().size() but more efficient.

Specified by:

getSelectionCount in interface AttributeReadSelectedValue<ROW>

Returns:

the number of selected values.

setSelectionMode

public void setSelectionMode(SelectionMode selectionMode)

This method sets the selection mode.
ATTENTION:
It is recommended to set the SelectionMode immediately after creating the object. The initial default is always SelectionMode.SINGLE_SELECTION. Dynamically changing the SelectionMode may be expensive or not be supported (in exotic implementations) and should therefore be avoided.

Specified by:

setSelectionMode in interface AttributeWriteSelectionMode

Parameters:

selectionMode - is the new SelectionMode.

getSelectionMode

public SelectionMode getSelectionMode()

This method gets the SelectionMode.

Specified by:

getSelectionMode in interface AttributeReadSelectionMode

Returns:

the SelectionMode. Must not be null.

setSummary

public void setSummary(String summary)

This method sets the summary of this object.

Specified by:

setSummary in interface AttributeWriteSummary

Parameters:

summary - is the new summary to set.

getSummary

public String getSummary()

This method gets the summary of this object. It describes the main purpose of this object in a short and compact way. A summary might not be visible but is honored by assistive technology such as screen-readers.

Specified by:

getSummary in interface AttributeReadSummary

Returns:

the text. Will be the empty string if no text has been set.

setTitleVisible

public void setTitleVisible(boolean titleVisible)

This method sets the titleVisible flag of this object.

Specified by:

setTitleVisible in interface AttributeWriteTitleVisible

Parameters:

titleVisible - is the new value for AttributeReadTitleVisible.isTitleVisible().

isTitleVisible

public boolean isTitleVisible()

This method determines if the title of this object is visible. For Accessibility reasons you should always set the title of a titled object. However in specific cases you want to save space on the screen and may not require the title to be displayed for seeing users. Then you can hide the title while it is still recognized by assistive technology such as screen readers.

Specified by:

isTitleVisible in interface AttributeReadTitleVisible

Returns:

true if visible, false if hidden.

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.

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.

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)

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.

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

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

asFeatureSelectedValue

public UiFeatureSelectedValue<ROW> asFeatureSelectedValue()

Specified by:

asFeatureSelectedValue in interface UiWidgetWithSelectedValue<ROW>

Returns:

the UiFeatureSelectedValue. Either this object itself or a child object contained in this widget.