001/* ListSelectionEvent.java --
002   Copyright (C) 2002, 2006, Free Software Foundation, Inc.
003
004This file is part of GNU Classpath.
005
006GNU Classpath is free software; you can redistribute it and/or modify
007it under the terms of the GNU General Public License as published by
008the Free Software Foundation; either version 2, or (at your option)
009any later version.
010
011GNU Classpath is distributed in the hope that it will be useful, but
012WITHOUT ANY WARRANTY; without even the implied warranty of
013MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
014General Public License for more details.
015
016You should have received a copy of the GNU General Public License
017along with GNU Classpath; see the file COPYING.  If not, write to the
018Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
01902110-1301 USA.
020
021Linking this library statically or dynamically with other modules is
022making a combined work based on this library.  Thus, the terms and
023conditions of the GNU General Public License cover the whole
024combination.
025
026As a special exception, the copyright holders of this library give you
027permission to link this library with independent modules to produce an
028executable, regardless of the license terms of these independent
029modules, and to copy and distribute the resulting executable under
030terms of your choice, provided that you also meet, for each linked
031independent module, the terms and conditions of the license of that
032module.  An independent module is a module which is not derived from
033or based on this library.  If you modify this library, you may extend
034this exception to your version of the library, but you are not
035obligated to do so.  If you do not wish to do so, delete this
036exception statement from your version. */
037
038package javax.swing.event;
039
040import java.util.EventObject;
041
042import 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 */
052public 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}