001/* ListDataEvent.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 038 039package javax.swing.event; 040 041import java.util.EventObject; 042 043/** 044 * An event that contains information about a modification to the content of 045 * a list. 046 * 047 * @author Andrew Selkirk 048 * @author Ronald Veldema 049 */ 050public class ListDataEvent extends EventObject 051{ 052 private static final long serialVersionUID = 2510353260071004774L; 053 054 /** An event type indicating that the list content has been modified. */ 055 public static final int CONTENTS_CHANGED = 0; 056 057 /** An event type indicating that an interval has been added to the list. */ 058 public static final int INTERVAL_ADDED = 1; 059 060 /** 061 * An event type indicating that an interval has been removed from the 062 * list. 063 */ 064 public static final int INTERVAL_REMOVED = 2; 065 066 private int type; 067 private int index0; 068 private int index1; 069 070 /** 071 * Creates a <code>ListDataEvent</code> object. 072 * 073 * @param source the source of the event (<code>null</code> not permitted). 074 * @param type the type of the event (should be one of 075 * {@link #CONTENTS_CHANGED}, {@link #INTERVAL_ADDED} or 076 * {@link #INTERVAL_REMOVED}, although this is not enforced). 077 * @param index0 the index for one end of the modified range of list 078 * elements. 079 * @param index1 the index for the other end of the modified range of list 080 * elements. 081 */ 082 public ListDataEvent(Object source, int type, int index0, int index1) 083 { 084 super(source); 085 this.type = type; 086 this.index0 = Math.min(index0, index1); 087 this.index1 = Math.max(index0, index1); 088 } 089 090 /** 091 * Returns the index of the first item in the range of modified list items. 092 * 093 * @return The index of the first item in the range of modified list items. 094 */ 095 public int getIndex0() 096 { 097 return index0; 098 } 099 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 */ 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 */ 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 */ 127 public String toString() 128 { 129 return getClass().getName() + "[type=" + type + ",index0=" + index0 130 + ",index1=" + index1 + "]"; 131 } 132}