| java.awt.event.ComponentEvent
 java.awt.event.InputEvent
All known Subclasses: java.awt.event.KeyEvent, java.awt.event.MouseEvent,
| InputEvent | | abstract public class InputEvent extends ComponentEvent (Code) | | 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.
author:
Carl Quinn
version:
1.22, 08/19/02
See Also: KeyEvent
See Also: KeyAdapter
See Also: MouseEvent
See Also: MouseAdapter
See Also: MouseMotionAdapter
since:
1.1 |
| Field Summary | |
| final public static int | ALT_DOWN_MASK
The ALT key extended modifier constant. | | final public static int | ALT_GRAPH_DOWN_MASK
The alt-graph key extended modifier constant. | | final public static int | ALT_GRAPH_MASK
The alt-graph key modifier constant. | | final public static int | ALT_MASK
The alt key modifier constant. | | final public static int | BUTTON1_DOWN_MASK
The mouse button1 extended modifier constant. | | final public static int | BUTTON1_MASK
The mouse button1 modifier constant. | | final public static int | BUTTON2_DOWN_MASK
The mouse button2 extended modifier constant. | | final public static int | BUTTON2_MASK
The mouse button2 modifier constant. | | final public static int | BUTTON3_DOWN_MASK
The mouse button3 extended modifier constant. | | final public static int | BUTTON3_MASK
The mouse button3 modifier constant. | | final public static int | CTRL_DOWN_MASK
The CTRL key extended modifier constant. | | final public static int | CTRL_MASK
The control key modifier constant. | | final static int | JDK_1_3_MODIFIERS
| | final public static int | META_DOWN_MASK
The META key extended modifier constant. | | final public static int | META_MASK
The meta key modifier constant. | | final public static int | SHIFT_DOWN_MASK
The SHIFT key extended modifier constant. | | final public static int | SHIFT_MASK
The shift key modifier constant. | | int | modifiers
The state of the modifier key at the time the input
event was fired. | | final static long | serialVersionUID
| | long | when
The input events Time stamp. |
| Constructor Summary | |
| | InputEvent(Component source, int id, long when, int modifiers)
Constructs an InputEvent object with the specified source component,
modifiers, and type. |
| Method Summary | |
| public void | consume()
Consumes this event so that it will not be processed
in the default manner by the source which originated it. | | public int | getModifiers()
Returns the modifiers flag for this event. | | public int | getModifiersEx()
Returns the extended modifiers flag for this event. | | public static String | getModifiersExText(int modifiers)
Returns a String describing the extended modifier key(s), such as "Shift",
"Button1" or "Ctrl+Shift" . | | public long | getWhen()
Returns the timestamp of when this event occurred. | | public boolean | isAltDown()
Returns whether or not the Alt modifier is down on this event. | | public boolean | isAltGraphDown()
Returns whether or not the Alt-Graph modifier is down on this event. | | public boolean | isConsumed()
Returns whether or not this event has been consumed. | | public boolean | isControlDown()
Returns whether or not the Control modifier is down on this event. | | public boolean | isMetaDown()
Returns whether or not the Meta modifier is down on this event. | | public boolean | isShiftDown()
Returns whether or not the Shift modifier is down on this event. |
| ALT_DOWN_MASK | | final public static int ALT_DOWN_MASK(Code) | | The ALT key extended modifier constant.
since:
1.4 |
| ALT_GRAPH_DOWN_MASK | | final public static int ALT_GRAPH_DOWN_MASK(Code) | | The alt-graph key extended modifier constant.
since:
1.4 |
| ALT_GRAPH_MASK | | final public static int ALT_GRAPH_MASK(Code) | | The alt-graph key modifier constant.
|
| ALT_MASK | | final public static int ALT_MASK(Code) | | The alt key modifier constant.
It is recommended that ALT_DOWN_MASK to be used instead.
|
| BUTTON1_DOWN_MASK | | final public static int BUTTON1_DOWN_MASK(Code) | | The mouse button1 extended modifier constant.
since:
1.4 |
| BUTTON1_MASK | | final public static int BUTTON1_MASK(Code) | | The mouse button1 modifier constant.
It is recommended that BUTTON1_DOWN_MASK to be used instead.
|
| BUTTON2_DOWN_MASK | | final public static int BUTTON2_DOWN_MASK(Code) | | The mouse button2 extended modifier constant.
since:
1.4 |
| BUTTON2_MASK | | final public static int BUTTON2_MASK(Code) | | The mouse button2 modifier constant.
It is recommended that BUTTON2_DOWN_MASK to be used instead.
|
| BUTTON3_DOWN_MASK | | final public static int BUTTON3_DOWN_MASK(Code) | | The mouse button3 extended modifier constant.
since:
1.4 |
| BUTTON3_MASK | | final public static int BUTTON3_MASK(Code) | | The mouse button3 modifier constant.
It is recommended that BUTTON3_DOWN_MASK to be used instead.
|
| CTRL_DOWN_MASK | | final public static int CTRL_DOWN_MASK(Code) | | The CTRL key extended modifier constant.
since:
1.4 |
| CTRL_MASK | | final public static int CTRL_MASK(Code) | | The control key modifier constant.
It is recommended that CTRL_DOWN_MASK to be used instead.
|
| JDK_1_3_MODIFIERS | | final static int JDK_1_3_MODIFIERS(Code) | | |
| META_DOWN_MASK | | final public static int META_DOWN_MASK(Code) | | The META key extended modifier constant.
since:
1.4 |
| META_MASK | | final public static int META_MASK(Code) | | The meta key modifier constant.
It is recommended that META_DOWN_MASK to be used instead.
|
| SHIFT_DOWN_MASK | | final public static int SHIFT_DOWN_MASK(Code) | | The SHIFT key extended modifier constant.
since:
1.4 |
| SHIFT_MASK | | final public static int SHIFT_MASK(Code) | | The shift key modifier constant.
It is recommended that SHIFT_DOWN_MASK to be used instead.
|
| modifiers | | int modifiers(Code) | | The state of the modifier key at the time the input
event was fired.
See Also: getModifiers()
See Also: java.awt.event.MouseEvent |
| serialVersionUID | | final static long serialVersionUID(Code) | | |
| when | | long when(Code) | | The input events Time stamp. The time stamp is in
UTC format that indicates when the input event was
created.
See Also: getWhen() |
| InputEvent | | InputEvent(Component source, int id, long when, int modifiers)(Code) | | Constructs an InputEvent object with the specified source component,
modifiers, and type.
Parameters:
source - the object where the event originated |
| consume | | public void consume()(Code) | | Consumes this event so that it will not be processed
in the default manner by the source which originated it.
|
| getModifiers | | public int getModifiers()(Code) | | Returns the modifiers flag for this event.
|
| getModifiersEx | | public int getModifiersEx()(Code) | | Returns the extended modifiers flag for this event.
Extended modifiers represent state of all modal keys,
such of ALT, CTRL, META and mouse buttons just after event occured
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
via == 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.
since:
1.4 |
| getModifiersExText | | public static String getModifiersExText(int modifiers)(Code) | | Returns a String describing the extended modifier key(s), such as "Shift",
"Button1" or "Ctrl+Shift" . These strings can be localized by changing the
awt.properties file.
string a text description of the combination of extendedmodifier keys that were held down during the event
since:
1.4 |
| getWhen | | public long getWhen()(Code) | | Returns the timestamp of when this event occurred.
|
| isAltDown | | public boolean isAltDown()(Code) | | Returns whether or not the Alt modifier is down on this event.
|
| isAltGraphDown | | public boolean isAltGraphDown()(Code) | | Returns whether or not the Alt-Graph modifier is down on this event.
|
| isConsumed | | public boolean isConsumed()(Code) | | Returns whether or not this event has been consumed.
See Also: InputEvent.consume |
| isControlDown | | public boolean isControlDown()(Code) | | Returns whether or not the Control modifier is down on this event.
|
| isMetaDown | | public boolean isMetaDown()(Code) | | Returns whether or not the Meta modifier is down on this event.
|
| isShiftDown | | public boolean isShiftDown()(Code) | | Returns whether or not the Shift modifier is down on this event.
|
|
|