OpenJDK 1.22 · javax.swing.DefaultListSelectionModel

Modifier and Type	Field and Description
private int	anchorIndex
private int	firstAdjustedIndex
private int	firstChangedIndex
private boolean	isAdjusting
private int	lastAdjustedIndex
private int	lastChangedIndex
protected boolean	leadAnchorNotificationEnabled Whether or not the lead anchor notification is enabled.
private int	leadIndex
protected EventListenerList	listenerList The list of listeners.
private static final int	MAX
private int	maxIndex
private static final int	MIN
private int	minIndex
private int	selectionMode
private BitSet	value

Access	Constructor and Description
public	DefaultListSelectionModel() Constructs a `DefaultListSelectionModel`.

Method Summary

Modifier and Type	Method and Description
public void	addListSelectionListener(ListSelectionListener the ListSelectionListener l) Implements javax.swing.ListSelectionModel.addListSelectionListener. 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) Implements javax.swing.ListSelectionModel.addSelectionInterval. Changes the selection to be the set union of the current selection and the indices between `index0` and `index1` inclusive.
private void	changeSelection(int clearMin, int clearMax, int setMin, int setMax, boolean clearFirst)
private void	changeSelection(int clearMin, int clearMax, int setMin, int setMax) Change the selection with the effect of first clearing the values in the inclusive range [clearMin, clearMax] then setting the values in the inclusive range [setMin, setMax].
private void	clear(int r)
public void	clearSelection() Implements javax.swing.ListSelectionModel.clearSelection. Change the selection to the empty set.
public Object	clone() Overrides java.lang.Object.clone. Returns a clone of this selection model with the same selection.
private boolean	contains(int a, int b, int i)
protected void	fireValueChanged(boolean true if this is the final change in a series of adjustments isAdjusting) Notifies listeners that we have ended a series of adjustments.
protected void	fireValueChanged(int the first index in the interval firstIndex, int the last index in the interval lastIndex) Notifies `ListSelectionListeners` that the value of the selection, in the closed interval `firstIndex`, `lastIndex`, has changed.
protected void	fireValueChanged(int the first index in the interval firstIndex, int the last index in the interval lastIndex, boolean true if this is the final change in a series of adjustments isAdjusting) Notifies `ListSelectionListeners` that the value of the selection, in the closed interval `firstIndex`, `lastIndex`, has changed and if this is the final change in the series of adjustments.
private void	fireValueChanged()
public int	getAnchorSelectionIndex() Implements javax.swing.ListSelectionModel.getAnchorSelectionIndex. Return the first index argument from the most recent call to setSelectionInterval(), addSelectionInterval() or removeSelectionInterval().
public int	getLeadSelectionIndex() Implements javax.swing.ListSelectionModel.getLeadSelectionIndex. Return the second index argument from the most recent call to setSelectionInterval(), addSelectionInterval() or removeSelectionInterval().
public < the type of `EventListener` class being requested T extends EventListener> T[]	Returns: an array of all objects registered as `FooListener`s on this model, or an empty array if no such listeners have been added getListeners(Class<T> the type of listeners requested; this parameter should specify an interface that descends from `java.util.EventListener` listenerType) Returns an array of all the objects currently registered as `FooListener`s upon this model.
public ListSelectionListener[]	Returns: all of this model's `ListSelectionListener`s or an empty array if no list selection listeners are currently registered getListSelectionListeners() Returns an array of all the list selection listeners registered on this `DefaultListSelectionModel`.
public int	getMaxSelectionIndex() Implements javax.swing.ListSelectionModel.getMaxSelectionIndex. Returns the last selected index or -1 if the selection is empty.
public int	getMinSelectionIndex() Implements javax.swing.ListSelectionModel.getMinSelectionIndex. Returns the first selected index or -1 if the selection is empty.
public int	getSelectionMode() Implements javax.swing.ListSelectionModel.getSelectionMode. Returns the current selection mode.
public boolean	getValueIsAdjusting() Implements javax.swing.ListSelectionModel.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) Implements javax.swing.ListSelectionModel.insertIndexInterval. Insert length indices beginning before/after index.
public boolean	Returns: the value of the `leadAnchorNotificationEnabled` flag isLeadAnchorNotificationEnabled() Returns the value of the `leadAnchorNotificationEnabled` flag.
public boolean	isSelectedIndex(int an index index) Implements javax.swing.ListSelectionModel.isSelectedIndex. Returns true if the specified index is selected.
public boolean	isSelectionEmpty() Implements javax.swing.ListSelectionModel.isSelectionEmpty. Returns true if no indices are selected.
private void	markAsDirty(int r)
public void	moveLeadSelectionIndex(int the new lead selection index leadIndex) Set the lead selection index, leaving all selection values unchanged.
public void	removeIndexInterval(int the beginning of the interval index0, int the end of the interval index1) Implements javax.swing.ListSelectionModel.removeIndexInterval. Remove the indices in the interval index0,index1 (inclusive) from the selection model.
public void	removeListSelectionListener(ListSelectionListener the ListSelectionListener l) Implements javax.swing.ListSelectionModel.removeListSelectionListener. 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) Implements javax.swing.ListSelectionModel.removeSelectionInterval. Changes the selection to be the set difference of the current selection and the indices between `index0` and `index1` inclusive.
private void	removeSelectionIntervalImpl(int index0, int index1, boolean changeLeadAnchor)
private void	set(int r)
public void	setAnchorSelectionIndex(int the anchor selection index anchorIndex) Implements javax.swing.ListSelectionModel.setAnchorSelectionIndex. Set the anchor selection index, leaving all selection values unchanged.
public void	setLeadAnchorNotificationEnabled(boolean boolean value for `leadAnchorNotificationEnabled` flag) Sets the value of the leadAnchorNotificationEnabled flag.
public void	setLeadSelectionIndex(int the lead selection index leadIndex) Implements javax.swing.ListSelectionModel.setLeadSelectionIndex. Sets the lead selection index, ensuring that values between the anchor and the new lead are either all selected or all deselected.
public void	setSelectionInterval(int one end of the interval. index0, int other end of the interval index1) Implements javax.swing.ListSelectionModel.setSelectionInterval. Changes the selection to be between `index0` and `index1` inclusive.
public void	setSelectionMode(int the selection mode selectionMode) Implements javax.swing.ListSelectionModel.setSelectionMode. Sets the selection mode.
private void	setState(int index, boolean state)
public void	setValueIsAdjusting(boolean the new value of the property isAdjusting) Implements javax.swing.ListSelectionModel.setValueIsAdjusting. Sets the `valueIsAdjusting` property, which indicates whether or not upcoming selection changes should be considered part of a single change.
public String	Returns: a `String` representation of this object toString() Overrides java.lang.Object.toString. Returns a string that displays and identifies this object's properties.
private void	updateLeadAnchorIndices(int anchorIndex, int leadIndex)

