DefaultListSelectionModel
public interface ListSelectionModel
Modifier and Type | Field | Description |
---|---|---|
static final int |
MULTIPLE_INTERVAL_SELECTION |
A value for the selectionMode property: select one or more contiguous ranges of indices at a time. |
static final int |
SINGLE_INTERVAL_SELECTION |
A value for the selectionMode property: select one contiguous range of indices at a time. |
static final int |
SINGLE_SELECTION |
A value for the selectionMode property: select one list index at a time. |
Modifier and Type | Method | Description |
---|---|---|
void |
addListSelectionListener |
Add a listener to the list that's notified each time a change to the selection occurs. |
void |
addSelectionInterval |
Changes the selection to be the set union of the current selection and the indices between index0 and index1 inclusive. |
void |
clearSelection() |
Change the selection to the empty set. |
int |
getAnchorSelectionIndex() |
Return the first index argument from the most recent call to setSelectionInterval(), addSelectionInterval() or removeSelectionInterval(). |
int |
getLeadSelectionIndex() |
Return the second index argument from the most recent call to setSelectionInterval(), addSelectionInterval() or removeSelectionInterval(). |
int |
getMaxSelectionIndex() |
Returns the last selected index or -1 if the selection is empty. |
int |
getMinSelectionIndex() |
Returns the first selected index or -1 if the selection is empty. |
default int[] |
getSelectedIndices() |
Returns an array of all of the selected indices in the selection model, in increasing order. |
default int |
getSelectedItemsCount() |
Returns the number of selected items. |
int |
getSelectionMode() |
Returns the current selection mode. |
boolean |
getValueIsAdjusting() |
Returns true if the selection is undergoing a series of changes. |
void |
insertIndexInterval |
Insert length indices beginning before/after index . |
boolean |
isSelectedIndex |
Returns true if the specified index is selected. |
boolean |
isSelectionEmpty() |
Returns true if no indices are selected. |
void |
removeIndexInterval |
Remove the indices in the interval index0,index1 (inclusive) from the selection model. |
void |
removeListSelectionListener |
Remove a listener from the list that's notified each time a change to the selection occurs. |
void |
removeSelectionInterval |
Changes the selection to be the set difference of the current selection and the indices between index0 and index1 inclusive. |
void |
setAnchorSelectionIndex |
Set the anchor selection index. |
void |
setLeadSelectionIndex |
Set the lead selection index. |
void |
setSelectionInterval |
Changes the selection to be between index0 and index1 inclusive. |
void |
setSelectionMode |
Sets the selection mode. |
void |
setValueIsAdjusting |
Sets the valueIsAdjusting property, which indicates whether or not upcoming selection changes should be considered part of a single change. |
static final int SINGLE_SELECTION
static final int SINGLE_INTERVAL_SELECTION
static final int MULTIPLE_INTERVAL_SELECTION
void setSelectionInterval(int index0, int index1)
index0
and index1
inclusive. index0
doesn't have to be less than or equal to index1
. In SINGLE_SELECTION
selection mode, only the second index is used.
If this represents a change to the current selection, then each ListSelectionListener
is notified of the change.
index0
- one end of the interval.index1
- other end of the intervalvoid addSelectionInterval(int index0, int index1)
index0
and index1
inclusive. index0
doesn't have to be less than or equal to index1
. In SINGLE_SELECTION
selection mode, this is equivalent to calling setSelectionInterval
, and only the second index is used. In SINGLE_INTERVAL_SELECTION
selection mode, this method behaves like 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 ListSelectionListener
is notified of the change.
index0
- one end of the interval.index1
- other end of the intervalvoid removeSelectionInterval(int index0, int index1)
index0
and index1
inclusive. index0
doesn't have to be less than or equal to index1
. In 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 0-10
and you supply indices 5,6
(in any order) the resulting selection is 0-4
.
If this represents a change to the current selection, then each ListSelectionListener
is notified of the change.
index0
- one end of the interval.index1
- other end of the intervalint getMinSelectionIndex()
int getMaxSelectionIndex()
boolean isSelectedIndex(int index)
index
- an indextrue
if the specified index is selectedint getAnchorSelectionIndex()
void setAnchorSelectionIndex(int index)
index
- the anchor selection indexint getLeadSelectionIndex()
void setLeadSelectionIndex(int index)
index
- the lead selection indexvoid clearSelection()
boolean isSelectionEmpty()
true
if no indices are selected.void insertIndexInterval(int index, int length, boolean before)
length
indices beginning before/after index
. This is typically called to sync the selection model with a corresponding change in the data model.index
- the beginning of the intervallength
- the length of the intervalbefore
- if true
, interval inserts before the index
, otherwise, interval inserts after the index
void removeIndexInterval(int index0, int index1)
index0,index1
(inclusive) from the selection model. This is typically called to sync the selection model width a corresponding change in the data model.index0
- the beginning of the intervalindex1
- the end of the intervalvoid setValueIsAdjusting(boolean valueIsAdjusting)
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 valueIsAdjusting
property of the 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 true
when the drag is initiated and set to false
when the drag is finished. During the drag, listeners receive events with a valueIsAdjusting
property set to true
. At the end of the drag, when the change is finalized, listeners receive an event with the value set to false
. Listeners can use this pattern if they wish to update only when a change has been finalized.
Setting this property to true
begins a series of changes that is to be considered part of a single change. When the property is changed back to false
, an event is sent out characterizing the entire selection change (if there was one), with the event's valueIsAdjusting
property set to false
.
valueIsAdjusting
- the new value of the propertyboolean getValueIsAdjusting()
true
if the selection is undergoing a series of changes.void setSelectionMode(int selectionMode)
ListSelectionModel.SINGLE_SELECTION
- Only one list index can be selected at a time. In this mode, setSelectionInterval
and addSelectionInterval
are equivalent, both replacing the current selection with the index represented by the second argument (the "lead"). ListSelectionModel.SINGLE_INTERVAL_SELECTION
- Only one contiguous interval can be selected at a time. In this mode, addSelectionInterval
behaves like 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. ListSelectionModel.MULTIPLE_INTERVAL_SELECTION
- In this mode, there's no restriction on what can be selected. selectionMode
- the selection modeIllegalArgumentException
- if the selection mode isn't one of those allowedint getSelectionMode()
void addListSelectionListener(ListSelectionListener x)
x
- the ListSelectionListenervoid removeListSelectionListener(ListSelectionListener x)
x
- the ListSelectionListenerdefault int[] getSelectedIndices()
getMinSelectionIndex()
to maximum selected index getMaxSelectionIndex()
and returns the selected indices isSelectedIndex(int)
in a newly allocated int array.default int getSelectedItemsCount()
getMinSelectionIndex()
to maximum selected index getMaxSelectionIndex()
and returns the number of selected indices isSelectedIndex(int)
© 1993, 2023, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
https://docs.oracle.com/en/java/javase/21/docs/api/java.desktop/javax/swing/ListSelectionModel.html