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

Interface AttributeReadSelectedValue<VALUE>

Type Parameters:

VALUE - is the generic type of the selectable values.

All Known Subinterfaces:

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

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

Since:

1.0.0

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

See Also:

SelectionMode

Method Summary

Modifier and Type	Method and Description
VALUE	getSelectedValue() This method gets the currently selected value (item).
Collection<VALUE>	getSelectedValues() This method gets the currently selected values.
int	getSelectionCount() Logically the same as getSelectedValues().size() but more efficient.
boolean	hasSelectedValue()

Method Detail

hasSelectedValue

boolean hasSelectedValue()

Returns:

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

getSelectedValue

VALUE getSelectedValue()

This method gets the currently selected value (item).

Returns:

the selected value or null if no value is selected.

getSelectedValues

Collection<VALUE> getSelectedValues()

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

Returns:

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

See Also:

getSelectedValue()

getSelectionCount

int getSelectionCount()

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

Returns:

the number of selected values.