net.sf.cuf.state

Interface StateAdapter

All Known Implementing Classes:

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

public interface StateAdapter

The StateAdapter interface describes the observer of a State Object.
A StateAdapter monitors one (or none) state object, and notifies its target objects whenever the monitored state changes.
A implementation class of the StateAdapter interfaces defines the semantics of what really happens if the monitored state changes, the StateAdapter interface describes only the protocol to setup/tear down the connections.

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.
String	getName() Return the name of the state adapter.
void	remove(Object pTarget) 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.

Method Detail

getName

String getName()

Return the name of the state adapter.

Returns:

the name of the state (never null)

setName

void setName(String pName)

Set the name of the state adapter.

Parameters:

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

Throws:

IllegalArgumentException - if pName is null

setState

void setState(State pState)

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

Parameters:

pState - null or the state we act upon

add

void add(Object pTarget)

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

Parameters:

pTarget - target we should act on when our state changes

Throws:

IllegalArgumentException - if pTarget is null

addInvert

void addInvert(Object pTarget)

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

Parameters:

pTarget - target we should act on when our state changes

Throws:

IllegalArgumentException - if pTarget is null

add

void add(Object pTarget,
       boolean pInvert)

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

Parameters:

pTarget - target we should act on when our state changes

pInvert - flag if we should invert the state change

Throws:

IllegalArgumentException - if pTarget is null

remove

void remove(Object pTarget)

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

Parameters:

pTarget - target we should remove