OpenJDK 1.22 · javax.swing.ListSelectionModel · APIdia, the JavaDoc alternative

Modifier and Type	Field and Description
public static final int	MULTIPLE_INTERVAL_SELECTION A value for the selectionMode property: select one or more contiguous ranges of indices at a time.
public static final int	SINGLE_INTERVAL_SELECTION A value for the selectionMode property: select one contiguous range of indices at a time.
public static final int	SINGLE_SELECTION A value for the selectionMode property: select one list index at a time.

Method Summary

Modifier and Type	Method and Description
public void	addListSelectionListener(ListSelectionListener the ListSelectionListener x) Add a listener to the list that's notified each time a change to the selection occurs.
public void	addSelectionInterval(int one end of the interval. index0, int other end of the interval index1) Changes the selection to be the set union of the current selection and the indices between `index0` and `index1` inclusive.
public void	clearSelection() Change the selection to the empty set.
public int	Returns: the anchor selection index getAnchorSelectionIndex() Return the first index argument from the most recent call to setSelectionInterval(), addSelectionInterval() or removeSelectionInterval().
public int	Returns: the lead selection index. getLeadSelectionIndex() Return the second index argument from the most recent call to setSelectionInterval(), addSelectionInterval() or removeSelectionInterval().
public int	Returns: the last selected index or -1 if the selection is empty. getMaxSelectionIndex() Returns the last selected index or -1 if the selection is empty.
public int	Returns: the first selected index or -1 if the selection is empty. getMinSelectionIndex() Returns the first selected index or -1 if the selection is empty.
public default int[]	Returns: all of the selected indices, in increasing order, or an empty array if nothing is selected getSelectedIndices() Returns an array of all of the selected indices in the selection model, in increasing order.
public default int	Returns: the number of selected items, 0 if no items are selected getSelectedItemsCount() Returns the number of selected items.
public int	Returns: the current selection mode getSelectionMode() Returns the current selection mode.
public boolean	Returns: true if the selection is undergoing a series of changes getValueIsAdjusting() Returns `true` if the selection is undergoing a series of changes.
public void	insertIndexInterval(int the beginning of the interval index, int the length of the interval length, boolean if `true`, interval inserts before the `index`, otherwise, interval inserts after the `index` before) Insert `length` indices beginning before/after `index`.
public boolean	Returns: `true` if the specified index is selected isSelectedIndex(int an index index) Returns true if the specified index is selected.
public boolean	Returns: `true` if no indices are selected. isSelectionEmpty() Returns true if no indices are selected.
public void	removeIndexInterval(int the beginning of the interval index0, int the end of the interval index1) Remove the indices in the interval `index0,index1` (inclusive) from the selection model.
public void	removeListSelectionListener(ListSelectionListener the ListSelectionListener x) Remove a listener from the list that's notified each time a change to the selection occurs.
public void	removeSelectionInterval(int one end of the interval. index0, int other end of the interval index1) Changes the selection to be the set difference of the current selection and the indices between `index0` and `index1` inclusive.
public void	setAnchorSelectionIndex(int the anchor selection index index) Set the anchor selection index.
public void	setLeadSelectionIndex(int the lead selection index index) Set the lead selection index.
public void	setSelectionInterval(int one end of the interval. index0, int other end of the interval index1) Changes the selection to be between `index0` and `index1` inclusive.
public void	setSelectionMode(int the selection mode selectionMode) Sets the selection mode.
public void	setValueIsAdjusting(boolean the new value of the property valueIsAdjusting) Sets the `valueIsAdjusting` property, which indicates whether or not upcoming selection changes should be considered part of a single change.

MULTIPLE_INTERVAL_SELECTION	back to summary
public static final int MULTIPLE_INTERVAL_SELECTION A value for the selectionMode property: select one or more contiguous ranges of indices at a time. See Also `setSelectionMode`

SINGLE_INTERVAL_SELECTION	back to summary
public static final int SINGLE_INTERVAL_SELECTION A value for the selectionMode property: select one contiguous range of indices at a time. See Also `setSelectionMode`

SINGLE_SELECTION	back to summary
public static final int SINGLE_SELECTION A value for the selectionMode property: select one list index at a time. See Also `setSelectionMode`

Method Detail

addListSelectionListener back to summary

addListSelectionListener	back to summary
public void addListSelectionListener(ListSelectionListener x) Add a listener to the list that's notified each time a change to the selection occurs. Parameters x:ListSelectionListener the ListSelectionListener See Also `removeListSelectionListener`, `setSelectionInterval`, `addSelectionInterval`, `removeSelectionInterval`, `clearSelection`, `insertIndexInterval`, `removeIndexInterval`

