net.sf.cuf.model.state

Class ValueState

java.lang.Object

net.sf.cuf.state.AbstractState

net.sf.cuf.state.SimpleState

net.sf.cuf.model.state.ValueState

All Implemented Interfaces:

EventListener, ChangeListener, MutableState, State

public class ValueState
extends SimpleState
implements MutableState, ChangeListener

A ValueState object wraps a ValueModel as a MutableState. The true/false state of a MutableState is mapped to setting the value of the ValueModel to Boolean.TRUE/Boolean.FALSE. The isInitialized()/reset() semantics are mapped to setting the value of the ValueModel to null.

Field Summary

Fields inherited from class net.sf.cuf.state.SimpleState

mInSetEnabled

Fields inherited from class net.sf.cuf.state.AbstractState

mIsEnabled, mIsInitialized, mListenerList, mName, mReason

Constructor Summary

Constructors

Constructor and Description
ValueState(ValueModel<?> pModel) We wrap a ValueModel as a MutableState object.

Method Summary

Methods

Modifier and Type	Method and Description
Boolean	getMeaningOfNull()
void	reset() Resets a MutableState to not initilized.
void	setEnabled(boolean pEnabled) Sets the state, the wrapped ValueModel will be set to Boolean.TRUE or Boolean.FALSE.
void	setEnabled(boolean pEnabled, Object pReason) Sets the state with a reason object.
void	setMeaningOfNull(Boolean pMeaningOfNull) configures the behaviour of the state when the value model has the value null.
void	stateChanged(ChangeEvent pEvent) Invoked when the target of the listener has changed its state.

Methods inherited from class net.sf.cuf.state.SimpleState

inSetEnabled

Methods inherited from class net.sf.cuf.state.AbstractState

addChangeListener, checkDisposed, dispose, fireStateChanged, getChangeReason, getDependents, getName, isDisposed, isEnabled, isInitialized, removeChangeListener, setName, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.sf.cuf.state.State

addChangeListener, dispose, getChangeReason, getDependents, getName, isDisposed, isEnabled, isInitialized, removeChangeListener, setName

Constructor Detail

ValueState

public ValueState(ValueModel<?> pModel)

We wrap a ValueModel as a MutableState object.

Parameters:

pModel - model we wrap, must not be null

Throws:

IllegalArgumentException - if pModel is null

Method Detail

setEnabled

public void setEnabled(boolean pEnabled)

Sets the state, the wrapped ValueModel will be set to Boolean.TRUE or Boolean.FALSE.

Specified by:

setEnabled in interface MutableState

Overrides:

setEnabled in class SimpleState

Parameters:

pEnabled - true if the state gets enabled

setEnabled

public void setEnabled(boolean pEnabled,
              Object pReason)

Sets the state with a reason object. The reason object may be null, and is returned to a getChangeReason() call during the callback.

Specified by:

setEnabled in interface MutableState

Overrides:

setEnabled in class SimpleState

Parameters:

pEnabled - true if the state gets enabled

pReason - null or reason for the change

reset

public void reset()

Resets a MutableState to not initilized. Calling this method will not trigger a notification of the (State) listeners. The value of the ValueModel will be set to null.

Specified by:

reset in interface MutableState

Overrides:

reset in class SimpleState

setMeaningOfNull

public void setMeaningOfNull(Boolean pMeaningOfNull)

configures the behaviour of the state when the value model has the value null. If the parameter is null (default), then a value of null in the value model means that the state will be not AbstractState.isInitialized(). If the parameter is Boolean.TRUE, then a value of null in the value model means that the state is enabled. If the parameter is Boolean.FALSE, then a value of null in the value model means that the state is disabled.

Parameters:

pMeaningOfNull - the meaning of null

getMeaningOfNull

public Boolean getMeaningOfNull()

Returns:

the meaning of null

See Also:

setMeaningOfNull(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