Inherited from java.lang.Object:: equals finalize getClass hashCode notify notifyAll wait wait wait

anchorIndex	back to summary
private int anchorIndex

firstAdjustedIndex	back to summary
private int firstAdjustedIndex

firstChangedIndex	back to summary
private int firstChangedIndex

isAdjusting	back to summary
private boolean isAdjusting

lastAdjustedIndex	back to summary
private int lastAdjustedIndex

lastChangedIndex	back to summary
private int lastChangedIndex

leadAnchorNotificationEnabled	back to summary
protected boolean leadAnchorNotificationEnabled Whether or not the lead anchor notification is enabled.

leadIndex	back to summary
private int leadIndex

listenerList	back to summary
protected EventListenerList listenerList The list of listeners.

MAX	back to summary
private static final int MAX

maxIndex	back to summary
private int maxIndex

MIN	back to summary
private static final int MIN

minIndex	back to summary
private int minIndex

selectionMode	back to summary
private int selectionMode

value	back to summary
private BitSet value

DefaultListSelectionModel	back to summary
public DefaultListSelectionModel() Constructs a `DefaultListSelectionModel`.

Method Detail

addListSelectionListener	back to summary
public void addListSelectionListener(ListSelectionListener l) Implements javax.swing.ListSelectionModel.addListSelectionListener. Doc from javax.swing.ListSelectionModel.addListSelectionListener. Add a listener to the list that's notified each time a change to the selection occurs. Parameters l:ListSelectionListener the ListSelectionListener

addListSelectionListener

back to summary

public void addListSelectionListener(ListSelectionListener l)

Implements javax.swing.ListSelectionModel.addListSelectionListener.

Doc from javax.swing.ListSelectionModel.addListSelectionListener.

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

Parameters

l:ListSelectionListener: the ListSelectionListener

