net.sf.cuf.model

Class IndexedAdapter<T>

java.lang.Object

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

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

Type Parameters:

T - the type inside the list

All Implemented Interfaces:

EventListener, ChangeListener, ExternalUpdate, ValueModel<T>

public class IndexedAdapter<T>
extends AbstractValueModel<T>
implements ValueModel<T>, ExternalUpdate, ChangeListener

A IndexedAdapter is a ValueModel that takes an entry of a List as its value.
A IndexedAdapter is simular to an AspectAdapter, it provides one item of a list as its own value. To detect changes in the list, the list must be the value of a ValueModel. If the the ValueModel holding the list is a SelectionInList, the index of the IndexedAdapter follows the selection in the list. If the list is not wrapped in a ValueModel, a change of the list can't be detected.
When the wrapped list changes, the index in that list is set to NO_SELECTION if there is no IndexProvider.
We also support the notion of an external update.

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
void	dispose() Cleanup all resources: disconnect from any input sources (like other ValueModel's ...), and remove all listeners.
int	getIndex() Get the current index.
ValueModel<List<T>>	getTrigger() Return the Trigger or null if there is no trigger.
T	getValue() Get the current value, during a callback this is the new value.
void	indexChanged(ChangeEvent pEvent) Callback from our SelectionInList value model if it's index changed.
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).
void	setIndex(int pIndex) Set the index, if the index is different from the old index wie fire a state change.
void	setValue(T pValue, boolean pIsSetForced) Set a new value, this will fire a ChangeEvent if the new value is different from the old value.
void	signalExternalUpdate() Signal this object that portions of its data changed.
void	stateChanged(ChangeEvent pEvent) Invoked when the target of the listener has 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, 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

Constructor Detail

IndexedAdapter

public IndexedAdapter(ValueModel<List<T>> pTrigger)

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

Parameters:

pTrigger - the list we are indexing into is the trigger's value

Throws:

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

IndexedAdapter

public IndexedAdapter(ValueModel<List<T>> pTrigger,
              int pIndex)

Creates a new IndexedAdapter.

Parameters:

pTrigger - the list we are indexing into is the trigger's value

pIndex - NO_SELECTION or the initial index in the list

Throws:

IllegalArgumentException - if pTrigger or pTrigger.getValue() is null or not a List or pIndex is out of range

IndexedAdapter

public IndexedAdapter(List<T> pSource)

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

Parameters:

pSource - the list we are indexing into

Throws:

IllegalArgumentException - if pSource is null

IndexedAdapter

public IndexedAdapter(List<T> pSource,
              int pIndex)

Creates a new IndexedAdapter.

Parameters:

pSource - the list we are indexing into

pIndex - NO_SELECTION or the initial index in the list

Throws:

IllegalArgumentException - if pSource is null or pIndex is out of range

Method Detail

getTrigger

public ValueModel<List<T>> getTrigger()

Return the Trigger or null if there is no trigger.

Returns:

null or the trigger

isEditable

public boolean isEditable()

Returns always true

Specified by:

isEditable in interface ValueModel<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<T>

Overrides:

dispose in class AbstractValueModel<T>

setValue

public void setValue(T pValue,
            boolean pIsSetForced)

Set a new value, this will fire a ChangeEvent if the new value is different from the old value. If no list is available or no value is selected, nothing happens

Specified by:

setValue in interface ValueModel<T>

Parameters:

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

pIsSetForced - true if a forced setValue should be done

getValue

public T getValue()

Get the current value, during a callback this is the new value. If no list is available or no item is selected, null is returned.

Specified by:

getValue in interface ValueModel<T>

Returns:

null or the value object

setIndex

public void setIndex(int pIndex)

Set the index, if the index is different from the old index wie fire a state change.

Parameters:

pIndex - the new index

getIndex

public int getIndex()

Get the current index.

Returns:

NO_SELECTION or the current index

indexChanged

public void indexChanged(ChangeEvent pEvent)

Callback from our SelectionInList value model if it's index changed.

Parameters:

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

signalExternalUpdate

public void signalExternalUpdate()

Signal this object that portions of its data changed. If we have a trigger, we notify it, and assume that it will notify us, otherwise we notify our children directly.

Specified by:

signalExternalUpdate in interface ExternalUpdate

Overrides:

signalExternalUpdate in class AbstractValueModel<T>

stateChanged

public void stateChanged(ChangeEvent pEvent)

Invoked when the target of the listener has changed its state.

Specified by:

stateChanged in interface ChangeListener

Parameters:

pEvent - a ChangeEvent object