net.sf.mmm.client.ui.impl.test.widget.adapter

Class UiWidgetAdapterTestSelectedValue<VALUE>

java.lang.Object

net.sf.mmm.client.ui.base.widget.adapter.AbstractUiWidgetAdapter<Void>

net.sf.mmm.client.ui.impl.test.widget.adapter.UiWidgetAdapterTest

net.sf.mmm.client.ui.impl.test.widget.adapter.UiWidgetAdapterTestSelectedValue<VALUE>

Type Parameters:

VALUE - is the generic type of the #getSelectedValue() selected value}.

All Implemented Interfaces:

AttributeReadAccessKey, AttributeReadAltText, AttributeReadAttribute, AttributeReadCollapsed, AttributeReadColumnSpan, AttributeReadEnabled, AttributeReadFocused, AttributeReadHeightInRows, AttributeReadHtmlId, AttributeReadImage<UiWidgetImage>, AttributeReadLabel, AttributeReadLengthProperty, AttributeReadMaximumTextLength, AttributeReadPrimaryStyle, AttributeReadResizable, AttributeReadSelectedValue<VALUE>, AttributeReadSelectionMode, AttributeReadSizeInPixel, AttributeReadStringTitle, AttributeReadStyles, AttributeReadStylesAdvanced, AttributeReadSummary, AttributeReadTitleVisible, AttributeReadTooltip, AttributeReadUrl, AttributeReadValidationFailure, AttributeWriteAccessKey, AttributeWriteAltText, AttributeWriteAttribute, AttributeWriteCollapsed, AttributeWriteEnabled, AttributeWriteFocused, AttributeWriteHtmlId, AttributeWriteImage<UiWidgetImage>, AttributeWriteLabel, AttributeWriteLengthProperty, AttributeWriteMaximumTextLength, AttributeWriteOnlyAttribute, AttributeWriteOnlyFocused, AttributeWritePrimaryStyle, AttributeWriteSelectedValue<VALUE>, AttributeWriteSelectionMode, AttributeWriteStringTitle, AttributeWriteStyles, AttributeWriteStylesAdvanced, AttributeWriteSummary, AttributeWriteTitleVisible, AttributeWriteTooltip, AttributeWriteUrl, AttributeWriteValidationFailure, UiWidgetAdapter, UiWidgetAdapterActive, UiWidgetAdapterClickable, UiWidgetAdapterWithLabel, UiWidgetAdapterButton, UiWidgetAdapterCollapsableSection, UiWidgetAdapterImage, UiWidgetAdapterLabel, UiWidgetAdapterLink, UiWidgetAdapterSection, UiWidgetAdapterMenuItemClickable, UiWidgetAdapterMenuItemSeparator, AttributeReadDisposed, AttributeReadId<String>, AttributeReadTitle<String>, AttributeWriteDisposed, AttributeWriteId<String>, AttributeWriteTitle<String>, Accessibility

Direct Known Subclasses:

UiWidgetAdapterTestTree

public class UiWidgetAdapterTestSelectedValue<VALUE>
extends UiWidgetAdapterTest
implements AttributeWriteSelectedValue<VALUE>

This class extends UiWidgetAdapterTest and implements AttributeWriteSelectedValue for testing without a native toolkit.

Since:

1.0.0

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

Field Summary

Fields

Modifier and Type	Field and Description
private Collection<VALUE>	selectedValues

Fields inherited from interface net.sf.mmm.client.ui.api.attribute.AttributeReadAccessKey

ACCESS_KEY_NONE, HTML_ATTRIBUTE_ACCESS_KEY

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.client.ui.api.attribute.AttributeReadStringTitle

PROPERTY_TITLE

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

ATTRIBUTE_COLSPAN

Constructor Summary

Constructors

Constructor and Description
UiWidgetAdapterTestSelectedValue() The constructor.

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 AttributeReadSelectedValue.getSelectedValues().size() but more efficient.
boolean	hasSelectedValue()
boolean	setSelectedValue(VALUE selectedValue) This method sets the value currently selected.
boolean	setSelectedValues(Collection<VALUE> selection) This method sets the values currently selected.

Methods inherited from class net.sf.mmm.client.ui.impl.test.widget.adapter.UiWidgetAdapterTest

clearValidationFailureSetCount, createAbsoluteImageUrl, createToplevelWidget, dispose, getHeightInPixel, getLength, getSummary, getValidationFailure, getValidationFailureSetCount, getWidthInPixel, isCollapsed, isTitleVisible, removeFromParent, setAccessKey, setAltText, setAttribute, setCollapsed, setEnabled, setEventSender, setFocused, setId, setImage, setLabel, setLength, setMaximumTextLength, setSelectionMode, setStyles, setSummary, setTitle, setTitleVisible, setTooltip, setUrl, setValidationFailure, setVisible, verifyNotDisposed

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

addStyle, createLabel, getAccessKey, getActiveWidget, getAltText, getAttribute, getBundle, getColumnSpan, getContext, getHeightInRows, getId, getImage, getLabel, getMaximumTextLength, getPrimaryStyle, getSelectionMode, getStyles, getTitle, getTooltip, getToplevelWidget, getUiWidget, getUiWidgetTyped, getUrl, hasStyle, isDisposed, isEnabled, isFocused, isResizable, isStyleDeltaSupported, removeStyle, setMode, setParent, setPrimaryStyle, setUiWidget

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

getMaximumTextLength

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

getAltText

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

getUrl

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

isFocused

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

getAccessKey

Methods inherited from interface net.sf.mmm.client.ui.base.widget.adapter.UiWidgetAdapter

createLabel, getToplevelWidget, isStyleDeltaSupported, setMode, setParent

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

getId

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

getTooltip

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

isDisposed

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

getAttribute

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

getImage

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

getSelectionMode

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

getTitle

Field Detail

selectedValues

private Collection<VALUE> selectedValues

See Also:

getSelectedValues()

Constructor Detail

UiWidgetAdapterTestSelectedValue

public UiWidgetAdapterTestSelectedValue()

The constructor.

Method Detail

hasSelectedValue

public boolean hasSelectedValue()

Specified by:

hasSelectedValue in interface AttributeReadSelectedValue<VALUE>

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

Returns:

the number of selected values.

getSelectedValue

public VALUE getSelectedValue()

This method gets the currently selected value (item).

Specified by:

getSelectedValue in interface AttributeReadSelectedValue<VALUE>

Returns:

the selected value or null if no value is selected.

getSelectedValues

public Collection<VALUE> getSelectedValues()

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

Specified by:

getSelectedValues in interface AttributeReadSelectedValue<VALUE>

Returns:

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

See Also:

AttributeReadSelectedValue.getSelectedValue()

setSelectedValue

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

Specified by:

setSelectedValue in interface AttributeWriteSelectedValue<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

public boolean setSelectedValues(Collection<VALUE> selection)

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

Parameters:

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