net.sf.cuf.state.ui

Class SwingTreeSelectionState

java.lang.Object

net.sf.cuf.state.AbstractState

net.sf.cuf.state.ui.AbstractSwingState

net.sf.cuf.state.ui.SwingTreeSelectionState

All Implemented Interfaces:

EventListener, TreeSelectionListener, State

public class SwingTreeSelectionState
extends AbstractSwingState
implements TreeSelectionListener

The SwingTreeSelectionState class models a State with a TreeSelectionModel of a JTree as the state source. The value of the state is determined by comparing the TreeSelectionsModels's selection with a user-defined TreePath. If the user-defined TreePath is contained in the TreeSelectionModel's selection, the state is true.

Field Summary

Fields inherited from class net.sf.cuf.state.ui.AbstractSwingState

mSilent

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

mIsEnabled, mIsInitialized, mListenerList, mName, mReason

Constructor Summary

Constructors

Constructor and Description
SwingTreeSelectionState(JTree pTree) Creates a new state, using the selection model of the handed tree as its state source.
SwingTreeSelectionState(JTree pTree, TreePath pTreePath) Creates a new state, using the selection model of the handed tree as its state source.
SwingTreeSelectionState(TreeSelectionModel pSelectionModel, TreePath pTreePath) Creates a new state, using the handed selection model as its state source.

Method Summary

Methods

Modifier and Type	Method and Description
protected boolean	getInternalState() Check if mListIndex is selected, if mListIndex is NO_SELECTION, check if there is no selection.
void	setCompareContent(TreePath pTreePath) Sets the TreePath we try to find in the tree selection.
protected void	setReason() Set the source of the state as the reason for a change.
void	valueChanged(TreeSelectionEvent pEvent) Called whenever the value of the selection changes.

Methods inherited from class net.sf.cuf.state.ui.AbstractSwingState

checkStateChange, isSilent, setSilent

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

SwingTreeSelectionState

public SwingTreeSelectionState(JTree pTree)

Creates a new state, using the selection model of the handed tree as its state source. If the selection contains null, then the state is true.

Parameters:

pTree - tree we take the selection model from, must not be null

SwingTreeSelectionState

public SwingTreeSelectionState(JTree pTree,
                       TreePath pTreePath)

Creates a new state, using the selection model of the handed tree as its state source. If the selection contains pTreePath, then the state is true.

Parameters:

pTree - tree we take the selection model from, must not be null

pTreePath - user-provided TreePath we check the selection against, may be null

SwingTreeSelectionState

public SwingTreeSelectionState(TreeSelectionModel pSelectionModel,
                       TreePath pTreePath)

Creates a new state, using the handed selection model as its state source. If the selection contains pTreePath, then the state is true.

Parameters:

pSelectionModel - the selection we monitor, must not be null

pTreePath - user-provided TreePath we check the selection against, may be null

Method Detail

setCompareContent

public void setCompareContent(TreePath pTreePath)

Sets the TreePath we try to find in the tree selection.

Parameters:

pTreePath - user-provided TreePath we check the selection against

valueChanged

public void valueChanged(TreeSelectionEvent pEvent)

Called whenever the value of the selection changes.

Specified by:

valueChanged in interface TreeSelectionListener

Parameters:

pEvent - the event that characterizes the change.

getInternalState

protected boolean getInternalState()

Check if mListIndex is selected, if mListIndex is NO_SELECTION, check if there is no selection.

Specified by:

getInternalState in class AbstractSwingState

Returns:

the state, true if the user provided index is contained in the list selection

setReason

protected void setReason()

Set the source of the state as the reason for a change.

Specified by:

setReason in class AbstractSwingState