net.sf.cuf.model

Class SelectionInList<T>

java.lang.Object

net.sf.cuf.model.AbstractValueModel<List<T>>

net.sf.cuf.model.SelectionInList<T>

Type Parameters:

T - the Type inside the list we monitor the selection

All Implemented Interfaces:

EventListener, ChangeListener, ExternalUpdate, IndexProvider, ValueModel<List<T>>

public class SelectionInList<T>
extends AbstractValueModel<List<T>>
implements ValueModel<List<T>>, ChangeListener, ExternalUpdate, IndexProvider

A SelectionInList holds both the data as well as the selection as a ValueModel. A SelectionInList differs from an IndexedAdapter in the following points:

• the users of an IndexedAdapter doesn't know that a list is used at all, they are usally interrested in the aspect of one entry in the list
• the SelectionInList holds both the data as well as the selection

Typical users of a SelectionInList are adapters for comboboxes, radiobuttons, ... . This users are interested in the list as a whole, as well as in the selection index.

Field Summary

Fields

Modifier and Type	Field and Description
static Integer	NO_SELECTION no selection as an Integer object

Constructor Summary

Constructors

Constructor and Description
SelectionInList(List<T> pList) Creates a new SelectionInList that does not select an entry in the list.
SelectionInList(List<T> pList, int pIndex) Creates a new SelectionInList.
SelectionInList(ValueModel<List<T>> pListHolder) Creates a new SelectionInList that does not select an entry in the list.
SelectionInList(ValueModel<List<T>> pListHolder, int pIndex) Creates a new SelectionInList that does not select an entry in the list.

Method Summary

Methods

