001 /* ListSelectionEvent.java --
002 Copyright (C) 2002, 2006, Free Software Foundation, Inc.
003
004 This file is part of GNU Classpath.
005
006 GNU Classpath is free software; you can redistribute it and/or modify
007 it under the terms of the GNU General Public License as published by
008 the Free Software Foundation; either version 2, or (at your option)
009 any later version.
010
011 GNU Classpath is distributed in the hope that it will be useful, but
012 WITHOUT ANY WARRANTY; without even the implied warranty of
013 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
014 General Public License for more details.
015
016 You should have received a copy of the GNU General Public License
017 along with GNU Classpath; see the file COPYING. If not, write to the
018 Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
019 02110-1301 USA.
020
021 Linking this library statically or dynamically with other modules is
022 making a combined work based on this library. Thus, the terms and
023 conditions of the GNU General Public License cover the whole
024 combination.
025
026 As a special exception, the copyright holders of this library give you
027 permission to link this library with independent modules to produce an
028 executable, regardless of the license terms of these independent
029 modules, and to copy and distribute the resulting executable under
030 terms of your choice, provided that you also meet, for each linked
031 independent module, the terms and conditions of the license of that
032 module. An independent module is a module which is not derived from
033 or based on this library. If you modify this library, you may extend
034 this exception to your version of the library, but you are not
035 obligated to do so. If you do not wish to do so, delete this
036 exception statement from your version. */
037
038 package javax.swing.event;
039
040 import java.util.EventObject;
041
042 import javax.swing.ListSelectionModel;
043
044 /**
045 * An event that indicates a change to a list selection, including the source
046 * of the change (a {@link ListSelectionModel}) and the range of items in the
047 * list that have potentially changed their selection status.
048 *
049 * @author Andrew Selkirk
050 * @author Ronald Veldema
051 */
052 public class ListSelectionEvent extends EventObject
053 {
054
055 /**
056 * The index of the first list item in the range of items that has
057 * potentially had its selection status modified.
058 */
059 private int firstIndex = 0;
060
061 /**
062 * The index of the last list item in the range of items that has
063 * potentially had its selection status modified.
064 */
065 private int lastIndex = 0;
066
067 /** A flag that indicates that this event is one in a series of events. */
068 private boolean isAdjusting = false;
069
070 /**
071 * Creates a new <code>ListSelectionEvent</code>.
072 *
073 * @param source the event source (<code>null</code> not permitted).
074 * @param firstIndex the first index.
075 * @param lastIndex the last index.
076 * @param isAdjusting a flag indicating that this event is one in a series
077 * of events updating a selection.
078 *
079 * @throws IllegalArgumentException if <code>source</code> is
080 * <code>null</code>.
081 */
082 public ListSelectionEvent(Object source, int firstIndex,
083 int lastIndex, boolean isAdjusting)
084 {
085 super(source);
086 this.firstIndex = firstIndex;
087 this.lastIndex = lastIndex;
088 this.isAdjusting = isAdjusting;
089 }
090
091 /**
092 * Returns the first index.
093 *
094 * @return The first index.
095 */
096 public int getFirstIndex()
097 {
098 return firstIndex;
099 }
100
101 /**
102 * Returns the last index.
103 *
104 * @return The last index.
105 */
106 public int getLastIndex()
107 {
108 return lastIndex;
109 }
110
111 /**
112 * Returns the flag that indicates that this event is one in a series of
113 * events updating a selection.
114 *
115 * @return A boolean.
116 */
117 public boolean getValueIsAdjusting()
118 {
119 return isAdjusting;
120 }
121
122 /**
123 * Returns a string representation of the event, typically used for debugging
124 * purposes.
125 *
126 * @return A string representation of the event.
127 */
128 public String toString()
129 {
130 return this.getClass().toString() + "[ source=" + source.toString()
131 + " firstIndex= " + firstIndex + " lastIndex= " + lastIndex
132 + " isAdjusting= " + isAdjusting + " ]";
133 }
134
135 }