summaryrefslogtreecommitdiff
path: root/java/awt/event/InputEvent.java
blob: 43f9bbf9a50990a5b5c21cb13ed5a38889caa10d (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
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
/* InputEvent.java -- Common superclass of component input events.
   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.Component;

/**
  * This is the common superclass for all component input classes.
  *
  * @author Aaron M. Renn (arenn@urbanophile.com)
  */
public abstract class InputEvent extends ComponentEvent
                      implements java.io.Serializable
{

/*
 * Static Variables
 */

/**
  * This is the bit mask which indicates the shift key is down.
  */
public static final int SHIFT_MASK = 1;

/**
  * This is the bit mask which indicates the control key is down.
  */
public static final int CTRL_MASK = 2;

/**
  * This is the bit mask which indicates the meta key is down.
  */
public static final int META_MASK = 4;

/**
  * This is the bit mask which indicates the alt key is down.
  */
public static final int ALT_MASK = 8;

/**
  * This is the bit mask which indicates the alt-graph modifier is in effect.
  */
public static final int ALT_GRAPH_MASK = 32;

/**
  * This bit mask indicates mouse button one is down.
  */
public static final int BUTTON1_MASK = 16;

/**
  * This bit mask indicates mouse button two is down.
  */
public static final int BUTTON2_MASK = 8;

/**
  * This bit mask indicates mouse button three is down.
  */
public static final int BUTTON3_MASK = 4;

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

/*
 * Instance Variables
 */

/**
  * @serial The timestamp when this event occurred.
  */
private long when;

/**
  * @serial The modifiers in effect for this event.
  */
protected int modifiers;

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

/*
 * Constructors
 */

/**
  * Initializes a new instance of <code>InputEvent</code> with the 
  * specified source, id, timestamp, and modifiers.
  *
  * @param source The source of the event.
  * @param id The event id.
  * @param when The timestamp when the event occurred
  * @param modifiers The modifiers in effect for this event, which will be the 
  * union of the constant bitmasks in this class.
  */
protected
InputEvent(Component source, int id, long when, int modifiers)
{
  super(source, id);
  this.when = when;
  this.modifiers = modifiers;
}

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

/*
 * Instance Methods
 */

/**
  * This method returns the modifiers in effect for this event.  This will
  * be a union of the bit masks defined in this class that are applicable
  * to the event.
  *
  * @return The modifiers in effect for this event.
  */
public int
getModifiers()
{
  return(modifiers);
} 
  
/*************************************************************************/

/**
  * This method returns the timestamp when this event occurred.
  *
  * @return The timestamp when this event occurred.
  */
public long
getWhen()
{
  return(when);
}

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

/**
  * This method tests whether or not the shift key is down.
  *
  * @return <code>true</code> if the shift key is down, <code>false</code>
  * otherwise.
  */
public boolean
isShiftDown()
{
  return((getModifiers() & SHIFT_MASK) > 0);
}

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

/**
  * This method tests whether or not the control key is down.
  *
  * @return <code>true</code> if the control key is down, <code>false</code>
  * otherwise.
  */
public boolean
isControlDown()
{
  return((getModifiers() & CTRL_MASK) > 0);
}

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

/**
  * This method tests whether or not the meta key is down.
  *
  * @return <code>true</code> if the meta key is down, <code>false</code>
  * otherwise.
  */
public boolean
isMetaDown()
{
  return((getModifiers() & META_MASK) > 0);
}

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

/**
  * This method tests whether or not the alt key is down.
  *
  * @return <code>true</code> if the alt key is down, <code>false</code>
  * otherwise.
  */
public boolean
isAltDown()
{
  return((getModifiers() & ALT_MASK) > 0);
}

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

/**
  * This method tests whether or not the alt-graph modifier is in effect.
  *
  * @return <code>true</code> if the alt-graph modifier is in effect,
  * <code>false</code> otherwise.
  */
public boolean
isAltGraphDown()
{
  return((getModifiers() & ALT_GRAPH_MASK) > 0);
}

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

/**
  * Consumes this event.  A consumed event is not processed by the AWT
  * system.
  */
public void
consume()
{
  super.consume();
}
 
/*************************************************************************/

/**
  * This method tests whether or not this event has been consumed.
  *
  * @return <code>true</code> if this event has been consumed, 
  * <code>false</code> otherwise.
  */
public boolean
isConsumed()
{
  return(super.isConsumed());
}

} // class InputEvent