addSelectionInterval back to summary

addSelectionInterval	back to summary
public void addSelectionInterval(int index0, int index1) Implements javax.swing.ListSelectionModel.addSelectionInterval. Changes the selection to be the set union of the current selection and the indices between `index0` and `index1` inclusive. 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 it. If this represents a change to the current selection, then each `ListSelectionListener` is notified of the change. Note that `index0` doesn't have to be less than or equal to `index1`. If either index is `-1`, this method does nothing and returns without exception. Otherwise, if either index is less than `-1`, an `IndexOutOfBoundsException` is thrown. Parameters index0:int one end of the interval. index1:int other end of the interval Exceptions IndexOutOfBoundsException: if either index is less than `-1` (and neither index is `-1`) See Also `addListSelectionListener`, `setSelectionInterval`

public void addSelectionInterval(int index0, int index1)

Implements javax.swing.ListSelectionModel.addSelectionInterval.

Changes the selection to be the set union of the current selection and the indices between index0 and index1 inclusive.

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

If this represents a change to the current selection, then each ListSelectionListener is notified of the change. Note that index0 doesn't have to be less than or equal to index1.

If either index is -1, this method does nothing and returns without exception. Otherwise, if either index is less than -1, an IndexOutOfBoundsException is thrown.

Parameters

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

Exceptions

IndexOutOfBoundsException:: if either index is less than -1 (and neither index is -1)

changeSelection	back to summary
private void changeSelection(int clearMin, int clearMax, int setMin, int setMax, boolean clearFirst)

changeSelection	back to summary
private void changeSelection(int clearMin, int clearMax, int setMin, int setMax) Change the selection with the effect of first clearing the values in the inclusive range [clearMin, clearMax] then setting the values in the inclusive range [setMin, setMax]. Do this in one pass so that no values are cleared if they would later be set.

clear	back to summary
private void clear(int r)

clearSelection	back to summary
public void clearSelection() Implements javax.swing.ListSelectionModel.clearSelection. Doc from javax.swing.ListSelectionModel.clearSelection. Change the selection to the empty set. If this represents a change to the current selection then notify each ListSelectionListener.

clearSelection

back to summary

public void clearSelection()

Implements javax.swing.ListSelectionModel.clearSelection.

Doc from javax.swing.ListSelectionModel.clearSelection.

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

clone back to summary

clone	back to summary
public Object clone() throws CloneNotSupportedException Overrides java.lang.Object.clone. Returns a clone of this selection model with the same selection. `listenerLists` are not duplicated. Returns:Object Doc from java.lang.Object.clone. a clone of this instance. Exceptions CloneNotSupportedException: if the selection model does not both (a) implement the Cloneable interface and (b) define a `clone` method.

public Object clone() throws CloneNotSupportedException

Overrides java.lang.Object.clone.

Returns a clone of this selection model with the same selection. listenerLists are not duplicated.

Returns:Object

Doc from java.lang.Object.clone.

a clone of this instance.

Exceptions

CloneNotSupportedException:: if the selection model does not both (a) implement the Cloneable interface and (b) define a clone method.

contains	back to summary
private boolean contains(int a, int b, int i)

fireValueChanged	back to summary
protected void fireValueChanged(boolean isAdjusting) Notifies listeners that we have ended a series of adjustments. Parameters isAdjusting:boolean true if this is the final change in a series of adjustments

fireValueChanged

back to summary

protected void fireValueChanged(boolean isAdjusting)

Notifies listeners that we have ended a series of adjustments.

Parameters

isAdjusting:boolean: true if this is the final change in a series of adjustments

fireValueChanged back to summary

fireValueChanged	back to summary
protected void fireValueChanged(int firstIndex, int lastIndex) Notifies `ListSelectionListeners` that the value of the selection, in the closed interval `firstIndex`, `lastIndex`, has changed. Parameters firstIndex:int the first index in the interval lastIndex:int the last index in the interval

protected void fireValueChanged(int firstIndex, int lastIndex)

Notifies ListSelectionListeners that the value of the selection, in the closed interval firstIndex, lastIndex, has changed.

Parameters

firstIndex:int: the first index in the interval
lastIndex:int: the last index in the interval

fireValueChanged back to summary

