javax.swing
interface ListSelectionModel

All Known Implementing Classes:

DefaultListSelectionModel

Most common way to construct:

ListSelectionEvent e = …;

ListSelectionModel lsm = (ListSelectionModel)e.getSource();

Based on 59 examples

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. 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.

MULTIPLE_INTERVAL_SELECTION

public static final int MULTIPLE_INTERVAL_SELECTION

A value for the selectionMode property: select one or more contiguous ranges of indices at a time.

SINGLE_INTERVAL_SELECTION

public static final int SINGLE_INTERVAL_SELECTION

A value for the selectionMode property: select one contiguous range of indices at a time.

SINGLE_SELECTION

public static final int SINGLE_SELECTION

A value for the selectionMode property: select one list index at a time.

addListSelectionListener

public void addListSelectionListener(ListSelectionListener x)

Add a listener to the list that's notified each time a change to the selection occurs.

Parameters:

x - the ListSelectionListener

addSelectionInterval

public void addSelectionInterval(int index0,
                                 int index1)

Changes the selection to be the set union of the current selection and the indices between {@code index0} and {@code index1} inclusive. {@code index0} doesn't have to be less than or equal to {@code index1}.

In {@code SINGLE_SELECTION} selection mode, this is equivalent to calling {@code setSelectionInterval}, and only the second index is used. In {@code SINGLE_INTERVAL_SELECTION} selection mode, this method behaves like {@code setSelectionInterval}, unless the given interval is immediately adjacent to or overlaps the existing selection, and can therefore be used to grow the selection.

If this represents a change to the current selection, then each {@code ListSelectionListener} is notified of the change.

Parameters:

index0 - one end of the interval.

index1 - other end of the interval

clearSelection

public void clearSelection()

Change the selection to the empty set. If this represents a change to the current selection then notify each ListSelectionListener.

getAnchorSelectionIndex

public int getAnchorSelectionIndex()

Return the first index argument from the most recent call to setSelectionInterval(), addSelectionInterval() or removeSelectionInterval(). 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. Windows95 displays the lead index with a dotted yellow outline.

getLeadSelectionIndex

public int getLeadSelectionIndex()

Return the second index argument from the most recent call to setSelectionInterval(), addSelectionInterval() or removeSelectionInterval().

getMaxSelectionIndex

public int getMaxSelectionIndex()

Returns the last selected index or -1 if the selection is empty.

getMinSelectionIndex

public int getMinSelectionIndex()

Returns the first selected index or -1 if the selection is empty.

getSelectionMode

public int getSelectionMode()

Returns the current selection mode.

Returns:

the current selection mode

getValueIsAdjusting

public boolean getValueIsAdjusting()

Returns {@code true} if the selection is undergoing a series of changes.

Returns:

true if the selection is undergoing a series of changes

insertIndexInterval

public 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.

Parameters:

index

length

before

isSelectedIndex

public boolean isSelectedIndex(int index)

Returns true if the specified index is selected.

Parameters:

index

isSelectionEmpty

public boolean isSelectionEmpty()

Returns true if no indices are selected.

removeIndexInterval

public 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.

Parameters:

index0

index1

removeListSelectionListener

public void removeListSelectionListener(ListSelectionListener x)

Remove a listener from the list that's notified each time a change to the selection occurs.

Parameters:

x - the ListSelectionListener

removeSelectionInterval

public void removeSelectionInterval(int index0,
                                    int index1)

Changes the selection to be the set difference of the current selection and the indices between {@code index0} and {@code index1} inclusive. {@code index0} doesn't have to be less than or equal to {@code index1}.

In {@code SINGLE_INTERVAL_SELECTION} selection mode, if the removal would produce two disjoint selections, the removal is extended through the greater end of the selection. For example, if the selection is {@code 0-10} and you supply indices {@code 5,6} (in any order) the resulting selection is {@code 0-4}.

If this represents a change to the current selection, then each {@code ListSelectionListener} is notified of the change.

Parameters:

index0 - one end of the interval.

index1 - other end of the interval

setAnchorSelectionIndex

public void setAnchorSelectionIndex(int index)

Set the anchor selection index.

Parameters:

index

setLeadSelectionIndex

public void setLeadSelectionIndex(int index)

Set the lead selection index.

Parameters:

index

setSelectionInterval

public void setSelectionInterval(int index0,
                                 int index1)

Changes the selection to be between {@code index0} and {@code index1} inclusive. {@code index0} doesn't have to be less than or equal to {@code index1}.

In {@code SINGLE_SELECTION} selection mode, only the second index is used.

If this represents a change to the current selection, then each {@code ListSelectionListener} is notified of the change.

Parameters:

index0 - one end of the interval.

index1 - other end of the interval

setSelectionMode

public void setSelectionMode(int selectionMode)

Sets the selection mode. The following list describes the accepted selection modes:

• {@code ListSelectionModel.SINGLE_SELECTION} - Only one list index can be selected at a time. In this mode, {@code setSelectionInterval} and {@code addSelectionInterval} are equivalent, both replacing the current selection with the index represented by the second argument (the "lead").
• {@code ListSelectionModel.SINGLE_INTERVAL_SELECTION} - Only one contiguous interval can be selected at a time. In this mode, {@code addSelectionInterval} behaves like {@code setSelectionInterval} (replacing the current selection), unless the given interval is immediately adjacent to or overlaps the existing selection, and can therefore be used to grow it.
• {@code ListSelectionModel.MULTIPLE_INTERVAL_SELECTION} - In this mode, there's no restriction on what can be selected.

Parameters:

selectionMode

setValueIsAdjusting

public void setValueIsAdjusting(boolean valueIsAdjusting)

Sets the {@code valueIsAdjusting} property, which indicates whether or not upcoming selection changes should be considered part of a single change. The value of this property is used to initialize the {@code valueIsAdjusting} property of the {@code ListSelectionEvent}s that are generated.

For example, if the selection is being updated in response to a user drag, this property can be set to {@code true} when the drag is initiated and set to {@code false} when the drag is finished. During the drag, listeners receive events with a {@code valueIsAdjusting} property set to {@code true}. At the end of the drag, when the change is finalized, listeners receive an event with the value set to {@code false}. Listeners can use this pattern if they wish to update only when a change has been finalized.

Setting this property to {@code true} begins a series of changes that is to be considered part of a single change. When the property is changed back to {@code false}, an event is sent out characterizing the entire selection change (if there was one), with the event's {@code valueIsAdjusting} property set to {@code false}.

Parameters:

valueIsAdjusting - the new value of the property