1 /* ListDataEvent.java -- 2 Copyright (C) 2002, 2006, Free Software Foundation, Inc. 3 4 This file is part of GNU Classpath. 5 6 GNU Classpath is free software; you can redistribute it and/or modify 7 it under the terms of the GNU General Public License as published by 8 the Free Software Foundation; either version 2, or (at your option) 9 any later version. 10 11 GNU Classpath is distributed in the hope that it will be useful, but 12 WITHOUT ANY WARRANTY; without even the implied warranty of 13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 14 General Public License for more details. 15 16 You should have received a copy of the GNU General Public License 17 along with GNU Classpath; see the file COPYING. If not, write to the 18 Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 19 02110-1301 USA. 20 21 Linking this library statically or dynamically with other modules is 22 making a combined work based on this library. Thus, the terms and 23 conditions of the GNU General Public License cover the whole 24 combination. 25 26 As a special exception, the copyright holders of this library give you 27 permission to link this library with independent modules to produce an 28 executable, regardless of the license terms of these independent 29 modules, and to copy and distribute the resulting executable under 30 terms of your choice, provided that you also meet, for each linked 31 independent module, the terms and conditions of the license of that 32 module. An independent module is a module which is not derived from 33 or based on this library. If you modify this library, you may extend 34 this exception to your version of the library, but you are not 35 obligated to do so. If you do not wish to do so, delete this 36 exception statement from your version. */ 37 38 39 package javax.swing.event; 40 41 import java.util.EventObject; 42 43 /** 44 * An event that contains information about a modification to the content of 45 * a list. 46 * 47 * @author Andrew Selkirk 48 * @author Ronald Veldema 49 */ 50 public class ListDataEvent extends EventObject 51 { 52 private static final long serialVersionUID = 2510353260071004774L; 53 54 /** An event type indicating that the list content has been modified. */ 55 public static final int CONTENTS_CHANGED = 0; 56 57 /** An event type indicating that an interval has been added to the list. */ 58 public static final int INTERVAL_ADDED = 1; 59 60 /** 61 * An event type indicating that an interval has been removed from the 62 * list. 63 */ 64 public static final int INTERVAL_REMOVED = 2; 65 66 private int type; 67 private int index0; 68 private int index1; 69 70 /** 71 * Creates a <code>ListDataEvent</code> object. 72 * 73 * @param source the source of the event (<code>null</code> not permitted). 74 * @param type the type of the event (should be one of 75 * {@link #CONTENTS_CHANGED}, {@link #INTERVAL_ADDED} or 76 * {@link #INTERVAL_REMOVED}, although this is not enforced). 77 * @param index0 the index for one end of the modified range of list 78 * elements. 79 * @param index1 the index for the other end of the modified range of list 80 * elements. 81 */ ListDataEvent(Object source, int type, int index0, int index1)82 public ListDataEvent(Object source, int type, int index0, int index1) 83 { 84 super(source); 85 this.type = type; 86 this.index0 = Math.min(index0, index1); 87 this.index1 = Math.max(index0, index1); 88 } 89 90 /** 91 * Returns the index of the first item in the range of modified list items. 92 * 93 * @return The index of the first item in the range of modified list items. 94 */ getIndex0()95 public int getIndex0() 96 { 97 return index0; 98 } 99 100 /** 101 * Returns the index of the last item in the range of modified list items. 102 * 103 * @return The index of the last item in the range of modified list items. 104 */ getIndex1()105 public int getIndex1() 106 { 107 return index1; 108 } 109 110 /** 111 * Returns a code representing the type of this event, which is usually one 112 * of {@link #CONTENTS_CHANGED}, {@link #INTERVAL_ADDED} or 113 * {@link #INTERVAL_REMOVED}. 114 * 115 * @return The event type. 116 */ getType()117 public int getType() 118 { 119 return type; 120 } 121 122 /** 123 * Returns a string representing the state of this event. 124 * 125 * @return A string. 126 */ toString()127 public String toString() 128 { 129 return getClass().getName() + "[type=" + type + ",index0=" + index0 130 + ",index1=" + index1 + "]"; 131 } 132 } 133