javax.swing
Interface SingleSelectionModel

All Known Implementing Classes:
DefaultSingleSelectionModel

public interface SingleSelectionModel

A data model that is used in components that support at most one selected element, like JTabbedPane, JMenu and JPopupMenu.


Method Summary
 void addChangeListener(ChangeListener listener)
          Registers a listener to receive ChangeEvent notifications from this model whenever the selected index changes.
 void clearSelection()
          Clears the selection by setting the selected index to -1 and sends a ChangeEvent to all registered listeners.
 int getSelectedIndex()
          Returns the selected index or -1 if there is no selection.
 boolean isSelected()
          Returns true if there is a selection, and false otherwise.
 void removeChangeListener(ChangeListener listener)
          Deregisters a listener so that it no longer receives ChangeEvent notifications from this model.
 void setSelectedIndex(int index)
          Sets the selected index and, if this is different to the previous selection, sends a ChangeEvent to all registered listeners.
 

Method Detail

getSelectedIndex

int getSelectedIndex()
Returns the selected index or -1 if there is no selection.

Returns:
The selected index.
See Also:
setSelectedIndex(int)

setSelectedIndex

void setSelectedIndex(int index)
Sets the selected index and, if this is different to the previous selection, sends a ChangeEvent to all registered listeners.

Parameters:
index - the index (use -1 to represent no selection).
See Also:
getSelectedIndex(), clearSelection()

clearSelection

void clearSelection()
Clears the selection by setting the selected index to -1 and sends a ChangeEvent to all registered listeners. If the selected index is already -1, this method does nothing.


isSelected

boolean isSelected()
Returns true if there is a selection, and false otherwise.

Returns:
A boolean.

addChangeListener

void addChangeListener(ChangeListener listener)
Registers a listener to receive ChangeEvent notifications from this model whenever the selected index changes.

Parameters:
listener - the listener to add.

removeChangeListener

void removeChangeListener(ChangeListener listener)
Deregisters a listener so that it no longer receives ChangeEvent notifications from this model.

Parameters:
listener - the listener to remove.