fireValueChanged	back to summary
protected void fireValueChanged(int firstIndex, int lastIndex, boolean isAdjusting) Notifies `ListSelectionListeners` that the value of the selection, in the closed interval `firstIndex`, `lastIndex`, has changed and if this is the final change in the series of adjustments. Parameters firstIndex:int the first index in the interval lastIndex:int the last index in the interval isAdjusting:boolean true if this is the final change in a series of adjustments See Also `EventListenerList`

protected void fireValueChanged(int firstIndex, int lastIndex, boolean isAdjusting)

Notifies ListSelectionListeners that the value of the selection, in the closed interval firstIndex, lastIndex, has changed and if this is the final change in the series of adjustments.

Parameters

firstIndex:int: the first index in the interval
lastIndex:int: the last index in the interval
isAdjusting:boolean: true if this is the final change in a series of adjustments

See Also

EventListenerList

fireValueChanged	back to summary
private void fireValueChanged()

getAnchorSelectionIndex	back to summary
public int getAnchorSelectionIndex() Implements javax.swing.ListSelectionModel.getAnchorSelectionIndex. Doc from javax.swing.ListSelectionModel.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 Annotations @Transient

getAnchorSelectionIndex

back to summary

public int getAnchorSelectionIndex()

Implements javax.swing.ListSelectionModel.getAnchorSelectionIndex.

Doc from javax.swing.ListSelectionModel.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

Annotations

@Transient

getLeadSelectionIndex	back to summary
public int getLeadSelectionIndex() Implements javax.swing.ListSelectionModel.getLeadSelectionIndex. Doc from javax.swing.ListSelectionModel.getLeadSelectionIndex. Return the second index argument from the most recent call to setSelectionInterval(), addSelectionInterval() or removeSelectionInterval(). Returns:int the lead selection index. Annotations @Transient

getLeadSelectionIndex

back to summary

public int getLeadSelectionIndex()

Implements javax.swing.ListSelectionModel.getLeadSelectionIndex.

Doc from javax.swing.ListSelectionModel.getLeadSelectionIndex.

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

Returns:int

the lead selection index.

Annotations

@Transient

getListeners back to summary

getListeners	back to summary
public <T extends EventListener> T[] getListeners(Class<T> listenerType) Returns an array of all the objects currently registered as `FooListener`s upon this model. `FooListener`s are registered using the `addFooListener` method. You can specify the `listenerType` argument with a class literal, such as `FooListener.class`. For example, you can query a `DefaultListSelectionModel` instance `m` for its list selection listeners with the following code: ListSelectionListener[] lsls = (ListSelectionListener[])(m.getListeners(ListSelectionListener.class)); If no such listeners exist, this method returns an empty array. Parameters <T> the type of `EventListener` class being requested listenerType:Class<T> the type of listeners requested; this parameter should specify an interface that descends from `java.util.EventListener` Returns:T[] an array of all objects registered as `FooListener`s on this model, or an empty array if no such listeners have been added Exceptions ClassCastException: if `listenerType` doesn't specify a class or interface that implements `java.util.EventListener` Since 1.3 See Also `getListSelectionListeners`

public <T extends EventListener> T[] getListeners(Class<T> listenerType)

Returns an array of all the objects currently registered as FooListeners upon this model. FooListeners are registered using the addFooListener method.

You can specify the listenerType argument with a class literal, such as FooListener.class. For example, you can query a DefaultListSelectionModel instance m for its list selection listeners with the following code:

ListSelectionListener[] lsls = (ListSelectionListener[])(m.getListeners(ListSelectionListener.class));

If no such listeners exist, this method returns an empty array.

Parameters

<T>: the type of EventListener class being requested
listenerType:Class<T>: the type of listeners requested; this parameter should specify an interface that descends from java.util.EventListener

Returns:T[]

an array of all objects registered as FooListeners on this model, or an empty array if no such listeners have been added

Exceptions

ClassCastException:: if listenerType doesn't specify a class or interface that implements java.util.EventListener

Since

1.3

See Also

getListSelectionListeners

getListSelectionListeners back to summary

getListSelectionListeners	back to summary
public ListSelectionListener[] getListSelectionListeners() Returns an array of all the list selection listeners registered on this `DefaultListSelectionModel`. Returns:ListSelectionListener[] all of this model's `ListSelectionListener`s or an empty array if no list selection listeners are currently registered Since 1.4 See Also `addListSelectionListener`, `removeListSelectionListener`

public ListSelectionListener[] getListSelectionListeners()

