KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > nextapp > echo2 > app > event > ListDataEvent


1 /*
2  * This file is part of the Echo Web Application Framework (hereinafter "Echo").
3  * Copyright (C) 2002-2005 NextApp, Inc.
4  *
5  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
6  *
7  * The contents of this file are subject to the Mozilla Public License Version
8  * 1.1 (the "License"); you may not use this file except in compliance with
9  * the License. You may obtain a copy of the License at
10  * http://www.mozilla.org/MPL/
11  *
12  * Software distributed under the License is distributed on an "AS IS" basis,
13  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
14  * for the specific language governing rights and limitations under the
15  * License.
16  *
17  * Alternatively, the contents of this file may be used under the terms of
18  * either the GNU General Public License Version 2 or later (the "GPL"), or
19  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
20  * in which case the provisions of the GPL or the LGPL are applicable instead
21  * of those above. If you wish to allow use of your version of this file only
22  * under the terms of either the GPL or the LGPL, and not to allow others to
23  * use your version of this file under the terms of the MPL, indicate your
24  * decision by deleting the provisions above and replace them with the notice
25  * and other provisions required by the GPL or the LGPL. If you do not delete
26  * the provisions above, a recipient may use your version of this file under
27  * the terms of any one of the MPL, the GPL or the LGPL.
28  */
29
30 package nextapp.echo2.app.event;
31
32 import java.util.EventObject JavaDoc;
33
34 /**
35  * An event describing an update to items in a list.
36  *
37  * @see nextapp.echo2.app.event.ListDataListener
38  */
39 public class ListDataEvent extends EventObject JavaDoc {
40
41     /**
42      * An event type indicating items in the list were changed.
43      */
44     public static final int CONTENTS_CHANGED = 0;
45     
46     /**
47      * An event type indicating items were added to the list.
48      */
49     public static final int INTERVAL_ADDED = 1;
50     
51     /**
52      * An event type indicating items were removed from the list.
53      */
54     public static final int INTERVAL_REMOVED = 2;
55     
56     private int index0;
57     private int index1;
58     private int type;
59
60     /**
61      * Creates a new <code>ListDataEvent</code>
62      *
63      * @param source the object that generated the event
64      * @param type the type of event, one of the following values:
65      * <ul>
66      * <li>CONTENTS_CHANGED - Indicates a change was made to one or more
67      * items in the list.</li>
68      * <li>INTERVAL_ADDED - Indicates one or more items were added to
69      * the list.</li>
70      * <li>INTERVAL_REMOVED - Indicates one or more items were removed
71      * from the list.</li>
72      * </ul>
73      * @param index0 the first index of the interval affected by the list change
74      * @param index1 the last index of the interval affected by the list change
75      *
76      */
77     public ListDataEvent(Object JavaDoc source, int type, int index0, int index1) {
78          super(source);
79          
80          this.type = type;
81          this.index0 = index0;
82          this.index1 = index1;
83     }
84     
85     /**
86      * Returns the first index of the interval affected by the list change.
87      *
88      * @return the first index
89      */
90     public int getIndex0() {
91         return index0;
92     }
93     
94     /**
95      * Returns the last index of the interval affected by the list change.
96      *
97      * @return the last index
98      */
99     public int getIndex1() {
100         return index1;
101     }
102     
103     /**
104      * Returns the type of the event
105      *
106      * @return the type of event, one of the following values:
107      * <ul>
108      * <li>CONTENTS_CHANGED - Indicates a change was made to one or more
109      * items in the list.</li>
110      * <li>INTERVAL_ADDED - Indicates one or more items were added to
111      * the list.</li>
112      * <li>INTERVAL_REMOVED - Indicates one or more items were removed
113      * from the list.</li>
114      * </ul>
115      */
116     public int getType() {
117         return type;
118     }
119 }
120
Popular Tags