net.sf.cuf.state.ui

Class AbstractSwingState

java.lang.Object

net.sf.cuf.state.AbstractState

net.sf.cuf.state.ui.AbstractSwingState

All Implemented Interfaces:

State

Direct Known Subclasses:

SwingDocumentState, SwingEnabledState, SwingListModelFillState, SwingListSelectionState, SwingSelectedState, SwingTableModelFillState, SwingTreeModelFillState, SwingTreeSelectionState

public abstract class AbstractSwingState
extends AbstractState
implements State

AbstractSwingState has the common boiler plate code for the various States in this package. To avoid a "broadcast storm" of firing AbstractSwingState's, a AbstractSwingState can be switched to "silent", in that case it ignores all changes.

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	mSilent flag if we ignore all changes

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

mIsEnabled, mIsInitialized, mListenerList, mName, mReason

Constructor Summary

Constructors

Constructor and Description
AbstractSwingState() The constructor initializes some member variables.

Method Summary

Methods

Modifier and Type	Method and Description
protected void	checkStateChange() Check if our monitored state changed, if it did fireStateChanged().
protected abstract boolean	getInternalState() Template method for the Strategy pattern: a derived class should return the state of its state abstraction.
boolean	isSilent() Checks the silent mode, returns true if we ignore a changing document.
protected abstract void	setReason() Template method for the Strategy pattern: a derived class should set mReason in this method.
void	setSilent(boolean pSilent) Switches silent mode on or off.

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

Field Detail

mSilent

protected boolean mSilent

flag if we ignore all changes

Constructor Detail

AbstractSwingState

public AbstractSwingState()

The constructor initializes some member variables.

Method Detail

isSilent

public boolean isSilent()

Checks the silent mode, returns true if we ignore a changing document.

Returns:

true if we are in silent mode

setSilent

public void setSilent(boolean pSilent)

Switches silent mode on or off. Switching silent mode off may trigger an update if our current state is different from our document state.

Parameters:

pSilent - true if we should ignore changes

checkStateChange

protected void checkStateChange()

Check if our monitored state changed, if it did fireStateChanged().

getInternalState

protected abstract boolean getInternalState()

Template method for the Strategy pattern: a derived class should return the state of its state abstraction.

Returns:

the current state

setReason

protected abstract void setReason()

Template method for the Strategy pattern: a derived class should set mReason in this method.