Returns an array of all the list selection listeners registered on this DefaultListSelectionModel.

Returns:ListSelectionListener[]: all of this model's ListSelectionListeners or an empty array if no list selection listeners are currently registered
Since: 1.4
See Also: addListSelectionListener, removeListSelectionListener

getMaxSelectionIndex	back to summary
public int getMaxSelectionIndex() Implements javax.swing.ListSelectionModel.getMaxSelectionIndex. Doc from javax.swing.ListSelectionModel.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()

Implements javax.swing.ListSelectionModel.getMaxSelectionIndex.

Doc from javax.swing.ListSelectionModel.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() Implements javax.swing.ListSelectionModel.getMinSelectionIndex. Doc from javax.swing.ListSelectionModel.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()

Implements javax.swing.ListSelectionModel.getMinSelectionIndex.

Doc from javax.swing.ListSelectionModel.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.

getSelectionMode	back to summary
public int getSelectionMode() Implements javax.swing.ListSelectionModel.getSelectionMode. Doc from javax.swing.ListSelectionModel.getSelectionMode. Returns the current selection mode. Returns:int the current selection mode

getSelectionMode

back to summary

public int getSelectionMode()

Implements javax.swing.ListSelectionModel.getSelectionMode.

Doc from javax.swing.ListSelectionModel.getSelectionMode.

Returns the current selection mode.

Returns:int: the current selection mode

getValueIsAdjusting back to summary

getValueIsAdjusting	back to summary
public boolean getValueIsAdjusting() Implements javax.swing.ListSelectionModel.getValueIsAdjusting. Doc from javax.swing.ListSelectionModel.getValueIsAdjusting. Returns `true` if the selection is undergoing a series of changes. Returns:boolean true if the selection is undergoing a series of changes

public boolean getValueIsAdjusting()

Implements javax.swing.ListSelectionModel.getValueIsAdjusting.

Doc from javax.swing.ListSelectionModel.getValueIsAdjusting.

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

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

insertIndexInterval back to summary

insertIndexInterval	back to summary
public void insertIndexInterval(int index, int length, boolean before) Implements javax.swing.ListSelectionModel.insertIndexInterval. Insert length indices beginning before/after index. If the value at index is itself selected and the selection mode is not SINGLE_SELECTION, set all of the newly inserted items as selected. Otherwise leave them unselected. This method is typically called to sync the selection model with a corresponding change in the data model. Parameters index:int Doc from javax.swing.ListSelectionModel.insertIndexInterval. the beginning of the interval length:int Doc from javax.swing.ListSelectionModel.insertIndexInterval. the length of the interval before:boolean Doc from javax.swing.ListSelectionModel.insertIndexInterval. if `true`, interval inserts before the `index`, otherwise, interval inserts after the `index` Exceptions IndexOutOfBoundsException: if either `index` or `length` is negative

public void insertIndexInterval(int index, int length, boolean before)

Implements javax.swing.ListSelectionModel.insertIndexInterval.

Insert length indices beginning before/after index. If the value at index is itself selected and the selection mode is not SINGLE_SELECTION, set all of the newly inserted items as selected. Otherwise leave them unselected. This method is typically called to sync the selection model with a corresponding change in the data model.

Parameters

index:int

Doc from javax.swing.ListSelectionModel.insertIndexInterval.

the beginning of the interval

length:int

Doc from javax.swing.ListSelectionModel.insertIndexInterval.

the length of the interval

before:boolean

Doc from javax.swing.ListSelectionModel.insertIndexInterval.

if true, interval inserts before the index, otherwise, interval inserts after the index

Exceptions

IndexOutOfBoundsException:: if either index or length is negative

isLeadAnchorNotificationEnabled back to summary

isLeadAnchorNotificationEnabled	back to summary
public boolean isLeadAnchorNotificationEnabled() Returns the value of the `leadAnchorNotificationEnabled` flag. When `leadAnchorNotificationEnabled` is true the model generates notification events with bounds that cover all the changes to the selection plus the changes to the lead and anchor indices. Setting the flag to false causes a narrowing of the event's bounds to include only the elements that have been selected or deselected since the last change. Either way, the model continues to maintain the lead and anchor variables internally. The default is true. Note It is possible for the lead or anchor to be changed without a change to the selection. Notification of these changes is often important, such as when the new lead or anchor needs to be updated in the view. Therefore, caution is urged when changing the default value. Returns:boolean the value of the `leadAnchorNotificationEnabled` flag See Also `setLeadAnchorNotificationEnabled(boolean)`

