This documentation differs from the official API. Jadeite adds extra features to the API including: variable font sizes, constructions examples, placeholders for classes and methods, and auto-generated “See Also” links. Additionally it is missing some items found in standard Javadoc documentation, including: generics type information, “Deprecated” tags and comments, “See Also” links, along with other minor differences. Please send any questions or feedback to bam@cs.cmu.edu.


javax.swing.event
class ListSelectionEvent

java.lang.Object extended by java.util.EventObject extended by javax.swing.event.ListSelectionEvent
All Implemented Interfaces:
Serializable

public class ListSelectionEvent
extends EventObject

An event that characterizes a change in selection. The change is limited to a a single inclusive interval. The selection of at least one index within the range will have changed. A decent {@code ListSelectionModel} implementation will keep the range as small as possible. {@code ListSelectionListeners} will generally query the source of the event for the new selected status of each potentially changed row.

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 {@link java.beans.XMLEncoder}.


Field Summary
 
Fields inherited from class java.util.EventObject
source
 
Constructor Summary
ListSelectionEvent(Object source, int firstIndex, int lastIndex, boolean isAdjusting)

          Represents a change in selection status between and , inclusive.
 
Method Summary
 int

          Returns the index of the first row whose selection may have changed.
 int

          Returns the index of the last row whose selection may have changed.
 boolean

          Returns whether or not this is one in a series of multiple events, where changes are still being made.
 String

          Returns a that displays and identifies this object's properties.
 
Methods inherited from class java.util.EventObject
getSource, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ListSelectionEvent

public ListSelectionEvent(Object source,
                          int firstIndex,
                          int lastIndex,
                          boolean isAdjusting)
Represents a change in selection status between {@code firstIndex} and {@code lastIndex}, inclusive. {@code firstIndex} is less than or equal to {@code lastIndex}. The selection of at least one index within the range will have changed.

Parameters:
source
firstIndex - the first index in the range, <= lastIndex
lastIndex - the last index in the range, >= firstIndex
isAdjusting - whether or not this is one in a series of multiple events, where changes are still being made
Method Detail

getFirstIndex

public int getFirstIndex()
Returns the index of the first row whose selection may have changed. {@code getFirstIndex() <= getLastIndex()}

Returns:
the first row whose selection value may have changed, where zero is the first row

getLastIndex

public int getLastIndex()
Returns the index of the last row whose selection may have changed. {@code getLastIndex() >= getFirstIndex()}

Returns:
the last row whose selection value may have changed, where zero is the first row

getValueIsAdjusting

public boolean getValueIsAdjusting()
Returns whether or not this is one in a series of multiple events, where changes are still being made. See the documentation for {@link javax.swing.ListSelectionModel#setValueIsAdjusting} for more details on how this is used.

Returns:
{@code true} if this is one in a series of multiple events, where changes are still being made

toString

public String toString()
Returns a {@code String} that displays and identifies this object's properties.

Overrides:
toString in class EventObject
Returns:
a String representation of this object


This documentation differs from the official API. Jadeite adds extra features to the API including: variable font sizes, constructions examples, placeholders for classes and methods, and auto-generated “See Also” links. Additionally it is missing some items found in standard Javadoc documentation, including: generics type information, “Deprecated” tags and comments, “See Also” links, along with other minor differences. Please send any questions or feedback to bam@cs.cmu.edu.
This page displays the Jadeite version of the documention, which is derived from the offical documentation that contains this copyright notice:
Copyright 2008 Sun Microsystems, Inc. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.
The official Sun™ documentation can be found here at http://java.sun.com/javase/6/docs/api/.