javax.swing
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^TM has been added to the java.beans package. Please see XMLEncoder .

See Also:

ListSelectionModel , Serialized Form

Field Summary

protected boolean	leadAnchorNotificationEnabled
protected EventListenerList	listenerList

Fields inherited from interface javax.swing.ListSelectionModel

MULTIPLE_INTERVAL_SELECTION , SINGLE_INTERVAL_SELECTION , SINGLE_SELECTION

Constructor Summary

DefaultListSelectionModel ()

Method Summary

void	addListSelectionListener (ListSelectionListener l) Add a listener to the list that's notified each time a change to the selection occurs.
void	addSelectionInterval (int index0, int index1) Change the selection to be the set union of the current selection and the indices between index0 and index1 inclusive.
void	clearSelection () Change the selection to the empty set.
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 ListSelectionListeners that the value of the selection, in the closed interval firstIndex, lastIndex, has changed.
protected void	fireValueChanged (int firstIndex, int lastIndex, boolean isAdjusting)
int	getAnchorSelectionIndex () Return the first index argument from the most recent call to setSelectionInterval(), addSelectionInterval() or removeSelectionInterval().
int	getLeadSelectionIndex () Return the second index argument from the most recent call to setSelectionInterval(), addSelectionInterval() or removeSelectionInterval().
<T extends EventListener > T[]	getListeners (Class <T> listenerType) Returns an array of all the objects currently registered as FooListeners upon this model.
ListSelectionListener []	getListSelectionListeners () Returns an array of all the list selection listeners registered on this DefaultListSelectionModel.
int	getMaxSelectionIndex () Returns the last selected index or -1 if the selection is empty.
int	getMinSelectionIndex () Returns the first selected index or -1 if the selection is empty.
int	getSelectionMode () Returns the selection mode.
boolean	getValueIsAdjusting () Returns true if the value is undergoing a series of changes.
void	insertIndexInterval (int index, int length, boolean before) Insert length indices beginning before/after index.
boolean	isLeadAnchorNotificationEnabled () Returns the value of the leadAnchorNotificationEnabled flag.
boolean	isSelectedIndex (int index) Returns true if the specified index is selected.
boolean	isSelectionEmpty () Returns true if no indices are selected.
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	removeListSelectionListener (ListSelectionListener l) Remove a listener from the list that's notified each time a change to the selection occurs.
void	removeSelectionInterval (int index0, int index1) Change the selection to be the set difference of the current selection and the indices between index0 and index1 inclusive.
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) Change the selection to be between index0 and index1 inclusive.
void	setSelectionMode (int selectionMode) Sets the selection mode.
void	setValueIsAdjusting (boolean isAdjusting) This property is true if upcoming changes to the value of the model should be considered a single event.
String	toString () Returns a string that displays and identifies this object's properties.

Methods inherited from class java.lang.Object

equals , finalize , getClass , hashCode , notify , notifyAll , wait , wait , wait

Field Detail

listenerList

protected EventListenerList    listenerList

leadAnchorNotificationEnabled

protected boolean leadAnchorNotificationEnabled

Constructor Detail

DefaultListSelectionModel

public DefaultListSelectionModel()

Method Detail

getMinSelectionIndex

public int getMinSelectionIndex()

Description copied from interface: ListSelectionModel

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

Specified by:

getMinSelectionIndex in interface ListSelectionModel

getMaxSelectionIndex

public int getMaxSelectionIndex()

Description copied from interface: ListSelectionModel

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

Specified by:

getMaxSelectionIndex in interface ListSelectionModel

getValueIsAdjusting

public boolean getValueIsAdjusting()

Description copied from interface: ListSelectionModel

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

Specified by:

getValueIsAdjusting in interface ListSelectionModel

Returns:

true if the value is currently adjusting

See Also:

ListSelectionModel.setValueIsAdjusting(boolean)

getSelectionMode

public int getSelectionMode()

Returns the selection mode.

Specified by:

getSelectionMode in interface ListSelectionModel

Returns:

one of the these values:

• SINGLE_SELECTION
• SINGLE_INTERVAL_SELECTION
• MULTIPLE_INTERVAL_SELECTION

See Also:

getSelectionMode()

setSelectionMode

public void setSelectionMode(int selectionMode)

Sets the selection mode. The default is MULTIPLE_INTERVAL_SELECTION.

Specified by:

setSelectionMode in interface ListSelectionModel

Parameters:

selectionMode - one of three values:

• SINGLE_SELECTION
• SINGLE_INTERVAL_SELECTION
• MULTIPLE_INTERVAL_SELECTION

Throws:

IllegalArgumentException - if selectionMode is not one of the legal values shown above

See Also:

setSelectionMode(int)

isSelectedIndex

public boolean isSelectedIndex(int index)

Description copied from interface: ListSelectionModel

Returns true if the specified index is selected.

Specified by:

isSelectedIndex in interface ListSelectionModel

isSelectionEmpty

public boolean isSelectionEmpty()

Description copied from interface: ListSelectionModel

Returns true if no indices are selected.

Specified by:

isSelectionEmpty in interface ListSelectionModel

addListSelectionListener

public void addListSelectionListener(ListSelectionListener    l)

Description copied from interface: ListSelectionModel

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

Specified by:

addListSelectionListener in interface ListSelectionModel

Parameters:

l - the ListSelectionListener

See Also:

ListSelectionModel.removeListSelectionListener(javax.swing.event.ListSelectionListener) , ListSelectionModel.setSelectionInterval(int, int) , ListSelectionModel.addSelectionInterval(int, int) , ListSelectionModel.removeSelectionInterval(int, int) , ListSelectionModel.clearSelection() , ListSelectionModel.insertIndexInterval(int, int, boolean) , ListSelectionModel.removeIndexInterval(int, int)

removeListSelectionListener

public void removeListSelectionListener(ListSelectionListener    l)

Description copied from interface: ListSelectionModel

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

Specified by:

removeListSelectionListener in interface ListSelectionModel

Parameters:

l - the ListSelectionListener

See Also:

ListSelectionModel.addListSelectionListener(javax.swing.event.ListSelectionListener)

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

Since:

1.4

See Also:

addListSelectionListener(javax.swing.event.ListSelectionListener) , removeListSelectionListener(javax.swing.event.ListSelectionListener)

fireValueChanged

protected void fireValueChanged(boolean isAdjusting)

Notifies listeners that we have ended 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.

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

Throws:

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

Since:

1.3

See Also:

getListSelectionListeners()

setLeadAnchorNotificationEnabled

public void setLeadAnchorNotificationEnabled(boolean flag)

Sets the value of the leadAnchorNotificationEnabled flag.

See Also:

isLeadAnchorNotificationEnabled()

isLeadAnchorNotificationEnabled