net.sf.cuf.state

Class AbstractStateAdapter

java.lang.Object

net.sf.cuf.state.AbstractStateAdapter

All Implemented Interfaces:

EventListener, ChangeListener, StateAdapter

Direct Known Subclasses:

SwingBackgroundAdapter, SwingBorderAdapter, SwingEditableAdapter, SwingEnabledAdapter, SwingGlassPaneAdapter, SwingJTableEnabledAdapter, SwingSelectedAdapter, SwingVisibleAdapter

public abstract class AbstractStateAdapter
extends Object
implements StateAdapter, ChangeListener

This abstract implementation of StateAdapter handels all of the bookkeeping work and delegates the "real" work (adapting of a state change to a target object) to its subclasses.

Constructor Summary

Constructors

Constructor and Description
AbstractStateAdapter() Creates a new adapter, that monitors no state and has an empty string as its name.
AbstractStateAdapter(State pState) Creates a new adapter, that monitors the handed state and has an empty string as its name.
AbstractStateAdapter(State pState, String pName) Creates a new adapter, that monitors the handed state and uses the handed string as its name.

Method Summary

Methods

Modifier and Type	Method and Description
void	add(Object pTarget) Add a target object to our adapter.
void	add(Object pTarget, boolean pInvert) Add a target object to our adapter.
void	addInvert(Object pTarget) Add a target object with inverted state change logic to our adapter.
protected abstract void	adjustInitialState(Object pTarget, boolean pEnabled) Implement this method in a subclass to set the initial state of a target object.
protected String	getConsistencyCategory() This implementation returns the full class name to be used as a key in the CONSISTENCY_MAP.
String	getName() Return the name of the state adapter.
protected abstract void	processStateChange(Object pTarget, boolean pEnabled) Implement this method in a subclass to set the state of a target object after our monitored state changes.
void	remove(Object pComponent) Removes the handed object of our adapter.
void	setName(String pName) Set the name of the state adapter.
void	setState(State pState) Sets (or resets if pState=null) the state this adapter acts on.
void	stateChanged(ChangeEvent pEvent) Internal method to monitor our state, don't call this.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractStateAdapter

public AbstractStateAdapter()

Creates a new adapter, that monitors no state and has an empty string as its name.

AbstractStateAdapter

public AbstractStateAdapter(State pState)

Creates a new adapter, that monitors the handed state and has an empty string as its name.

Parameters:

pState - the state we adopt to, may be null

AbstractStateAdapter

public AbstractStateAdapter(State pState,
                    String pName)

Creates a new adapter, that monitors the handed state and uses the handed string as its name.

Parameters:

pState - the state we adopt to, may be null

pName - our name

Throws:

IllegalArgumentException - if pName is null

Method Detail

getName

public String getName()

Description copied from interface: StateAdapter

Return the name of the state adapter.

Specified by:

getName in interface StateAdapter

Returns:

the name of the state (never null)

setName

public void setName(String pName)

Description copied from interface: StateAdapter

Set the name of the state adapter.

Specified by:

setName in interface StateAdapter

Parameters:

pName - the name of the state (must not be null)

setState

public void setState(State pState)

Description copied from interface: StateAdapter

Sets (or resets if pState=null) the state this adapter acts on.

Specified by:

setState in interface StateAdapter

Parameters:

pState - null or the state we act upon

add

public void add(Object pTarget)

Description copied from interface: StateAdapter

Add a target object to our adapter. What happens to the target is depending on the concrete implementaion.

Specified by:

add in interface StateAdapter

Parameters:

pTarget - target we should act on when our state changes

addInvert

public void addInvert(Object pTarget)

Description copied from interface: StateAdapter

Add a target object with inverted state change logic to our adapter. What happens to the target is depending on the concrete implementaion.

Specified by:

addInvert in interface StateAdapter

Parameters:

pTarget - target we should act on when our state changes

add

public void add(Object pTarget,
       boolean pInvert)

Description copied from interface: StateAdapter

Add a target object to our adapter. What happens to the target is depending on the concrete implementaion.

Specified by:

add in interface StateAdapter

Parameters:

pTarget - target we should act on when our state changes

pInvert - flag if we should invert the state change

getConsistencyCategory

protected String getConsistencyCategory()

This implementation returns the full class name to be used as a key in the CONSISTENCY_MAP. Override to match if your implementation affects the same property of a target as another implementation.

Returns:

the category for which the duplicate check should be done, used as key in the CONSISTENCY_MAP

remove

public void remove(Object pComponent)

Description copied from interface: StateAdapter

Removes the handed object of our adapter. Does nothing if pTarget is null or unknown.

Specified by:

remove in interface StateAdapter

Parameters:

pComponent - target we should remove

stateChanged

public void stateChanged(ChangeEvent pEvent)

Internal method to monitor our state, don't call this.

Specified by:

stateChanged in interface ChangeListener

Parameters:

pEvent - not used

adjustInitialState

protected abstract void adjustInitialState(Object pTarget,
                      boolean pEnabled)

Implement this method in a subclass to set the initial state of a target object.

Parameters:

pTarget - target object, never null

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

processStateChange

protected abstract void processStateChange(Object pTarget,
                      boolean pEnabled)

Implement this method in a subclass to set the state of a target object after our monitored state changes.

Parameters:

pTarget - target object, never null

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