Class DefaultListSelectionModel
- java.lang.Object
-
- javax.swing.DefaultListSelectionModel
- All Implemented Interfaces:
-
Serializable
,Cloneable
,ListSelectionModel
public class DefaultListSelectionModel extends Object implements ListSelectionModel, Cloneable, Serializable
Default data model for list selections.
Warning: Serialized objects of this class will not be compatible with future Swing releases. The current serialization support is appropriate for short term storage or RMI between applications running the same version of Swing. As of 1.4, support for long term storage of all JavaBeans™ has been added to the java.beans
package. Please see XMLEncoder
.
- Since:
- 1.2
- See Also:
-
ListSelectionModel
, Serialized Form
Field Summary
Modifier and Type | Field | Description |
---|---|---|
protected boolean | leadAnchorNotificationEnabled | Whether or not the lead anchor notification is enabled. |
protected EventListenerList | listenerList | The list of listeners. |
Fields declared in interface javax.swing.ListSelectionModel
MULTIPLE_INTERVAL_SELECTION, SINGLE_INTERVAL_SELECTION, SINGLE_SELECTION
Constructor Summary
Constructor | Description |
---|---|
DefaultListSelectionModel() |
Method Summary
Modifier and Type | Method | Description |
---|---|---|
void | addSelectionInterval(int index0,
int index1) | Changes the selection to be the set union of the current selection and the indices between |
Object | clone() | Returns a clone of this selection model with the same selection. |
protected void | fireValueChanged(boolean isAdjusting) | Notifies listeners that we have ended a series of adjustments. |
protected void | fireValueChanged(int firstIndex,
int lastIndex) | Notifies |
protected void | fireValueChanged(int firstIndex,
int lastIndex,
boolean isAdjusting) | |
<T extends EventListener> | getListeners(Class<T> listenerType) | Returns an array of all the objects currently registered as |
ListSelectionListener[] | getListSelectionListeners() | Returns an array of all the list selection listeners registered on this |
void | insertIndexInterval(int index,
int length,
boolean before) | Insert length indices beginning before/after index. |
boolean | isLeadAnchorNotificationEnabled() | Returns the value of the |
void | moveLeadSelectionIndex(int leadIndex) | Set the lead selection index, leaving all selection values unchanged. |
void | removeIndexInterval(int index0,
int index1) | Remove the indices in the interval index0,index1 (inclusive) from the selection model. |
void | removeSelectionInterval(int index0,
int index1) | Changes the selection to be the set difference of the current selection and the indices between |
void | setAnchorSelectionIndex(int anchorIndex) | Set the anchor selection index, leaving all selection values unchanged. |
void | setLeadAnchorNotificationEnabled(boolean flag) | Sets the value of the leadAnchorNotificationEnabled flag. |
void | setLeadSelectionIndex(int leadIndex) | Sets the lead selection index, ensuring that values between the anchor and the new lead are either all selected or all deselected. |
void | setSelectionInterval(int index0,
int index1) | Changes the selection to be between |
void | setSelectionMode(int selectionMode) | Sets the selection mode. |
String | toString() | Returns a string that displays and identifies this object's properties. |
Methods declared in class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
Methods declared in interface javax.swing.ListSelectionModel
addListSelectionListener, clearSelection, getAnchorSelectionIndex, getLeadSelectionIndex, getMaxSelectionIndex, getMinSelectionIndex, getSelectedIndices, getSelectedItemsCount, getSelectionMode, getValueIsAdjusting, isSelectedIndex, isSelectionEmpty, removeListSelectionListener, setValueIsAdjusting
Field Detail
listenerList
protected EventListenerList listenerList
The list of listeners.
leadAnchorNotificationEnabled
protected boolean leadAnchorNotificationEnabled
Whether or not the lead anchor notification is enabled.
Constructor Detail
DefaultListSelectionModel
public DefaultListSelectionModel()
Method Detail
setSelectionMode
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
andaddSelectionInterval
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 likesetSelectionInterval
(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.
- Specified by:
-
setSelectionMode
in interfaceListSelectionModel
- Parameters:
-
selectionMode
- the selection mode - Throws:
-
IllegalArgumentException
- if the selection mode isn't one of those allowed - See Also:
ListSelectionModel.getSelectionMode()
getListSelectionListeners
public ListSelectionListener[] getListSelectionListeners()
Returns an array of all the list selection listeners registered on this DefaultListSelectionModel
.
- Returns:
- all of this model's
ListSelectionListener
s or an empty array if no list selection listeners are currently registered - Since:
- 1.4
- See Also:
-
ListSelectionModel.addListSelectionListener(javax.swing.event.ListSelectionListener)
,ListSelectionModel.removeListSelectionListener(javax.swing.event.ListSelectionListener)
fireValueChanged
protected void fireValueChanged(boolean isAdjusting)
Notifies listeners that we have ended a series of adjustments.
- Parameters:
-
isAdjusting
- true if this is the final change in a series of adjustments
fireValueChanged
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
- the first index in the interval -
lastIndex
- the last index in the interval
fireValueChanged
protected void fireValueChanged(int firstIndex, int lastIndex, boolean isAdjusting)
- Parameters:
-
firstIndex
- the first index in the interval -
lastIndex
- the last index in the interval -
isAdjusting
- true if this is the final change in a series of adjustments - See Also:
EventListenerList
getListeners
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.
- Type Parameters:
-
T
- the type ofEventListener
class being requested - Parameters:
-
listenerType
- the type of listeners requested; this parameter should specify an interface that descends fromjava.util.EventListener
- Returns:
- an array of all objects registered as
FooListener
s on this model, or an empty array if no such listeners have been added - Throws:
-
ClassCastException
- iflistenerType
doesn't specify a class or interface that implementsjava.util.EventListener
- Since:
- 1.3
- See Also:
getListSelectionListeners()
setLeadAnchorNotificationEnabled
public void setLeadAnchorNotificationEnabled(boolean flag)
Sets the value of the leadAnchorNotificationEnabled flag.
- Parameters:
-
flag
- boolean value forleadAnchorNotificationEnabled
- See Also:
isLeadAnchorNotificationEnabled()
isLeadAnchorNotificationEnabled
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:
- the value of the
leadAnchorNotificationEnabled
flag - See Also:
setLeadAnchorNotificationEnabled(boolean)
setSelectionInterval
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.
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.
- Specified by:
-
setSelectionInterval
in interfaceListSelectionModel
- Parameters:
-
index0
- one end of the interval. -
index1
- other end of the interval - Throws:
-
IndexOutOfBoundsException
- if either index is less than-1
(and neither index is-1
) - See Also:
ListSelectionModel.addListSelectionListener(javax.swing.event.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 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.
- Specified by:
-
addSelectionInterval
in interfaceListSelectionModel
- Parameters:
-
index0
- one end of the interval. -
index1
- other end of the interval - Throws:
-
IndexOutOfBoundsException
- if either index is less than-1
(and neither index is-1
) - See Also:
-
ListSelectionModel.addListSelectionListener(javax.swing.event.ListSelectionListener)
,setSelectionInterval(int, int)
removeSelectionInterval
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.
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.
- Specified by:
-
removeSelectionInterval
in interfaceListSelectionModel
- Parameters:
-
index0
- one end of the interval -
index1
- other end of the interval - Throws:
-
IndexOutOfBoundsException
- if either index is less than-1
(and neither index is-1
) - See Also:
ListSelectionModel.addListSelectionListener(javax.swing.event.ListSelectionListener)
insertIndexInterval
public void insertIndexInterval(int index, int length, boolean before)
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.
- Specified by:
-
insertIndexInterval
in interfaceListSelectionModel
- Parameters:
-
index
- the beginning of the interval -
length
- the length of the interval -
before
- iftrue
, interval inserts before theindex
, otherwise, interval inserts after theindex
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. Note that (as always) index0 need not be <= index1.
- Specified by:
-
removeIndexInterval
in interfaceListSelectionModel
- Parameters:
-
index0
- the beginning of the interval -
index1
- the end of the interval
toString
public String toString()
Returns a string that displays and identifies this object's properties.
clone
public Object clone() throws CloneNotSupportedException
Returns a clone of this selection model with the same selection. listenerLists
are not duplicated.
- Overrides:
-
clone
in classObject
- Returns:
- a clone of this instance.
- Throws:
-
CloneNotSupportedException
- if the selection model does not both (a) implement the Cloneable interface and (b) define aclone
method. - See Also:
Cloneable
setAnchorSelectionIndex
public void setAnchorSelectionIndex(int anchorIndex)
Set the anchor selection index, leaving all selection values unchanged. If leadAnchorNotificationEnabled is true, send a notification covering the old and new anchor cells.
- Specified by:
-
setAnchorSelectionIndex
in interfaceListSelectionModel
- Parameters:
-
anchorIndex
- the anchor selection index - See Also:
-
ListSelectionModel.getAnchorSelectionIndex()
,setLeadSelectionIndex(int)
moveLeadSelectionIndex
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
- the new lead selection index - Since:
- 1.5
- See Also:
-
setAnchorSelectionIndex(int)
,setLeadSelectionIndex(int)
,ListSelectionModel.getLeadSelectionIndex()
setLeadSelectionIndex
public void setLeadSelectionIndex(int leadIndex)
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 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.
- Specified by:
-
setLeadSelectionIndex
in interfaceListSelectionModel
- Parameters:
-
leadIndex
- the lead selection index - See Also:
-
ListSelectionModel.getLeadSelectionIndex()
,setAnchorSelectionIndex(int)