Home » openjdk-7 » javax » swing » [javadoc | source]
javax.swing
public class: DefaultListSelectionModel [javadoc | source]
java.lang.Object
   javax.swing.DefaultListSelectionModel

All Implemented Interfaces:
    ListSelectionModel, Cloneable, java$io$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 JavaBeansTM has been added to the java.beans package. Please see java.beans.XMLEncoder .

Field Summary
protected  EventListenerList listenerList     
protected  boolean leadAnchorNotificationEnabled     
Method from javax.swing.DefaultListSelectionModel Summary:
addListSelectionListener,   addSelectionInterval,   clearSelection,   clone,   fireValueChanged,   fireValueChanged,   fireValueChanged,   getAnchorSelectionIndex,   getLeadSelectionIndex,   getListSelectionListeners,   getListeners,   getMaxSelectionIndex,   getMinSelectionIndex,   getSelectionMode,   getValueIsAdjusting,   insertIndexInterval,   isLeadAnchorNotificationEnabled,   isSelectedIndex,   isSelectionEmpty,   moveLeadSelectionIndex,   removeIndexInterval,   removeListSelectionListener,   removeSelectionInterval,   setAnchorSelectionIndex,   setLeadAnchorNotificationEnabled,   setLeadSelectionIndex,   setSelectionInterval,   setSelectionMode,   setValueIsAdjusting,   toString
Methods from java.lang.Object:
clone,   equals,   finalize,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait
Method from javax.swing.DefaultListSelectionModel Detail:
 public  void addListSelectionListener(ListSelectionListener l) 
    {@inheritDoc}
 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.

 public  void clearSelection() 
    {@inheritDoc}
 public Object clone() throws CloneNotSupportedException 
    Returns a clone of this selection model with the same selection. listenerLists are not duplicated.
 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) 
 public int getAnchorSelectionIndex() 
    {@inheritDoc}
 public int getLeadSelectionIndex() 
    {@inheritDoc}
 public ListSelectionListener[] getListSelectionListeners() 
    Returns an array of all the list selection listeners registered on this DefaultListSelectionModel.
 public 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.
 public int getMaxSelectionIndex() 
    {@inheritDoc}
 public int getMinSelectionIndex() 
    {@inheritDoc}
 public int getSelectionMode() 
    {@inheritDoc}
 public boolean getValueIsAdjusting() 
    {@inheritDoc}
 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.
 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.

 public boolean isSelectedIndex(int index) 
    {@inheritDoc}
 public boolean isSelectionEmpty() 
    {@inheritDoc}
 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.
 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.
 public  void removeListSelectionListener(ListSelectionListener l) 
    {@inheritDoc}
 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.

 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.
 public  void setLeadAnchorNotificationEnabled(boolean flag) 
    Sets the value of the leadAnchorNotificationEnabled flag.
 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.

 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.

 public  void setSelectionMode(int selectionMode) 
    {@inheritDoc}
 public  void setValueIsAdjusting(boolean isAdjusting) 
    {@inheritDoc}
 public String toString() 
    Returns a string that displays and identifies this object's properties.