javax.swing.DefaultListSelectionModel
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Object
public class DefaultListSelectionModel
Disabled: no SafeJ information.
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 JavaBeansTM
has been added to the java.beans package.
Please see XMLEncoder.
ListSelectionModel| 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)
Changes 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(). |
|
|
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 current selection mode. |
|
boolean |
getValueIsAdjusting()
Returns true if the selection 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)
Changes 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)
Changes the selection to be between index0 and index1
inclusive. |
|
void |
setSelectionMode(int selectionMode)
Sets the selection mode. |
|
void |
setValueIsAdjusting(boolean isAdjusting)
Sets the valueIsAdjusting property, which indicates whether
or not upcoming selection changes should be considered part of a single
change. |
|
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 |
|---|
protected EventListenerList listenerList
protected boolean leadAnchorNotificationEnabled
| Constructor Detail |
|---|
public DefaultListSelectionModel()
| Method Detail |
|---|
public int getMinSelectionIndex()
getMinSelectionIndex in interface ListSelectionModelpublic int getMaxSelectionIndex()
getMaxSelectionIndex in interface ListSelectionModelpublic boolean getValueIsAdjusting()
true if the selection is undergoing a series of changes.
getValueIsAdjusting in interface ListSelectionModelListSelectionModel.setValueIsAdjusting(boolean)public int getSelectionMode()
getSelectionMode in interface ListSelectionModelListSelectionModel.setSelectionMode(int)public void setSelectionMode(int selectionMode)
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.
setSelectionMode in interface ListSelectionModelIllegalArgumentException - if the selection mode isn't
one of those allowedListSelectionModel.getSelectionMode()public boolean isSelectedIndex(int index)
isSelectedIndex in interface ListSelectionModelpublic boolean isSelectionEmpty()
isSelectionEmpty in interface ListSelectionModelpublic void addListSelectionListener(ListSelectionListener l)
addListSelectionListener in interface ListSelectionModell - the ListSelectionListenerListSelectionModel.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)public void removeListSelectionListener(ListSelectionListener l)
removeListSelectionListener in interface ListSelectionModell - the ListSelectionListenerListSelectionModel.addListSelectionListener(javax.swing.event.ListSelectionListener)public ListSelectionListener[] getListSelectionListeners()
DefaultListSelectionModel.
ListSelectionListeners
or an empty
array if no list selection listeners are currently registeredaddListSelectionListener(javax.swing.event.ListSelectionListener),
removeListSelectionListener(javax.swing.event.ListSelectionListener)protected void fireValueChanged(boolean isAdjusting)
protected void fireValueChanged(int firstIndex,
int lastIndex)
ListSelectionListeners that the value
of the selection, in the closed interval firstIndex,
lastIndex, has changed.
protected void fireValueChanged(int firstIndex,
int lastIndex,
boolean isAdjusting)
firstIndex - the first index in the intervallastIndex - the last index in the intervalisAdjusting - true if this is the final change in a series of
adjustmentsEventListenerListpublic <T extends EventListener> T[] getListeners(Class<T> listenerType)
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.
listenerType - the type of listeners requested;
this parameter should specify an interface
that descends from java.util.EventListener
FooListeners
on this model,
or an empty array if no such
listeners have been added
ClassCastException - if listenerType doesn't
specify a class or interface that implements
java.util.EventListenergetListSelectionListeners()public void setLeadAnchorNotificationEnabled(boolean flag)
isLeadAnchorNotificationEnabled()public boolean isLeadAnchorNotificationEnabled()
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.
leadAnchorNotificationEnabled flagsetLeadAnchorNotificationEnabled(boolean)public void clearSelection()
clearSelection in interface ListSelectionModelListSelectionModel.addListSelectionListener(javax.swing.event.ListSelectionListener)
public void setSelectionInterval(int index0,
int index1)
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.
setSelectionInterval in interface ListSelectionModelindex0 - one end of the interval.index1 - other end of the interval
IndexOutOfBoundsException - if either index is less than -1
(and neither index is -1)addListSelectionListener(javax.swing.event.ListSelectionListener)
public void addSelectionInterval(int index0,
int index1)
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.
addSelectionInterval in interface ListSelectionModelindex0 - one end of the interval.index1 - other end of the interval
IndexOutOfBoundsException - if either index is less than -1
(and neither index is -1)addListSelectionListener(javax.swing.event.ListSelectionListener),
setSelectionInterval(int, int)
public void removeSelectionInterval(int index0,
int index1)
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.
removeSelectionInterval in interface ListSelectionModelindex0 - one end of the intervalindex1 - other end of the interval
IndexOutOfBoundsException - if either index is less than -1
(and neither index is -1)addListSelectionListener(javax.swing.event.ListSelectionListener)
public void insertIndexInterval(int index,
int length,
boolean before)
insertIndexInterval in interface ListSelectionModel
public void removeIndexInterval(int index0,
int index1)
removeIndexInterval in interface ListSelectionModelpublic void setValueIsAdjusting(boolean isAdjusting)
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.
setValueIsAdjusting in interface ListSelectionModelisAdjusting - the new value of the propertyListSelectionModel.getValueIsAdjusting(),
ListSelectionEvent.getValueIsAdjusting()public String toString()
toString in class ObjectString representation of this object
public Object clone()
throws CloneNotSupportedException
listenerLists are not duplicated.
clone in class ObjectCloneNotSupportedException - if the selection model does not
both (a) implement the Cloneable interface and (b) define a
clone method.Cloneablepublic int getAnchorSelectionIndex()
getAnchorSelectionIndex in interface ListSelectionModelListSelectionModel.getLeadSelectionIndex(),
ListSelectionModel.setSelectionInterval(int, int),
ListSelectionModel.addSelectionInterval(int, int)public int getLeadSelectionIndex()
getLeadSelectionIndex in interface ListSelectionModelListSelectionModel.getAnchorSelectionIndex(),
ListSelectionModel.setSelectionInterval(int, int),
ListSelectionModel.addSelectionInterval(int, int)public void setAnchorSelectionIndex(int anchorIndex)
setAnchorSelectionIndex in interface ListSelectionModelgetAnchorSelectionIndex(),
setLeadSelectionIndex(int)public void moveLeadSelectionIndex(int leadIndex)
leadIndex - the new lead selection indexsetAnchorSelectionIndex(int),
setLeadSelectionIndex(int),
getLeadSelectionIndex()public void setLeadSelectionIndex(int leadIndex)
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.
setLeadSelectionIndex in interface ListSelectionModelgetLeadSelectionIndex(),
setAnchorSelectionIndex(int)
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||