All Packages  Class Hierarchy  This Package  Previous  Next  Index

Interface com.sun.java.swing.ListSelectionModel

public interface ListSelectionModel
This interface represents the current state of the selection for any of the components that display a list of values with stable indices. The selection is modeled as a set of intervals, each interval represents a contiguous range of selected list elements. List controllers may enforce more limited selections, e.g. only one index at a time, or only one interval. The methods for modifying the set of selected intervals all take a pair of indices, index0 and index1, that represent a closed interval, i.e. the interval includes both index0 and index1.

See Also:
JListSelectionModel

Method Index

 o addListSelectionListener(ListSelectionListener)
Add a listener to the list that's notified each time a change to the selection occurs.
 o addSelectionInterval(int, int)
Change the selection to be the set union of the current selection and the indices between index0 and index1 inclusive.
 o clearSelection()
Change the selection to the empty set.
 o getAnchorSelectionIndex()
Return the first and second arguments from the most recent call to setSelectionInterval() or addSelectionInterval().
 o getLeadSelectionIndex()
 o getMaxSelectionIndex()
Returns the last selected index or -1 if the selection is empty.
 o getMinSelectionIndex()
Returns the first selected index or -1 if the selection is empty.
 o getValueIsAdjusting()
Returns the state of model.
 o insertIndexInterval(int, int, boolean)
Insert length indices beginning before/after index.
 o isSelectedIndex(int)
Returns true if the specified index is selected.
 o isSelectionEmpty()
Returns true if no indices are selected.
 o removeIndexInterval(int, int)
Remove the indices in the interval index0,index1 (inclusive) from the selection model.
 o removeListSelectionListener(ListSelectionListener)
Remove a listener from the list that's notified each time a change to the selection occurs.
 o removeSelectionInterval(int, int)
Change the selection to be the set difference of the current selection and the indices between index0 and index1 inclusive.
 o setSelectionInterval(int, int)
Change the selection to be between index0 and index1 inclusive.
 o setValueIsAdjusting(boolean)

This attribute indicates that any upcoming changes to the value of the model should be considered a single event.

Methods

 o setSelectionInterval
 public abstract void setSelectionInterval(int index0,
                                           int index1)
Change the selection to be between index0 and index1 inclusive. If this represents a change to the current selection, then notify each SelectionListener. Note that index0 doesn't have to be less than or equal to index1.

Parameters:
index0 - one end of the interval.
index1 - other end of the interval
 o addSelectionInterval
 public abstract void addSelectionInterval(int index0,
                                           int index1)
Change the selection to be the set union of the current selection and the indices between index0 and index1 inclusive. If this represents a change to the current selection, then notify each SelectionListener. Note that index0 doesn't have to be less than or equal to index1.

Parameters:
index0 - one end of the interval.
index1 - other end of the interval
 o removeSelectionInterval
 public abstract void removeSelectionInterval(int index0,
                                              int index1)
Change the selection to be the set difference of the current selection and the indices between index0 and index1 inclusive. If this represents a change to the current selection, then notify each SelectionListener. Note that index0 doesn't have to be less than or equal to index1.

Parameters:
index0 - one end of the interval.
index1 - other end of the interval
 o getMinSelectionIndex
 public abstract int getMinSelectionIndex()
Returns the first selected index or -1 if the selection is empty.

 o getMaxSelectionIndex
 public abstract int getMaxSelectionIndex()
Returns the last selected index or -1 if the selection is empty.

 o isSelectedIndex
 public abstract boolean isSelectedIndex(int index)
Returns true if the specified index is selected.

 o getAnchorSelectionIndex
 public abstract int getAnchorSelectionIndex()
Return the first and second arguments from the most recent call to setSelectionInterval() or addSelectionInterval(). The most recent index0 is considered the "anchor" and the most recent index1 is considered the "lead". Some interfaces display these indices specially, e.g. Windows displays the lead index with a dotted yellow outline.

 o getLeadSelectionIndex
 public abstract int getLeadSelectionIndex()
 o clearSelection
 public abstract void clearSelection()
Change the selection to the empty set. If this represents a change to the current selection then notify each SelectionListener.

 o isSelectionEmpty
 public abstract boolean isSelectionEmpty()
Returns true if no indices are selected.

 o insertIndexInterval
 public abstract void insertIndexInterval(int index,
                                          int length,
                                          boolean before)
Insert length indices beginning before/after index. This is typically called to sync the selection model with a corresponding change in the data model.

 o removeIndexInterval
 public abstract void removeIndexInterval(int index0,
                                          int index1)
Remove the indices in the interval index0,index1 (inclusive) from the selection model. This is typically called to sync the selection model width a corresponding change in the data model.

 o setValueIsAdjusting
 public abstract void setValueIsAdjusting(boolean b)

This attribute indicates that any upcoming changes to the value of the model should be considered a single event. This attribute will be set to true at the start of a range of changes to the value, and will be set to false when the value has completed changing. Normally this allows a listener to only take action when the final value change in committed, instead of having to do updates for all intermediate values.

Parameters:
b - the model's new state
See Also:
getValueIsAdjusting
 o getValueIsAdjusting
 public abstract boolean getValueIsAdjusting()
Returns the state of model. If true, the value of the model is currently in flux and further changes are expected. If false, the value of the model is most likely in a final state.

 o addListSelectionListener
 public abstract void addListSelectionListener(ListSelectionListener x)
Add a listener to the list that's notified each time a change to the selection occurs.

Parameters:
l - the ListSelectionListener
 o removeListSelectionListener
 public abstract void removeListSelectionListener(ListSelectionListener x)
Remove a listener from the list that's notified each time a change to the selection occurs.

Parameters:
l - the ListSelectionListener

All Packages  Class Hierarchy  This Package  Previous  Next  Index