Modifier and Type	Method and Description
void	addItem(int pIndex, T pItem) Add an item to the underlying list at the given position.
void	addItem(T pItem) Add an item to the underlying list at the current position or at the end of the list if there is currently no selection.
void	dispose() Cleanup all resources: disconnect from any input sources (like other ValueModel's ...), and remove all listeners.
int	getIndex() Return the index of the currently selected item in our list.
Comparator<?>	getSelectionComparator()
List<T>	getValue() Get the current list.
boolean	isEditable() Returns always true
ValueModel<Boolean>	isIndexInList() The provided ValueModel can be used to monitor if this IndexedAdapter holds a "valid" value (index is not NO_SELECTION).
boolean	isKeepSelection()
ValueModel<List<T>>	listHolder() Provides the ValueModel of the ListHolder for our List.
Object	removeItem() Removes the currently selecte item, or does nothing if no item is selected.
Object	removeItem(int pIndex) Remove the item at the handed position.
ValueModel<Integer>	selectionHolder() The provided ValueModel can be used to monitor and change the selection in our list.
void	setKeepSelection(boolean pKeepSelection) defines the behavior of the selection when the list changes.
void	setSelectionComparator(Comparator<T> pSelectionComparator) sets the comparator to use to find the object if mKeepSelection is true
void	setValue(List<T> pValue, boolean pIsSetForced) Set a new value, this will fire a ChangeEvent if the new value is different from the old value.
void	stateChanged(ChangeEvent pEvent) Invoked when the value model holding our list changed its state.

Methods inherited from class net.sf.cuf.model.AbstractValueModel

addChangeListener, booleanValue, checkDisposed, doubleValue, fireStateChanged, floatValue, getDependents, getName, intValue, isDisposed, isInSetValue, isSetForced, longValue, onChangeSend, removeChangeListener, retractInterestsFor, setInSetValue, setName, setObjectValue, setValue, setValue, setValue, setValue, setValue, setValue, setValueForced, signalExternalUpdate, stringValue

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.sf.cuf.model.ValueModel

addChangeListener, booleanValue, doubleValue, floatValue, getDependents, getName, intValue, isDisposed, isSetForced, longValue, onChangeSend, removeChangeListener, retractInterestsFor, setName, setObjectValue, setValue, setValue, setValue, setValue, setValue, setValue, setValueForced, stringValue

Methods inherited from interface net.sf.cuf.model.ExternalUpdate

signalExternalUpdate

Field Detail

NO_SELECTION

public static final Integer NO_SELECTION

no selection as an Integer object

Constructor Detail

SelectionInList

public SelectionInList(ValueModel<List<T>> pListHolder)

Creates a new SelectionInList that does not select an entry in the list.

Parameters:

pListHolder - the list we monitor the selection is the value of pListHolder

Throws:

IllegalArgumentException - if pListHolder is null or pListHolder.getValue() is not null and not a List

SelectionInList

public SelectionInList(ValueModel<List<T>> pListHolder,
               int pIndex)

Creates a new SelectionInList that does not select an entry in the list.

Parameters:

pListHolder - the list we monitor the selection is the value of pListHolder

pIndex - NO_SELECTION or the initial index in the list

Throws:

IllegalArgumentException - if pListHolder is null or the value if pListHolder is neither null nor a List or pIndex is out of range

SelectionInList

public SelectionInList(List<T> pList)

Creates a new SelectionInList that does not select an entry in the list.

Parameters:

pList - the list we are indexing into, may be null

SelectionInList

public SelectionInList(List<T> pList,
               int pIndex)

Creates a new SelectionInList.

Parameters:

pList - the list we are indexing into, may be null

pIndex - NO_SELECTION or the initial index in the list

Throws:

IllegalArgumentException - if pIndex is out of range

Method Detail

isEditable

public boolean isEditable()

Returns always true

Specified by:

isEditable in interface ValueModel<List<T>>

Returns:

true

dispose

public void dispose()

Cleanup all resources: disconnect from any input sources (like other ValueModel's ...), and remove all listeners.

Specified by:

dispose in interface ValueModel<List<T>>

Overrides:

dispose in class AbstractValueModel<List<T>>

setKeepSelection

public void setKeepSelection(boolean pKeepSelection)

defines the behavior of the selection when the list changes.

Parameters:

pKeepSelection - if true, we try to keep the selected object, if false, the selection is cleared.

See Also:

mKeepSelection

isKeepSelection

public boolean isKeepSelection()

Returns:

true if we try to keep the selected object when the list changes, false if the selection will be cleared

See Also:

mKeepSelection

getSelectionComparator

public Comparator<?> getSelectionComparator()

Returns:

the comparator used to find the object if mKeepSelection is true

See Also:

mKeepSelection

setSelectionComparator

public void setSelectionComparator(Comparator<T> pSelectionComparator)

sets the comparator to use to find the object if mKeepSelection is true

Parameters:

pSelectionComparator - the new comparator, may be null. If null, Object.equals(Object) will be used.

See Also:

mKeepSelection

setValue

public void setValue(List<T> pValue,
            boolean pIsSetForced)

Set a new value, this will fire a ChangeEvent if the new value is different from the old value. The new value must be a List or null, if we have a list holder we set the list to the value holder.

Specified by:

setValue in interface ValueModel<List<T>>

Parameters:

pValue - the new list (null is o.k.)

pIsSetForced - true if a forced setValue should be done

Throws:

IllegalArgumentException - if pValue is neither a List nor null

getValue

public List<T> getValue()

Get the current list.

Specified by:

getValue in interface ValueModel<List<T>>

Returns:

null or our list

getIndex

public int getIndex()

Return the index of the currently selected item in our list.

Specified by:

getIndex in interface IndexProvider

Returns:

NO_SELECTION or our index

addItem

public void addItem(T pItem)

Add an item to the underlying list at the current position or at the end of the list if there is currently no selection.

Parameters:

pItem - the item to add

addItem

public void addItem(int pIndex,
           T pItem)

Add an item to the underlying list at the given position. If the List is inside a ValueModel, re-set the list to that value model. The current index is updated to match pIndex before firing a state-change.

Parameters:

pIndex - the index to add the item

pItem - the item to add

removeItem

public Object removeItem(int pIndex)

Remove the item at the handed position. If the current index would no longer be valid (when removing the last item or a list), the current index is set first to the list size - 1 or to NO_SELECTION before firing a state-change.

Parameters:

pIndex - NO_SELECTION or 0..list size-1

Returns:

null or the object at that list position

removeItem

public Object removeItem()

Removes the currently selecte item, or does nothing if no item is selected.

Returns:

null or the object at the removed position

stateChanged

public void stateChanged(ChangeEvent pEvent)

Invoked when the value model holding our list changed its state.

Specified by:

stateChanged in interface ChangeListener

Parameters:

pEvent - a ChangeEvent object, not used

isIndexInList

public ValueModel<Boolean> isIndexInList()

The provided ValueModel can be used to monitor if this IndexedAdapter holds a "valid" value (index is not NO_SELECTION). The ValueModel is read-only, and contains either Boolean.TRUE or Boolean.FALSE.

Returns:

a ValueModel with a Boolean value

selectionHolder

public ValueModel<Integer> selectionHolder()

The provided ValueModel can be used to monitor and change the selection in our list. The value of the ValueModel is and an Integer (never null) holding the index or NO_SELECTION if there is no valid index.

Returns:

a ValueModel with a Integer value

listHolder

public ValueModel<List<T>> listHolder()

Provides the ValueModel of the ListHolder for our List.

Returns:

ValueModel holding our list, may be null