summaryrefslogtreecommitdiff
path: root/java/awt/event/ItemEvent.java
blob: 94814eccf1daa9dabed87d6e470ec820096c63ca (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
/* ItemEvent.java -- Event for item state changes.
   Copyright (C) 1999 Free Software Foundation, Inc.

This file is part of GNU Classpath.

GNU Classpath is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2, or (at your option)
any later version.

GNU Classpath is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
General Public License for more details.

You should have received a copy of the GNU General Public License
along with GNU Classpath; see the file COPYING.  If not, write to the
Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
02111-1307 USA.

As a special exception, if you link this library with other files to
produce an executable, this library does not by itself cause the
resulting executable to be covered by the GNU General Public License.
This exception does not however invalidate any other reasons why the
executable file might be covered by the GNU General Public License. */


package java.awt.event;

import java.awt.ItemSelectable;

/**
  * This event is generated when an item changes state.
  *
  * @author Aaron M. Renn (arenn@urbanophile.com)
  */
public class ItemEvent extends java.awt.AWTEvent implements java.io.Serializable
{

/*
 * Static Variables
 */

/**
  * This is the first id in the event id range used by this class.
  */
public static final int ITEM_FIRST = 701;

/**
  * This is the last id in the event id range used by this class.
  */
public static final int ITEM_LAST = 701;

/**
  * This event id indicates a state change occurred.
  */
public static final int ITEM_STATE_CHANGED = 701;

/**
  * This type indicates that the item was selected.
  */
public static final int SELECTED = 1;

/**
  * This type indicates that the item was deselected.
  */
public static final int DESELECTED = 2;

/*************************************************************************/

/*
 * Instance Variables
 */

/**
  * @serial The item affected by this event
  */
private Object item;

/**
  * @serial  The state change direction
  */
private int stateChange;

/*************************************************************************/

/*
 * Constructors
 */

/**
  * Initializes a new instance of <code>ItemEvent</code> with the specified
  * source, id, and state change constant.
  *
  * @param source The source of the event.
  * @param id The event id.
  * @param item The item affected by the state change.
  * @param stateChange The state change, either <code>SELECTED</code> or
  * <code>DESELECTED</code>.
  */
public 
ItemEvent(ItemSelectable source, int id, Object item, int stateChange)
{
  super(source, id);
  this.item = item;
  this.stateChange = stateChange;
}
  
/*************************************************************************/

/*
 * Instance Methods
 */

/**
  * This method returns the event source as an <code>ItemSelectable</code>.
  * 
  * @return The event source as an <code>ItemSelected</code>.
  */
public ItemSelectable
getItemSelectable()
{
  return((ItemSelectable)getSource());
}

/*************************************************************************/

/**
  * Returns the item affected by this state change.
  *
  * @return The item affected by this state change.
  */
public Object
getItem()
{
  return(item);
}

/*************************************************************************/

/**
  * Returns the type of state change, ether <code>SELECTED</code> or
  * <code>DESELECTED</code>.
  *
  * @return The type of state change.
  */
public int
getStateChange()
{
  return(stateChange);
}

/*************************************************************************/

/**
  * Returns a string identifying this event.
  *
  * @param A string identifying this event.
  */
public String
paramString()
{
  return(getClass().getName() + " source=" + getSource() + " id=" + getID() +
         " item=" + getItem() + " stateChange=" + getStateChange());
}

} // class ItemEvent