001 /*
002 * Copyright 1997-2006 Sun Microsystems, Inc. All Rights Reserved.
003 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
004 *
005 * This code is free software; you can redistribute it and/or modify it
006 * under the terms of the GNU General Public License version 2 only, as
007 * published by the Free Software Foundation. Sun designates this
008 * particular file as subject to the "Classpath" exception as provided
009 * by Sun in the LICENSE file that accompanied this code.
010 *
011 * This code is distributed in the hope that it will be useful, but WITHOUT
012 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
013 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
014 * version 2 for more details (a copy is included in the LICENSE file that
015 * accompanied this code).
016 *
017 * You should have received a copy of the GNU General Public License version
018 * 2 along with this work; if not, write to the Free Software Foundation,
019 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
020 *
021 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
022 * CA 95054 USA or visit www.sun.com if you need additional information or
023 * have any questions.
024 */
025
026 package javax.swing.event;
027
028 import java.util.EventObject;
029 import javax.swing.*;
030
031 /**
032 * An event that characterizes a change in selection. The change is limited to a
033 * a single inclusive interval. The selection of at least one index within the
034 * range will have changed. A decent {@code ListSelectionModel} implementation
035 * will keep the range as small as possible. {@code ListSelectionListeners} will
036 * generally query the source of the event for the new selected status of each
037 * potentially changed row.
038 * <p>
039 * <strong>Warning:</strong>
040 * Serialized objects of this class will not be compatible with
041 * future Swing releases. The current serialization support is
042 * appropriate for short term storage or RMI between applications running
043 * the same version of Swing. As of 1.4, support for long term storage
044 * of all JavaBeans<sup><font size="-2">TM</font></sup>
045 * has been added to the <code>java.beans</code> package.
046 * Please see {@link java.beans.XMLEncoder}.
047 *
048 * @version 1.29 05/05/07
049 * @author Hans Muller
050 * @author Ray Ryan
051 * @see ListSelectionModel
052 */
053 public class ListSelectionEvent extends EventObject {
054 private int firstIndex;
055 private int lastIndex;
056 private boolean isAdjusting;
057
058 /**
059 * Represents a change in selection status between {@code firstIndex} and
060 * {@code lastIndex}, inclusive. {@code firstIndex} is less than or equal to
061 * {@code lastIndex}. The selection of at least one index within the range will
062 * have changed.
063 *
064 * @param firstIndex the first index in the range, <= lastIndex
065 * @param lastIndex the last index in the range, >= firstIndex
066 * @param isAdjusting whether or not this is one in a series of
067 * multiple events, where changes are still being made
068 */
069 public ListSelectionEvent(Object source, int firstIndex,
070 int lastIndex, boolean isAdjusting) {
071 super (source);
072 this .firstIndex = firstIndex;
073 this .lastIndex = lastIndex;
074 this .isAdjusting = isAdjusting;
075 }
076
077 /**
078 * Returns the index of the first row whose selection may have changed.
079 * {@code getFirstIndex() <= getLastIndex()}
080 *
081 * @return the first row whose selection value may have changed,
082 * where zero is the first row
083 */
084 public int getFirstIndex() {
085 return firstIndex;
086 }
087
088 /**
089 * Returns the index of the last row whose selection may have changed.
090 * {@code getLastIndex() >= getFirstIndex()}
091 *
092 * @return the last row whose selection value may have changed,
093 * where zero is the first row
094 */
095 public int getLastIndex() {
096 return lastIndex;
097 }
098
099 /**
100 * Returns whether or not this is one in a series of multiple events,
101 * where changes are still being made. See the documentation for
102 * {@link javax.swing.ListSelectionModel#setValueIsAdjusting} for
103 * more details on how this is used.
104 *
105 * @return {@code true} if this is one in a series of multiple events,
106 * where changes are still being made
107 */
108 public boolean getValueIsAdjusting() {
109 return isAdjusting;
110 }
111
112 /**
113 * Returns a {@code String} that displays and identifies this
114 * object's properties.
115 *
116 * @return a String representation of this object
117 */
118 public String toString() {
119 String properties = " source=" + getSource() + " firstIndex= "
120 + firstIndex + " lastIndex= " + lastIndex
121 + " isAdjusting= " + isAdjusting + " ";
122 return getClass().getName() + "[" + properties + "]";
123 }
124 }
|