net.sf.cuf.model.state

Class StateValue

java.lang.Object

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

net.sf.cuf.model.state.StateValue

All Implemented Interfaces:

EventListener, ChangeListener, ExternalUpdate, ValueModel<Boolean>

public class StateValue
extends AbstractValueModel<Boolean>
implements ValueModel<Boolean>, ChangeListener

A StateValue object wraps a State object as a ValueModel. Whenever the State object changes, we fire a ChangeEvent, too.

Constructor Summary

Constructors

Constructor and Description
StateValue(State pState) We wrap a State object as a ValueModel.

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.
State	getState() Return the state we wrap.
Boolean	getValue() Get the current value, during a callback this is the new value.
boolean	isEditable() Returns true if our backing state is mutable.
void	setValue(Boolean 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 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, 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

Constructor Detail

StateValue

public StateValue(State pState)

We wrap a State object as a ValueModel.

Parameters:

pState - state we wrap, must not be null

Throws:

IllegalArgumentException - if pState is null

Method Detail

isEditable

public boolean isEditable()

Returns true if our backing state is mutable.

Specified by:

isEditable in interface ValueModel<Boolean>

Returns:

true if setValue() can be called

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

Overrides:

dispose in class AbstractValueModel<Boolean>

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

getState

public State getState()

Return the state we wrap.

Returns:

the state we wrap, never null

setValue

public void setValue(Boolean pValue,
            boolean pIsSetForced)

Set a new value, this will fire a ChangeEvent if the new value is different from the old value.

Specified by:

setValue in interface ValueModel<Boolean>

Parameters:

pValue - the new Boolean value (null is o.k. and interpreted as false)

pIsSetForced - true if a forced setValue should be done

Throws:

UnsupportedOperationException - if the State we wrap is not not mutable

getValue

public Boolean getValue()

Get the current value, during a callback this is the new value.

Specified by:

getValue in interface ValueModel<Boolean>

Returns:

Boolean.TRUE or Boolean.FALSE, never null