|
Java™ Platform Standard Ed. 6 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object java.util.EventObject java.awt.AWTEvent java.awt.event.ComponentEvent java.awt.event.InputEvent
public abstract class InputEvent
The root event class for all component-level input events. Input events are delivered to listeners before they are processed normally by the source where they originated. This allows listeners and component subclasses to "consume" the event so that the source will not process them in their default manner. For example, consuming mousePressed events on a Button component will prevent the Button from being activated.
KeyEvent
,
KeyAdapter
,
MouseEvent
,
MouseAdapter
,
MouseMotionAdapter
,
Serialized FormField Summary | |
---|---|
static int |
ALT_DOWN_MASK
The Alt key extended modifier constant. |
static int |
ALT_GRAPH_DOWN_MASK
The AltGraph key extended modifier constant. |
static int |
ALT_GRAPH_MASK
The AltGraph key modifier constant. |
static int |
ALT_MASK
The Alt key modifier constant. |
static int |
BUTTON1_DOWN_MASK
The Mouse Button1 extended modifier constant. |
static int |
BUTTON1_MASK
The Mouse Button1 modifier constant. |
static int |
BUTTON2_DOWN_MASK
The Mouse Button2 extended modifier constant. |
static int |
BUTTON2_MASK
The Mouse Button2 modifier constant. |
static int |
BUTTON3_DOWN_MASK
The Mouse Button3 extended modifier constant. |
static int |
BUTTON3_MASK
The Mouse Button3 modifier constant. |
static int |
CTRL_DOWN_MASK
The Control key extended modifier constant. |
static int |
CTRL_MASK
The Control key modifier constant. |
static int |
META_DOWN_MASK
The Meta key extended modifier constant. |
static int |
META_MASK
The Meta key modifier constant. |
static int |
SHIFT_DOWN_MASK
The Shift key extended modifier constant. |
static int |
SHIFT_MASK
The Shift key modifier constant. |
Fields inherited from class java.awt.event.ComponentEvent |
---|
COMPONENT_FIRST, COMPONENT_HIDDEN, COMPONENT_LAST, COMPONENT_MOVED, COMPONENT_RESIZED, COMPONENT_SHOWN |
Fields inherited from class java.util.EventObject |
---|
source |
Method Summary | |
---|---|
void |
consume()
Consumes this event so that it will not be processed in the default manner by the source which originated it. |
int |
getModifiers()
Returns the modifier mask for this event. |
int |
getModifiersEx()
Returns the extended modifier mask for this event. |
static String |
getModifiersExText(int modifiers)
Returns a String describing the extended modifier keys and mouse buttons, such as "Shift", "Button1", or "Ctrl+Shift". |
long |
getWhen()
Returns the timestamp of when this event occurred. |
boolean |
isAltDown()
Returns whether or not the Alt modifier is down on this event. |
boolean |
isAltGraphDown()
Returns whether or not the AltGraph modifier is down on this event. |
boolean |
isConsumed()
Returns whether or not this event has been consumed. |
boolean |
isControlDown()
Returns whether or not the Control modifier is down on this event. |
boolean |
isMetaDown()
Returns whether or not the Meta modifier is down on this event. |
boolean |
isShiftDown()
Returns whether or not the Shift modifier is down on this event. |
Methods inherited from class java.awt.event.ComponentEvent |
---|
getComponent, paramString |
Methods inherited from class java.awt.AWTEvent |
---|
getID, setSource, toString |
Methods inherited from class java.util.EventObject |
---|
getSource |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final int SHIFT_MASK
public static final int CTRL_MASK
public static final int META_MASK
public static final int ALT_MASK
public static final int ALT_GRAPH_MASK
public static final int BUTTON1_MASK
public static final int BUTTON2_MASK
public static final int BUTTON3_MASK
public static final int SHIFT_DOWN_MASK
public static final int CTRL_DOWN_MASK
public static final int META_DOWN_MASK
public static final int ALT_DOWN_MASK
public static final int BUTTON1_DOWN_MASK
public static final int BUTTON2_DOWN_MASK
public static final int BUTTON3_DOWN_MASK
public static final int ALT_GRAPH_DOWN_MASK
Method Detail |
---|
public boolean isShiftDown()
public boolean isControlDown()
public boolean isMetaDown()
public boolean isAltDown()
public boolean isAltGraphDown()
public long getWhen()
public int getModifiers()
public int getModifiersEx()
For example, if the user presses button 1 followed by button 2, and then releases them in the same order, the following sequence of events is generated:
MOUSE_PRESSED
:BUTTON1_DOWN_MASK
MOUSE_PRESSED
:BUTTON1_DOWN_MASK | BUTTON2_DOWN_MASK
MOUSE_RELEASED
:BUTTON2_DOWN_MASK
MOUSE_CLICKED
:BUTTON2_DOWN_MASK
MOUSE_RELEASED
:MOUSE_CLICKED
:
It is not recommended to compare the return value of this method
using ==
because new modifiers can be added in the future.
For example, the appropriate way to check that SHIFT and BUTTON1 are
down, but CTRL is up is demonstrated by the following code:
int onmask = SHIFT_DOWN_MASK | BUTTON1_DOWN_MASK; int offmask = CTRL_DOWN_MASK; if ((event.getModifiersEx() & (onmask | offmask)) == onmask) { ... }The above code will work even if new modifiers are added.
public void consume()
consume
in class AWTEvent
public boolean isConsumed()
isConsumed
in class AWTEvent
consume()
public static String getModifiersExText(int modifiers)
modifiers
- a modifier mask describing the extended
modifier keys and mouse buttons for the event
|
Java™ Platform Standard Ed. 6 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Copyright © 1993, 2010, Oracle and/or its affiliates. All rights reserved.