javax.swing
class DefaultListSelectionModel

java.lang.Object javax.swing.DefaultListSelectionModel

All Implemented Interfaces:

Serializable, Cloneable, ListSelectionModel

Most common way to construct:

DefaultListSelectionModel m = new DefaultListSelectionModel();

Based on 9 examples

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^TM has been added to the java.beans package. Please see {@link java.beans.XMLEncoder}.

leadAnchorNotificationEnabled

protected boolean leadAnchorNotificationEnabled

listenerList

protected EventListenerList listenerList

DefaultListSelectionModel

public DefaultListSelectionModel()

addListSelectionListener

public void addListSelectionListener(ListSelectionListener l)

{@inheritDoc}

Parameters:

l

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.

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

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

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

Parameters:

index0 - one end of the interval.

index1 - other end of the interval

clearSelection

public void clearSelection()

{@inheritDoc}

clone

public Object clone()
             throws CloneNotSupportedException

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

Overrides:

clone in class Object

Throws:

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

fireValueChanged

protected void fireValueChanged(boolean isAdjusting)

Notifies listeners that we have ended a series of adjustments.

Parameters:

isAdjusting

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

lastIndex

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

getAnchorSelectionIndex

public int getAnchorSelectionIndex()

{@inheritDoc}

getLeadSelectionIndex

public int getLeadSelectionIndex()

{@inheritDoc}

getListeners

public EventListener[] getListeners(Class 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:

listenerType - the type of listeners requested; this parameter should specify an interface that descends from java.util.EventListener

Returns:

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

getListSelectionListeners

public ListSelectionListener[] getListSelectionListeners()

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

Returns:

all of this model's ListSelectionListeners or an empty array if no list selection listeners are currently registered

getMaxSelectionIndex

public int getMaxSelectionIndex()

{@inheritDoc}

getMinSelectionIndex

public int getMinSelectionIndex()

{@inheritDoc}

getSelectionMode

public int getSelectionMode()

{@inheritDoc}

getValueIsAdjusting

public boolean getValueIsAdjusting()

{@inheritDoc}

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.

Parameters:

index

length

before

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

isSelectedIndex

public boolean isSelectedIndex(int index)

{@inheritDoc}

Parameters:

index

isSelectionEmpty

public boolean isSelectionEmpty()

{@inheritDoc}

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

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.

Parameters:

index0

index1

removeListSelectionListener

public void removeListSelectionListener(ListSelectionListener l)

{@inheritDoc}

Parameters:

l

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.

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

Parameters:

index0 - one end of the interval

index1 - other end of the interval

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.

Parameters:

anchorIndex

setLeadAnchorNotificationEnabled

public void setLeadAnchorNotificationEnabled(boolean flag)

Sets the value of the leadAnchorNotificationEnabled flag.

Parameters:

flag

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

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.

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

Parameters:

index0 - one end of the interval.

index1 - other end of the interval

setSelectionMode

public void setSelectionMode(int selectionMode)

{@inheritDoc}

Parameters:

selectionMode

setValueIsAdjusting

public void setValueIsAdjusting(boolean isAdjusting)

{@inheritDoc}

Parameters:

isAdjusting

toString

public String toString()

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

Overrides:

toString in class Object

Returns:

a String representation of this object