public boolean isLeadAnchorNotificationEnabled()

Returns the value of the leadAnchorNotificationEnabled flag. When leadAnchorNotificationEnabled is true the model generates notification events with bounds that cover all the changes to the selection plus the changes to the lead and anchor indices. Setting the flag to false causes a narrowing of the event's bounds to include only the elements that have been selected or deselected since the last change. Either way, the model continues to maintain the lead and anchor variables internally. The default is true.

Note

It is possible for the lead or anchor to be changed without a change to the selection. Notification of these changes is often important, such as when the new lead or anchor needs to be updated in the view. Therefore, caution is urged when changing the default value.

Returns:boolean: the value of the leadAnchorNotificationEnabled flag
See Also: setLeadAnchorNotificationEnabled(boolean)

isSelectedIndex back to summary

isSelectedIndex	back to summary
public boolean isSelectedIndex(int index) Implements javax.swing.ListSelectionModel.isSelectedIndex. Doc from javax.swing.ListSelectionModel.isSelectedIndex. 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)

Implements javax.swing.ListSelectionModel.isSelectedIndex.

Doc from javax.swing.ListSelectionModel.isSelectedIndex.

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() Implements javax.swing.ListSelectionModel.isSelectionEmpty. Doc from javax.swing.ListSelectionModel.isSelectionEmpty. Returns true if no indices are selected. Returns:boolean `true` if no indices are selected.

public boolean isSelectionEmpty()

Implements javax.swing.ListSelectionModel.isSelectionEmpty.

Doc from javax.swing.ListSelectionModel.isSelectionEmpty.

Returns true if no indices are selected.

Returns:boolean: true if no indices are selected.

markAsDirty	back to summary
private void markAsDirty(int r)

moveLeadSelectionIndex back to summary

moveLeadSelectionIndex	back to summary
public void moveLeadSelectionIndex(int leadIndex) Set the lead selection index, leaving all selection values unchanged. If leadAnchorNotificationEnabled is true, send a notification covering the old and new lead cells. Parameters leadIndex:int the new lead selection index Since 1.5 See Also `setAnchorSelectionIndex`, `setLeadSelectionIndex`, `getLeadSelectionIndex`

public void moveLeadSelectionIndex(int leadIndex)

Set the lead selection index, leaving all selection values unchanged. If leadAnchorNotificationEnabled is true, send a notification covering the old and new lead cells.

Parameters

leadIndex:int: the new lead selection index

Since

1.5

removeIndexInterval	back to summary
public void removeIndexInterval(int index0, int index1) Implements javax.swing.ListSelectionModel.removeIndexInterval. 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. Note that (as always) index0 need not be <= index1. Parameters index0:int Doc from javax.swing.ListSelectionModel.removeIndexInterval. the beginning of the interval index1:int Doc from javax.swing.ListSelectionModel.removeIndexInterval. the end of the interval Exceptions IndexOutOfBoundsException: if either index is negative

removeIndexInterval

back to summary

public void removeIndexInterval(int index0, int index1)

Implements javax.swing.ListSelectionModel.removeIndexInterval.

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. Note that (as always) index0 need not be <= index1.

Parameters

index0:int

Doc from javax.swing.ListSelectionModel.removeIndexInterval.

the beginning of the interval

index1:int

Doc from javax.swing.ListSelectionModel.removeIndexInterval.

the end of the interval

Exceptions

IndexOutOfBoundsException:: if either index is negative

removeListSelectionListener	back to summary
public void removeListSelectionListener(ListSelectionListener l) Implements javax.swing.ListSelectionModel.removeListSelectionListener. Doc from javax.swing.ListSelectionModel.removeListSelectionListener. Remove a listener from the list that's notified each time a change to the selection occurs. Parameters l:ListSelectionListener the ListSelectionListener

removeListSelectionListener

back to summary

public void removeListSelectionListener(ListSelectionListener l)

Implements javax.swing.ListSelectionModel.removeListSelectionListener.

Doc from javax.swing.ListSelectionModel.removeListSelectionListener.

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

Parameters

l:ListSelectionListener: the ListSelectionListener

removeSelectionInterval back to summary