public void addListSelectionListener(ListSelectionListener x)

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

Parameters

x:ListSelectionListener: the ListSelectionListener

addSelectionInterval back to summary

addSelectionInterval	back to summary
public void addSelectionInterval(int index0, int index1) Changes the selection to be the set union of the current selection and the indices between `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. Parameters index0:int one end of the interval. index1:int other end of the interval See Also `addListSelectionListener`, `setSelectionInterval`

public void addSelectionInterval(int index0, int index1)

Changes the selection to be the set union of the current selection and the indices between 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.

Parameters

index0:int: one end of the interval.
index1:int: other end of the interval

clearSelection back to summary

clearSelection	back to summary
public void clearSelection() Change the selection to the empty set. If this represents a change to the current selection then notify each ListSelectionListener. See Also `addListSelectionListener`

public void clearSelection()

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

See Also: addListSelectionListener

getAnchorSelectionIndex back to summary

getAnchorSelectionIndex	back to summary
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. Returns:int the anchor selection index See Also `getLeadSelectionIndex`, `setSelectionInterval`, `addSelectionInterval`

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.

Returns:int: the anchor selection index
See Also: getLeadSelectionIndex, setSelectionInterval, addSelectionInterval

getLeadSelectionIndex back to summary

getLeadSelectionIndex	back to summary
public int getLeadSelectionIndex() Return the second index argument from the most recent call to setSelectionInterval(), addSelectionInterval() or removeSelectionInterval(). Returns:int the lead selection index. See Also `getAnchorSelectionIndex`, `setSelectionInterval`, `addSelectionInterval`

public int getLeadSelectionIndex()

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

Returns:int: the lead selection index.
See Also: getAnchorSelectionIndex, setSelectionInterval, addSelectionInterval

getMaxSelectionIndex	back to summary
public int getMaxSelectionIndex() Returns the last selected index or -1 if the selection is empty. Returns:int the last selected index or -1 if the selection is empty.

getMaxSelectionIndex

back to summary

public int getMaxSelectionIndex()

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

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

getMinSelectionIndex	back to summary
public int getMinSelectionIndex() Returns the first selected index or -1 if the selection is empty. Returns:int the first selected index or -1 if the selection is empty.

getMinSelectionIndex

back to summary

public int getMinSelectionIndex()

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

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

getSelectedIndices back to summary

getSelectedIndices	back to summary
public default int[] getSelectedIndices() Returns an array of all of the selected indices in the selection model, in increasing order. Implementation Specification The default implementation iterates from minimum selected index `getMinSelectionIndex()` to maximum selected index `getMaxSelectionIndex()` and returns the selected indices `isSelectedIndex(int)` in a newly allocated int array. Returns:int[] all of the selected indices, in increasing order, or an empty array if nothing is selected Since 11 See Also `removeSelectionInterval`, `addListSelectionListener`

public default int[] getSelectedIndices()

Returns an array of all of the selected indices in the selection model, in increasing order.

Implementation Specification

The default implementation iterates from minimum selected index getMinSelectionIndex() to maximum selected index getMaxSelectionIndex() and returns the selected indices isSelectedIndex(int) in a newly allocated int array.

Returns:int[]: all of the selected indices, in increasing order, or an empty array if nothing is selected
Since: 11
See Also: removeSelectionInterval, addListSelectionListener

getSelectedItemsCount back to summary

getSelectedItemsCount	back to summary
public default int getSelectedItemsCount() Returns the number of selected items. Implementation Specification The default implementation iterates from minimum selected index `getMinSelectionIndex()` to maximum selected index `getMaxSelectionIndex()` and returns the number of selected indices `isSelectedIndex(int)` Returns:int the number of selected items, 0 if no items are selected Since 11

public default int getSelectedItemsCount()

Returns the number of selected items.

Implementation Specification

The default implementation iterates from minimum selected index getMinSelectionIndex() to maximum selected index getMaxSelectionIndex() and returns the number of selected indices isSelectedIndex(int)

Returns:int: the number of selected items, 0 if no items are selected
Since: 11

getSelectionMode back to summary

getSelectionMode	back to summary
public int getSelectionMode() Returns the current selection mode. Returns:int the current selection mode See Also `setSelectionMode`

public int getSelectionMode()

Returns the current selection mode.

Returns:int: the current selection mode
See Also: setSelectionMode

getValueIsAdjusting back to summary

getValueIsAdjusting	back to summary
public boolean getValueIsAdjusting() Returns `true` if the selection is undergoing a series of changes. Returns:boolean true if the selection is undergoing a series of changes See Also `setValueIsAdjusting`

public boolean getValueIsAdjusting()

Returns true if the selection is undergoing a series of changes.

Returns:boolean: true if the selection is undergoing a series of changes
See Also: setValueIsAdjusting

insertIndexInterval back to summary

insertIndexInterval	back to summary
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:int the beginning of the interval length:int the length of the interval before:boolean if `true`, interval inserts before the `index`, otherwise, interval inserts after the `index`

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:int: the beginning of the interval
length:int: the length of the interval
before:boolean: if true, interval inserts before the index, otherwise, interval inserts after the index

isSelectedIndex back to summary

isSelectedIndex	back to summary
public boolean isSelectedIndex(int index) Returns true if the specified index is selected. Parameters index:int an index Returns:boolean `true` if the specified index is selected

public boolean isSelectedIndex(int index)

Returns true if the specified index is selected.

Parameters

index:int: an index

Returns:boolean

true if the specified index is selected

isSelectionEmpty back to summary

isSelectionEmpty	back to summary
public boolean isSelectionEmpty() Returns true if no indices are selected. Returns:boolean `true` if no indices are selected.

public boolean isSelectionEmpty()

Returns true if no indices are selected.

Returns:boolean: true if no indices are selected.

removeIndexInterval back to summary

removeIndexInterval	back to summary
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:int the beginning of the interval index1:int the end of the interval

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:int: the beginning of the interval
index1:int: the end of the interval

removeListSelectionListener back to summary

removeListSelectionListener	back to summary
public void removeListSelectionListener(ListSelectionListener x) Remove a listener from the list that's notified each time a change to the selection occurs. Parameters x:ListSelectionListener the ListSelectionListener See Also `addListSelectionListener`

public void removeListSelectionListener(ListSelectionListener x)

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

Parameters

x:ListSelectionListener: the ListSelectionListener

See Also

addListSelectionListener

removeSelectionInterval back to summary

removeSelectionInterval	back to summary
public void removeSelectionInterval(int index0, int index1) Changes the selection to be the set difference of the current selection and the indices between `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. Parameters index0:int one end of the interval. index1:int other end of the interval See Also `addListSelectionListener`

