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

Interface AttributeWriteSelectedValueAdvanced<VALUE>

Type Parameters:

VALUE - is the generic type of the selectable values.

All Superinterfaces:

AttributeReadSelectedValue<VALUE>, AttributeWriteSelectedValue<VALUE>

public interface AttributeWriteSelectedValueAdvanced<VALUE>
extends AttributeWriteSelectedValue<VALUE>

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

Since:

1.0.0

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

Method Summary

Modifier and Type	Method and Description
boolean	isFirstValueSelected()
boolean	isLastValueSelected()
boolean	isValueSelected(VALUE value)
boolean	setFirstValueSelected(boolean selected) This method updates the selection state of the first value of this object (e.g.
boolean	setLastValueSelected(boolean selected) This method updates the selection state of the last value of this object (e.g.
boolean	setValueSelected(VALUE value, boolean selected) This method updates the selection state of the specified value.

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

Method Detail

isFirstValueSelected

boolean isFirstValueSelected()

Returns:

true if the first value is selected, false otherwise (if the first value is not selected or does not exists).

isLastValueSelected

boolean isLastValueSelected()

Returns:

true if the last value is selected, false otherwise (if the first value is not selected or does not exists).

isValueSelected

boolean isValueSelected(VALUE value)

Parameters:

value - is the value to check the selection state of.

Returns:

true if the given value is selected, false otherwise (if value is not selected or is not a value contained in this object).

setFirstValueSelected

boolean setFirstValueSelected(boolean selected)

This method updates the selection state of the first value of this object (e.g. the first entry in a list). Please note that the order of the values contained in this object might changeable so the semantic of the first value may change. If this object is currently empty (contains no values), this method has no effect.

Parameters:

selected - - true to select the value, false to deselect it.

Returns:

true if the selection of the specified value has been changed, false otherwise (if no such value exists).

setLastValueSelected

boolean setLastValueSelected(boolean selected)

This method updates the selection state of the last value of this object (e.g. the last entry in a list). Please note that the order of the values contained in this object might changeable so the semantic of the last value may change. If this object is currently empty (contains no values), this method has no effect.

Parameters:

selected - - true to select the value, false to deselect it.

Returns:

true if the selection of the specified value has been changed, false otherwise (if no such value exists).

setValueSelected

boolean setValueSelected(VALUE value,
                         boolean selected)

This method updates the selection state of the specified value. If the value

Parameters:

value - is the value to change the selection state of.

selected - - true to select the value, false to deselect it.

Returns:

true if the selection of the specified value has been changed, false otherwise (if no such value exists).