net.sf.mmm.client.ui.api.attribute

Interface AttributeWriteSelectedValue<VALUE>

Type Parameters:

VALUE - is the generic type of the selectable values.

All Superinterfaces:

AttributeReadSelectedValue<VALUE>

All Known Subinterfaces:

AttributeWriteSelectedValueAdvanced<VALUE>, UiFeatureSelectedValue<VALUE>, UiWidgetAbstractDataSet<ITEM>, UiWidgetAbstractDataTable<ROW>, UiWidgetAbstractListTable<ROW>, UiWidgetAbstractTree<NODE>, UiWidgetListBase<ROW>, UiWidgetListBoxField<VALUE>, UiWidgetListTable<ROW>, UiWidgetOptionListTable<ROW>, UiWidgetTree<NODE>, UiWidgetTreeTable<NODE>

All Known Implementing Classes:

AbstractUiWidgetAbstractDataSet, AbstractUiWidgetAbstractDataTable, AbstractUiWidgetAbstractListTable, AbstractUiWidgetListTable, AbstractUiWidgetTree, UiWidgetAdapterTestSelectedValue, UiWidgetAdapterTestTree, UiWidgetCustomAbstractListTable, UiWidgetCustomListTable, UiWidgetListTableGwt, UiWidgetTreeGwt, UiWidgetTreeTestImpl

public interface AttributeWriteSelectedValue<VALUE>
extends AttributeReadSelectedValue<VALUE>

This interface gives read and write access to the selected value(s) (items) of an object.

Since:

1.0.0

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

Method Summary

Modifier and Type	Method and Description
boolean	setSelectedValue(VALUE selectedValue) This method sets the value currently selected.
boolean	setSelectedValues(Collection<VALUE> selectedValues) This method sets the values currently selected.

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

getSelectedValue, getSelectedValues, getSelectionCount, hasSelectedValue

Method Detail

setSelectedValue

boolean setSelectedValue(VALUE 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.

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

boolean setSelectedValues(Collection<VALUE> 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 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().

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