001 /*
002 * Copyright 1997-2003 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
030 /**
031 * Defines an event that encapsulates changes to a list.
032 * <p>
033 * <strong>Warning:</strong>
034 * Serialized objects of this class will not be compatible with
035 * future Swing releases. The current serialization support is
036 * appropriate for short term storage or RMI between applications running
037 * the same version of Swing. As of 1.4, support for long term storage
038 * of all JavaBeans<sup><font size="-2">TM</font></sup>
039 * has been added to the <code>java.beans</code> package.
040 * Please see {@link java.beans.XMLEncoder}.
041 *
042 * @version 1.25 05/05/07
043 * @author Hans Muller
044 */
045 public class ListDataEvent extends EventObject {
046 /** Identifies one or more changes in the lists contents. */
047 public static final int CONTENTS_CHANGED = 0;
048 /** Identifies the addition of one or more contiguous items to the list */
049 public static final int INTERVAL_ADDED = 1;
050 /** Identifies the removal of one or more contiguous items from the list */
051 public static final int INTERVAL_REMOVED = 2;
052
053 private int type;
054 private int index0;
055 private int index1;
056
057 /**
058 * Returns the event type. The possible values are:
059 * <ul>
060 * <li> {@link #CONTENTS_CHANGED}
061 * <li> {@link #INTERVAL_ADDED}
062 * <li> {@link #INTERVAL_REMOVED}
063 * </ul>
064 *
065 * @return an int representing the type value
066 */
067 public int getType() {
068 return type;
069 }
070
071 /**
072 * Returns the lower index of the range. For a single
073 * element, this value is the same as that returned by {@link #getIndex1}.
074
075 *
076 * @return an int representing the lower index value
077 */
078 public int getIndex0() {
079 return index0;
080 }
081
082 /**
083 * Returns the upper index of the range. For a single
084 * element, this value is the same as that returned by {@link #getIndex0}.
085 *
086 * @return an int representing the upper index value
087 */
088 public int getIndex1() {
089 return index1;
090 }
091
092 /**
093 * Constructs a ListDataEvent object. If index0 is >
094 * index1, index0 and index1 will be swapped such that
095 * index0 will always be <= index1.
096 *
097 * @param source the source Object (typically <code>this</code>)
098 * @param type an int specifying {@link #CONTENTS_CHANGED},
099 * {@link #INTERVAL_ADDED}, or {@link #INTERVAL_REMOVED}
100 * @param index0 one end of the new interval
101 * @param index1 the other end of the new interval
102 */
103 public ListDataEvent(Object source, int type, int index0, int index1) {
104 super (source);
105 this .type = type;
106 this .index0 = Math.min(index0, index1);
107 this .index1 = Math.max(index0, index1);
108 }
109
110 /**
111 * Returns a string representation of this ListDataEvent. This method
112 * is intended to be used only for debugging purposes, and the
113 * content and format of the returned string may vary between
114 * implementations. The returned string may be empty but may not
115 * be <code>null</code>.
116 *
117 * @since 1.4
118 * @return a string representation of this ListDataEvent.
119 */
120 public String toString() {
121 return getClass().getName() + "[type=" + type + ",index0="
122 + index0 + ",index1=" + index1 + "]";
123 }
124 }
|