public void removeSelectionInterval(int index0, int index1)

Changes the selection to be the set difference of the current selection and the indices between 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.

Parameters

index0:int: one end of the interval.
index1:int: other end of the interval

See Also

addListSelectionListener

setAnchorSelectionIndex back to summary

setAnchorSelectionIndex	back to summary
public void setAnchorSelectionIndex(int index) Set the anchor selection index. Parameters index:int the anchor selection index See Also `getAnchorSelectionIndex`

public void setAnchorSelectionIndex(int index)

Set the anchor selection index.

Parameters

index:int: the anchor selection index

See Also

getAnchorSelectionIndex

setLeadSelectionIndex back to summary

setLeadSelectionIndex	back to summary
public void setLeadSelectionIndex(int index) Set the lead selection index. Parameters index:int the lead selection index See Also `getLeadSelectionIndex`

public void setLeadSelectionIndex(int index)

Set the lead selection index.

Parameters

index:int: the lead selection index

See Also

getLeadSelectionIndex

setSelectionInterval back to summary

setSelectionInterval	back to summary
public void setSelectionInterval(int index0, int index1) Changes the selection to be between `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. Parameters index0:int one end of the interval. index1:int other end of the interval See Also `addListSelectionListener`

public void setSelectionInterval(int index0, int index1)

Changes the selection to be between 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.

Parameters

index0:int: one end of the interval.
index1:int: other end of the interval

See Also

addListSelectionListener

setSelectionMode back to summary

setSelectionMode	back to summary
public void setSelectionMode(int selectionMode) Sets the selection mode. The following list describes the accepted selection modes: `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. Parameters selectionMode:int the selection mode Exceptions IllegalArgumentException: if the selection mode isn't one of those allowed See Also `getSelectionMode`

public void setSelectionMode(int selectionMode)

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

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.

Parameters

selectionMode:int: the selection mode

Exceptions

IllegalArgumentException:: if the selection mode isn't one of those allowed

See Also

getSelectionMode

setValueIsAdjusting back to summary

setValueIsAdjusting	back to summary
public void setValueIsAdjusting(boolean valueIsAdjusting) Sets the `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`. Parameters valueIsAdjusting:boolean the new value of the property See Also `getValueIsAdjusting`, `javax.swing.event.ListSelectionEvent#getValueIsAdjusting`

public void setValueIsAdjusting(boolean valueIsAdjusting)

Sets the 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 ListSelectionEvents 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.

Parameters

valueIsAdjusting:boolean: the new value of the property

public Interface ListSelectionModel

Field Summary

Method Summary

Field Detail

Method Detail