removeSelectionInterval	back to summary
public void removeSelectionInterval(int index0, int index1) Implements javax.swing.ListSelectionModel.removeSelectionInterval. 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. If either index is `-1`, this method does nothing and returns without exception. Otherwise, if either index is less than `-1`, an `IndexOutOfBoundsException` is thrown. Parameters index0:int one end of the interval index1:int other end of the interval Exceptions IndexOutOfBoundsException: if either index is less than `-1` (and neither index is `-1`) See Also `addListSelectionListener`

public void removeSelectionInterval(int index0, int index1)

Implements javax.swing.ListSelectionModel.removeSelectionInterval.

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.

If either index is -1, this method does nothing and returns without exception. Otherwise, if either index is less than -1, an IndexOutOfBoundsException is thrown.

Parameters

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

Exceptions

IndexOutOfBoundsException:: if either index is less than -1 (and neither index is -1)

See Also

addListSelectionListener

removeSelectionIntervalImpl	back to summary
private void removeSelectionIntervalImpl(int index0, int index1, boolean changeLeadAnchor)

set	back to summary
private void set(int r)

setAnchorSelectionIndex back to summary

public void setAnchorSelectionIndex(int anchorIndex)

Implements javax.swing.ListSelectionModel.setAnchorSelectionIndex.

Set the anchor selection index, leaving all selection values unchanged. If leadAnchorNotificationEnabled is true, send a notification covering the old and new anchor cells.

Parameters

anchorIndex:int

Doc from javax.swing.ListSelectionModel.setAnchorSelectionIndex.

the anchor selection index

setLeadAnchorNotificationEnabled back to summary

public void setLeadAnchorNotificationEnabled(boolean flag)

Sets the value of the leadAnchorNotificationEnabled flag.

Parameters

flag:boolean: boolean value for leadAnchorNotificationEnabled

See Also

isLeadAnchorNotificationEnabled()

setLeadSelectionIndex back to summary

public void setLeadSelectionIndex(int leadIndex)

Implements javax.swing.ListSelectionModel.setLeadSelectionIndex.

Sets the lead selection index, ensuring that values between the anchor and the new lead are either all selected or all deselected. If the value at the anchor index is selected, first clear all the values in the range [anchor, oldLeadIndex], then select all the values in the range [anchor, newLeadIndex], where oldLeadIndex is the old leadIndex and newLeadIndex is the new one.

If the value at the anchor index is not selected, do the same thing in reverse selecting values in the old range and deselecting values in the new one.

Generate a single event for this change and notify all listeners. For the purposes of generating minimal bounds in this event, do the operation in a single pass; that way the first and last index inside the ListSelectionEvent that is broadcast will refer to cells that actually changed value because of this method. If, instead, this operation were done in two steps the effect on the selection state would be the same but two events would be generated and the bounds around the changed values would be wider, including cells that had been first cleared only to later be set.

This method can be used in the mouseDragged method of a UI class to extend a selection.

Parameters

leadIndex:int

Doc from javax.swing.ListSelectionModel.setLeadSelectionIndex.

the lead selection index

setSelectionInterval back to summary

public void setSelectionInterval(int index0, int index1)

Implements javax.swing.ListSelectionModel.setSelectionInterval.

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.

If either index is -1, this method does nothing and returns without exception. Otherwise, if either index is less than -1, an IndexOutOfBoundsException is thrown.

Parameters

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

Exceptions

IndexOutOfBoundsException:: if either index is less than -1 (and neither index is -1)

See Also

addListSelectionListener

setSelectionMode back to summary

public void setSelectionMode(int selectionMode)

Implements javax.swing.ListSelectionModel.setSelectionMode.

Doc from javax.swing.ListSelectionModel.setSelectionMode.

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

setState	back to summary
private void setState(int index, boolean state)

setValueIsAdjusting back to summary

public void setValueIsAdjusting(boolean isAdjusting)

Implements javax.swing.ListSelectionModel.setValueIsAdjusting.

Doc from javax.swing.ListSelectionModel.setValueIsAdjusting.

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

isAdjusting:boolean: the new value of the property

toString back to summary

public String toString()

Overrides java.lang.Object.toString.

Returns a string that displays and identifies this object's properties.

Returns:String: a String representation of this object

updateLeadAnchorIndices	back to summary
private void updateLeadAnchorIndices(int anchorIndex, int leadIndex)

public Class DefaultListSelectionModel

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail