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

Class AbstractUiWidgetAbstractDataSet<ADAPTER extends UiWidgetAdapterAbstractDataSet<ITEM>,VALUE,ITEM,ITEM_CONTAINER>

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.AbstractUiWidgetNative<ADAPTER,VALUE>

net.sf.mmm.client.ui.base.widget.AbstractUiWidgetActive<ADAPTER,VALUE>

net.sf.mmm.client.ui.base.widget.complex.AbstractUiWidgetAbstractDataSet<ADAPTER,VALUE,ITEM,ITEM_CONTAINER>

Type Parameters:

ADAPTER - is the generic type of AbstractUiWidgetNative.getWidgetAdapter().

VALUE - is the generic type of the value. Has to be either ITEM or List<ITEM>.

ITEM - is the generic type of the items contained in this widget.

ITEM_CONTAINER - is the generic type of the container for the <ITEM> objects. Typically a ItemContainer.

All Implemented Interfaces:

AttributeReadAccessKey, AttributeReadAriaRole, AttributeReadEditable, AttributeReadEnabled, AttributeReadFocused, AttributeReadHtmlId, AttributeReadMode, AttributeReadModeFixed, AttributeReadModified, AttributeReadPrimaryStyle, AttributeReadSelectedValue<ITEM>, AttributeReadSelectionMode, AttributeReadStringTitle, AttributeReadStyles, AttributeReadStylesAdvanced, AttributeReadSummary, AttributeReadTitleVisible, AttributeReadTooltip, AttributeReadValueAdvanced<VALUE>, AttributeReadVisible, AttributeReadVisibleRecursive, AttributeWriteAccessKey, AttributeWriteAriaRole, AttributeWriteEditable, AttributeWriteEnabled, AttributeWriteFocused, AttributeWriteHtmlId, AttributeWriteMode, AttributeWriteModeFixed, AttributeWriteModified, AttributeWriteOnlyFocused, AttributeWritePrimaryStyle, AttributeWriteSelectedValue<ITEM>, AttributeWriteSelectionMode, AttributeWriteStringTitle, AttributeWriteStyles, AttributeWriteStylesAdvanced, AttributeWriteSummary, AttributeWriteTitleVisible, AttributeWriteTooltip, AttributeWriteValueAdvanced<VALUE>, AttributeWriteVisible, AttributeWriteVisibleAdvanced, UiFeature, UiFeatureEvent, UiFeatureFocus, UiFeatureMessages, UiFeatureMode, UiFeatureSelectedValue<ITEM>, UiFeatureValidation<VALUE>, UiFeatureValue<VALUE>, UiFeatureValueAndValidation<VALUE>, UiWidgetAbstractDataSet<ITEM>, UiWidget, UiWidgetAbstractComposite, UiWidgetAbstractWithValue<VALUE>, UiWidgetActive, UiWidgetRegular, UiWidgetWithSelectedValue<ITEM>, AttributeReadDisposed, AttributeReadId<String>, AttributeReadTitle<String>, AttributeReadValue<VALUE>, AttributeWriteDisposed, AttributeWriteId<String>, AttributeWriteTitle<String>, AttributeWriteValue<VALUE>, Accessibility, AbstractValidatableObject, HasValueValidators<VALUE>, ValidatableObject<VALUE>

Direct Known Subclasses:

AbstractUiWidgetAbstractDataTable, AbstractUiWidgetTree

public abstract class AbstractUiWidgetAbstractDataSet<ADAPTER extends UiWidgetAdapterAbstractDataSet<ITEM>,VALUE,ITEM,ITEM_CONTAINER>
extends AbstractUiWidgetActive<ADAPTER,VALUE>
implements UiWidgetAbstractDataSet<ITEM>

This is the abstract base implementation of 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.AbstractUiWidgetNative

AbstractUiWidgetNative.SizeImpl

Nested classes/interfaces inherited from class net.sf.mmm.client.ui.base.widget.AbstractUiWidget

AbstractUiWidget.AccessHelper, AbstractUiWidget.EventSender, AbstractUiWidget.HandlerContainer

Field Summary

Fields

Modifier and Type	Field and Description
private boolean	editable
private Set<ITEM_CONTAINER>	newSelectedValues Temporary Set stored as instance for performance (as widgets are not really thread-safe anyways).
private Set<ITEM_CONTAINER>	selectedValues
private SelectionMode	selectionMode
private String	summary
private String	title
private boolean	titleVisible

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

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

ACCESS_KEY_NONE, HTML_ATTRIBUTE_ACCESS_KEY

Constructor Summary

Constructors

Constructor and Description
AbstractUiWidgetAbstractDataSet(UiContext context, ADAPTER widgetAdapter) The constructor.

Method Summary

Modifier and Type	Method and Description
void	addSelectionHandler(UiHandlerEventSelection<ITEM> handler) This method adds the given UiHandlerEventSelection to this object.
UiFeatureSelectedValue<ITEM>	asFeatureSelectedValue()
protected void	clearSelection(ITEM_CONTAINER exclusion) Clears the current selection except for the given exclusion.
protected boolean	doGetSelected(ITEM_CONTAINER container) Internal method to get the selection status of the item in the given container.
protected abstract void	doSetSelected(ITEM_CONTAINER container, boolean selected) Internal method to set the selection of the item in the given container.
abstract Collection<ITEM_CONTAINER>	getAllAvailableItems() Internal method to get the Collection with all items (currently) available in this widget.
protected ITEM_CONTAINER	getFirstAvailableItem()
protected abstract ITEM	getItem(ITEM_CONTAINER container) This method gets the item in the given container.
protected abstract ITEM_CONTAINER	getItemContainer(ITEM item) Gets the existing container for the given item.
protected abstract ITEM_CONTAINER	getLastAvailableItem()
ITEM	getSelectedValue() This method gets the currently selected value (item).
Collection<ITEM>	getSelectedValues() This method gets the currently selected values.
protected Collection<ITEM_CONTAINER>	getSelectedValuesInternal() Internal method to get the direct reference to the selected values.
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()
protected void	initializeWidgetAdapter(ADAPTER adapter) This method is called from AbstractUiWidgetNative.getWidgetAdapter() to initialize the UiWidgetAdapter.
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.
void	onItemSelection(ITEM_CONTAINER itemContainer, boolean selected, boolean programmatic) Called from adapter if an item (<ITEM>) has been (de)selected.
boolean	removeSelectionHandler(UiHandlerEventSelection<ITEM> handler) This method removes the given UiHandlerEventSelection from this object.
void	setEditable(boolean editableFlag) This method set the editable status.
boolean	setSelectedValue(ITEM selectedValue) This method sets the value currently selected.
boolean	setSelectedValues(Collection<ITEM> selectedItems) This method sets the values currently selected.
boolean	setSelectedValues(Collection<ITEM> selectedItems, boolean programmatic)
protected boolean	setSelection(ITEM_CONTAINER itemContainer, SelectionOperation operation) Updates the selection of the given itemContainer according to the given operation.
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.AbstractUiWidgetActive

addFocusHandler, getAccessKey, isFocused, onAccessKeyPressed, removeFocusHandler, setAccessKey, setFocused, setFocused

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

addChangeHandler, addStyle, clearMessages, clearValidity, createSize, createUniqueId, createWidgetAdapter, dispose, doGetValue, doSetMode, doSetValue, doValidate, getAriaRole, getAriaRoleFixedType, getChild, getChild, getChildCount, getChildIndex, getId, getIndexOfStyle, getMode, getModeFixed, getParent, getPrimaryStyle, getSize, getStyles, getTooltip, getVisibleFlag, getWidgetAdapter, getWidgetAdapter, hasStyle, hasWidgetAdapter, isDisposed, isEnabled, isModifiedRecursive, isVisible, isVisibleRecursive, removeChangeHandler, removeFromParent, removeStyle, setAriaRole, setEnabled, setId, setIdPrefix, setMode, setMode, setModeFixed, setParent, setPrimaryStyle, setStyles, setTooltip, setVisible, setVisible, toString, visibilityChanged

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

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

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

Methods inherited from interface net.sf.mmm.util.validation.api.AbstractValidatableObject

validate

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

resetValue, setValue, setValueForUser

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

getValue

Field Detail

selectionMode

private SelectionMode selectionMode

See Also:

getSelectionMode()

selectedValues

private final Set<ITEM_CONTAINER> selectedValues

See Also:

getSelectedValues()

newSelectedValues

private final Set<ITEM_CONTAINER> newSelectedValues

Temporary Set stored as instance for performance (as widgets are not really thread-safe anyways).

See Also:

setSelectedValues(Collection)

summary

private String summary

See Also:

getSummary()

title

private String title

See Also:

getTitle()

titleVisible

private boolean titleVisible

See Also:

isTitleVisible()

editable

private boolean editable

See Also:

isEditable()

Constructor Detail

AbstractUiWidgetAbstractDataSet

public AbstractUiWidgetAbstractDataSet(UiContext context,
                                       ADAPTER widgetAdapter)

The constructor.

Parameters:

context - is the context.

widgetAdapter - is the widget adapter. Typically null for lazy initialization.

Method Detail

initializeWidgetAdapter

protected void initializeWidgetAdapter(ADAPTER adapter)

This method is called from AbstractUiWidgetNative.getWidgetAdapter() to initialize the UiWidgetAdapter. All attributes of this widget need to be set in the UiWidgetAdapter.

Overrides:

initializeWidgetAdapter in class AbstractUiWidgetActive<ADAPTER extends UiWidgetAdapterAbstractDataSet<ITEM>,VALUE>

Parameters:

adapter - is the UiWidgetAdapter to initialize.

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.

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.

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

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

Specified by:

setTitle in interface AttributeWriteTitle<String>

Parameters:

title - is the new title.

See Also:

AttributeWriteTitleVisible.setTitleVisible(boolean)

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.

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

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.

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.

getSelectionMode

public SelectionMode getSelectionMode()

This method gets the SelectionMode.

Specified by:

getSelectionMode in interface AttributeReadSelectionMode

Returns:

the SelectionMode. Must not be null.

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.

addSelectionHandler

public void addSelectionHandler(UiHandlerEventSelection<ITEM> handler)

This method adds the given UiHandlerEventSelection to this object.

Specified by:

addSelectionHandler in interface UiFeatureSelectedValue<ITEM>

Parameters:

handler - is the UiHandlerEventSelection to add.

removeSelectionHandler

public boolean removeSelectionHandler(UiHandlerEventSelection<ITEM> handler)

This method removes the given UiHandlerEventSelection from this object.

Specified by:

removeSelectionHandler in interface UiFeatureSelectedValue<ITEM>

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.

hasSelectedValue

public boolean hasSelectedValue()

Specified by:

hasSelectedValue in interface AttributeReadSelectedValue<ITEM>

Returns:

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

getSelectionCount

public int getSelectionCount()

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

Specified by:

getSelectionCount in interface AttributeReadSelectedValue<ITEM>

Returns:

the number of selected values.

getSelectedValue

public ITEM getSelectedValue()

This method gets the currently selected value (item).

Specified by:

getSelectedValue in interface AttributeReadSelectedValue<ITEM>

Returns:

the selected value or null if no value is selected.

getSelectedValues

public Collection<ITEM> getSelectedValues()

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

Specified by:

getSelectedValues in interface AttributeReadSelectedValue<ITEM>

Returns:

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

See Also:

AttributeReadSelectedValue.getSelectedValue()

getSelectedValuesInternal

protected Collection<ITEM_CONTAINER> getSelectedValuesInternal()

Internal method to get the direct reference to the selected values.

Returns:

the Collection with all currently selected item containers.

setSelectedValue

public boolean setSelectedValue(ITEM 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<ITEM>

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<ITEM> selectedItems)

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

Parameters:

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

setSelectedValues

public boolean setSelectedValues(Collection<ITEM> selectedItems,
                                 boolean programmatic)

Parameters:

selectedItems - is the Collection with the values to select.

programmatic - - see UiEvent.isProgrammatic().

Returns:

see setSelectedValues(Collection).

See Also:

setSelectedValues(Collection)

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

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.

clearSelection

protected void clearSelection(ITEM_CONTAINER exclusion)

Clears the current selection except for the given exclusion.

Parameters:

exclusion - is the itemContainer to exclude (keep its selection untouched) or null for no exclusion.

isSelected

public boolean isSelected(SelectionChoice choice)

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

Specified by:

isSelected in interface UiFeatureSelectedValue<ITEM>

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

setSelection

protected boolean setSelection(ITEM_CONTAINER itemContainer,
                               SelectionOperation operation)

Updates the selection of the given itemContainer according to the given operation.

Parameters:

itemContainer - is the container with the item to update.

operation - is the SelectionOperation to perform.

Returns:

the new selection state of the itemContainer.

onItemSelection

public void onItemSelection(ITEM_CONTAINER itemContainer,
                            boolean selected,
                            boolean programmatic)

Called from adapter if an item (<ITEM>) has been (de)selected.

Parameters:

itemContainer - is the container with the item to update.

selected - - true if item has been selected, false if deselected.

programmatic - - see UiEvent.isProgrammatic().

doGetSelected

protected boolean doGetSelected(ITEM_CONTAINER container)

Internal method to get the selection status of the item in the given container.

Parameters:

container - is the container with the item to check.

Returns:

true if the item is selected, false otherwise.

doSetSelected

protected abstract void doSetSelected(ITEM_CONTAINER container,
                                      boolean selected)

Internal method to set the selection of the item in the given container. Shall not do anything else (e.g. firing event).

Parameters:

container - is the container with the item to mark.

selected - - true to select, false to deselect.

getAllAvailableItems

public abstract Collection<ITEM_CONTAINER> getAllAvailableItems()

Internal method to get the Collection with all items (currently) available in this widget. In case of lazy loading only those that have already been loaded.
ATTENTION:
The Collection must NOT be modified if retrieved via this method. Implementations will provide separate addItem and removeItem methods.

Returns:

the Collection with all items (currently) available in this widget. In case of lazy loading only those that have already been loaded.

getFirstAvailableItem

protected ITEM_CONTAINER getFirstAvailableItem()

Returns:

the first of the available items.

getLastAvailableItem

protected abstract ITEM_CONTAINER getLastAvailableItem()

Returns:

the last of the available items.

getItemContainer

protected abstract ITEM_CONTAINER getItemContainer(ITEM item)

Gets the existing container for the given item. This method has to be very efficient. You should use a Map for this purpose.

Parameters:

item - is the item to lookup.

Returns:

the container for the given item or null if no such container exists.

getItem

protected abstract ITEM getItem(ITEM_CONTAINER container)

This method gets the item in the given container.

Parameters:

container - is the container of the requested item.

Returns:

the unwrapped item.

asFeatureSelectedValue

public UiFeatureSelectedValue<ITEM> asFeatureSelectedValue()

Specified by:

asFeatureSelectedValue in interface UiWidgetWithSelectedValue<ITEM>

Returns:

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