net.sf.cuf.state.ui

Class SwingEnabledAdapter

java.lang.Object

net.sf.cuf.state.AbstractStateAdapter

net.sf.cuf.state.ui.SwingEnabledAdapter

All Implemented Interfaces:

EventListener, ChangeListener, StateAdapter

public class SwingEnabledAdapter
extends AbstractStateAdapter

A SwingEnabledAdapter maps the enabling/disabling of the monitored state to the enabling/disabling of a Component or Action. It also provides deep enable/disable capability and setting the JComponent (if it is one) to opaque or not.

Constructor Summary

Constructors

Constructor and Description
SwingEnabledAdapter() Create a new adapter with no state associated.
SwingEnabledAdapter(State pState) Create a new adapter.
SwingEnabledAdapter(State pState, boolean pDeepEnable) Create a new adapter.
SwingEnabledAdapter(State pState, boolean pDeepEnable, boolean pHandleOpaque) Create a new adapter.

Method Summary

Methods

Modifier and Type	Method and Description
protected void	adjustInitialState(Object pTarget, boolean pEnabled) We don't need special treatment for the initial step, and just call processStateChange().
boolean	isDeepEnable() Returns if we enable/disable recursively.
protected void	processStateChange(Object pTarget, boolean pEnabled) We map the pEnabled boolean to the enabled/not enabled behaviour of a AbstractButton or a Action.
void	setDeepEnable(boolean pDeepEnable) Sets if we should enable/disable recursively.

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

add, add, addInvert, getConsistencyCategory, getName, remove, setName, setState, stateChanged

Methods inherited from class java.lang.Object

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

Constructor Detail

SwingEnabledAdapter

public SwingEnabledAdapter()

Create a new adapter with no state associated.

SwingEnabledAdapter

public SwingEnabledAdapter(State pState)

Create a new adapter.

Parameters:

pState - the state we adapt

SwingEnabledAdapter

public SwingEnabledAdapter(State pState,
                   boolean pDeepEnable)

Create a new adapter.

Parameters:

pState - the state we adapt

pDeepEnable - true if we should enable/disable recursively

SwingEnabledAdapter

public SwingEnabledAdapter(State pState,
                   boolean pDeepEnable,
                   boolean pHandleOpaque)

Create a new adapter.

Parameters:

pState - the state we adapt

pDeepEnable - true if we should enable/disable recursively

pHandleOpaque - true if we should also seth the opaque property

Method Detail

setDeepEnable

public void setDeepEnable(boolean pDeepEnable)

Sets if we should enable/disable recursively.

Parameters:

pDeepEnable - true if we should enable/disable recursively

isDeepEnable

public boolean isDeepEnable()

Returns if we enable/disable recursively.

Returns:

true if we enable/disable recursively

adjustInitialState

protected void adjustInitialState(Object pTarget,
                      boolean pEnabled)

We don't need special treatment for the initial step, and just call processStateChange().

Specified by:

adjustInitialState in class AbstractStateAdapter

Parameters:

pTarget - the target we should adjust

pEnabled - the state for the target

processStateChange

protected void processStateChange(Object pTarget,
                      boolean pEnabled)

We map the pEnabled boolean to the enabled/not enabled behaviour of a AbstractButton or a Action.

Specified by:

processStateChange in class AbstractStateAdapter

Parameters:

pTarget - target object, either a Component or a Action

pEnabled - true if the target object should get "enabled"

Throws:

IllegalStateException - if pTarget is not a Component or Action