net.sf.cuf.state.ui

Class SwingListSelectionState

java.lang.Object

net.sf.cuf.state.AbstractState

net.sf.cuf.state.ui.AbstractSwingState

net.sf.cuf.state.ui.SwingListSelectionState

All Implemented Interfaces:

ActionListener, EventListener, ListDataListener, ListSelectionListener, TableModelListener, State

public class SwingListSelectionState
extends AbstractSwingState
implements ListSelectionListener, ActionListener, TableModelListener, ListDataListener

The SwingListSelectionState class models a State with the ListSelectionModel of a Swing JTable or JList as the state source. The value of the state is determined by comparing the ListSelectionModel's selection with a user-defined selection index. If the user-defined index is contained in the ListSelectionModel's selection, the state is true. The state also supports "reverse index" match so you can can not only check e.g. if the first row is selected but also if the last row is selected.

Field Summary

Fields

Modifier and Type	Field and Description
static int	NO_SELECTION The marker for no selection.

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
SwingListSelectionState(JComboBox pComboBox) Creates a new state, using the selection model of the handed combobox as its state source.
SwingListSelectionState(JComboBox pComboBox, int pIndex) Creates a new state, using the selection model of the handed table as its state source.
SwingListSelectionState(JComboBox pComboBox, int pIndex, boolean pReverseIndex) Creates a new state, using the selection model of the handed table as its state source.
SwingListSelectionState(JList pList) Creates a new state, using the selection model of the handed list as its state source.
SwingListSelectionState(JList pList, int pIndex) Creates a new state, using the selection model of the handed list as its state source.
SwingListSelectionState(JList pList, int pIndex, boolean pReverseIndex) Creates a new state, using the selection model of the handed list as its state source.
SwingListSelectionState(JTable pTable) Creates a new state, using the selection model of the handed table as its state source.
SwingListSelectionState(JTable pTable, int pIndex) Creates a new state, using the selection model of the handed table as its state source.
SwingListSelectionState(JTable pTable, int pIndex, boolean pReverseIndex) Creates a new state, using the selection model of the handed table as its state source.
SwingListSelectionState(ListSelectionModel pSelectionModel, int pIndex) Creates a new state, using the handed selection model as its state source.

Method Summary

Methods

Modifier and Type	Method and Description
void	actionPerformed(ActionEvent pEvent) Handler for combobox callbacks.
void	contentsChanged(ListDataEvent pEvent) Called whenever our combo box or list data data changes.
protected boolean	getInternalState() Check if mListIndex is selected, if mListIndex is NO_SELECTION, check if there is no selection.
void	intervalAdded(ListDataEvent pEvent) Called whenever our combo box or list data data changes.
void	intervalRemoved(ListDataEvent pEvent) Called whenever our combo box or list data data changes.
void	setCompareContent(int pIndex) Sets the index we try to find in the list selection.
protected void	setReason() Set the source of the state as the reason for a change.
void	tableChanged(TableModelEvent pEvent) Called whenever our table model changes.
void	valueChanged(ListSelectionEvent 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

Field Detail

NO_SELECTION

public static final int NO_SELECTION

The marker for no selection.

See Also:

Constant Field Values

Constructor Detail

SwingListSelectionState

public SwingListSelectionState(JList pList)

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

Parameters:

pList - list we take the selection model from, must not be null

SwingListSelectionState

public SwingListSelectionState(JList pList,
                       int pIndex)

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

Parameters:

pList - list we take the selection model from, must not be null

pIndex - user-provided index we check the selection against

SwingListSelectionState

public SwingListSelectionState(JList pList,
                       int pIndex,
                       boolean pReverseIndex)

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

Parameters:

pList - list we take the selection model from, must not be null

pIndex - user-provided index we check the selection against

pReverseIndex - flag if we should take the index as a reverse index

SwingListSelectionState

public SwingListSelectionState(JTable pTable)

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

Parameters:

pTable - table we take the selection model from, must not be null

SwingListSelectionState

public SwingListSelectionState(JTable pTable,
                       int pIndex)

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

Parameters:

pTable - table we take the selection model from.

pIndex - user-provided index we check the selection against

SwingListSelectionState

public SwingListSelectionState(JTable pTable,
                       int pIndex,
                       boolean pReverseIndex)

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

Parameters:

pTable - table we take the selection model from.

pIndex - user-provided index we check the selection against

pReverseIndex - flag if we should take the index as a reverse index

SwingListSelectionState

public SwingListSelectionState(ListSelectionModel pSelectionModel,
                       int pIndex)

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

Parameters:

pSelectionModel - the selection we monitor

pIndex - user-provided index we check the selection against

SwingListSelectionState

public SwingListSelectionState(JComboBox pComboBox)

Creates a new state, using the selection model of the handed combobox as its state source. If the selection is NO_SELECTION, then the state is true.

Parameters:

pComboBox - combobox we take the model from, must not be null

SwingListSelectionState

public SwingListSelectionState(JComboBox pComboBox,
                       int pIndex)

Creates a new state, using the selection model of the handed table as its state source. If the selection is pIndex, then the state is true.

Parameters:

pComboBox - combobox we take the model from, must not be null

pIndex - user-provided index we check the selection against

SwingListSelectionState

public SwingListSelectionState(JComboBox pComboBox,
                       int pIndex,
                       boolean pReverseIndex)

Creates a new state, using the selection model of the handed table as its state source. If the selection is pIndex, then the state is true.

Parameters:

pComboBox - combobox we take the model from, must not be null

pIndex - user-provided index we check the selection against

pReverseIndex - flag if we should take the index as a reverse index

Method Detail

setCompareContent

public void setCompareContent(int pIndex)

Sets the index we try to find in the list selection.

Parameters:

pIndex - user-provided index we check the selection against

valueChanged

public void valueChanged(ListSelectionEvent pEvent)

Called whenever the value of the selection changes.

Specified by:

valueChanged in interface ListSelectionListener

Parameters:

pEvent - the event that characterizes the change.

tableChanged

public void tableChanged(TableModelEvent pEvent)

Called whenever our table model changes.

Specified by:

tableChanged in interface TableModelListener

Parameters:

pEvent - the event that characterizes the change.

intervalAdded

public void intervalAdded(ListDataEvent pEvent)

Called whenever our combo box or list data data changes.

Specified by:

intervalAdded in interface ListDataListener

Parameters:

pEvent - the event that characterizes the change.

intervalRemoved

public void intervalRemoved(ListDataEvent pEvent)

Called whenever our combo box or list data data changes.

Specified by:

intervalRemoved in interface ListDataListener

Parameters:

pEvent - the event that characterizes the change.

contentsChanged

public void contentsChanged(ListDataEvent pEvent)

Called whenever our combo box or list data data changes.

Specified by:

contentsChanged in interface ListDataListener

Parameters:

pEvent - the event that characterizes the change.

actionPerformed

public void actionPerformed(ActionEvent pEvent)

Handler for combobox callbacks.

Specified by:

actionPerformed in interface ActionListener

Parameters:

pEvent - not used

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/combobox selection

setReason

protected void setReason()

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

Specified by:

setReason in class AbstractSwingState