InputEvent (Sample Document)

java.lang.Object
- java.util.EventObject
- - java.awt.AWTEvent
  - - java.awt.event.ComponentEvent
    - - java.awt.event.InputEvent

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

KeyEvent, MouseEvent

public abstract class InputEvent extends ComponentEvent

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.

Since:

1.1

See Also:
KeyEvent, KeyAdapter, MouseEvent, MouseAdapter, MouseMotionAdapter, Serialized Form

Fields
	Modifier and Type	Field and Description
	ACTION_EVENT_MASK	`static long` ACTION_EVENT_MASK The event mask for selecting action events. public static final long ACTION_EVENT_MASK The event mask for selecting action events. See Also: Constant Field Values
	ADJUSTMENT_EVENT_MASK	`static long` ADJUSTMENT_EVENT_MASK The event mask for selecting adjustment events. public static final long ADJUSTMENT_EVENT_MASK The event mask for selecting adjustment events. See Also: Constant Field Values
	ALT_DOWN_MASK	`static int` ALT_DOWN_MASK The Alt key extended modifier constant. public static final int ALT_DOWN_MASK The Alt key extended modifier constant. Since: 1.4 See Also: Constant Field Values
	ALT_GRAPH_DOWN_MASK	`static int` ALT_GRAPH_DOWN_MASK The AltGraph key extended modifier constant. public static final int ALT_GRAPH_DOWN_MASK The AltGraph key extended modifier constant. Since: 1.4 See Also: Constant Field Values
	ALT_GRAPH_MASK	`static int` ALT_GRAPH_MASK The AltGraph key modifier constant. public static final int ALT_GRAPH_MASK The AltGraph key modifier constant. See Also: Constant Field Values
	ALT_MASK	`static int` ALT_MASK The Alt key modifier constant. public static final int ALT_MASK The Alt key modifier constant. It is recommended that ALT_DOWN_MASK be used instead. See Also: Constant Field Values
	BUTTON1_DOWN_MASK	`static int` BUTTON1_DOWN_MASK The Mouse Button1 extended modifier constant. public static final int BUTTON1_DOWN_MASK The Mouse Button1 extended modifier constant. Since: 1.4 See Also: Constant Field Values
	BUTTON1_MASK	`static int` BUTTON1_MASK The Mouse Button1 modifier constant. public static final int BUTTON1_MASK The Mouse Button1 modifier constant. It is recommended that BUTTON1_DOWN_MASK be used instead. See Also: Constant Field Values
	BUTTON2_DOWN_MASK	`static int` BUTTON2_DOWN_MASK The Mouse Button2 extended modifier constant. public static final int BUTTON2_DOWN_MASK The Mouse Button2 extended modifier constant. Since: 1.4 See Also: Constant Field Values
	BUTTON2_MASK	`static int` BUTTON2_MASK The Mouse Button2 modifier constant. public static final int BUTTON2_MASK The Mouse Button2 modifier constant. It is recommended that BUTTON2_DOWN_MASK be used instead. Note that BUTTON2_MASK has the same value as ALT_MASK. See Also: Constant Field Values
	BUTTON3_DOWN_MASK	`static int` BUTTON3_DOWN_MASK The Mouse Button3 extended modifier constant. public static final int BUTTON3_DOWN_MASK The Mouse Button3 extended modifier constant. Since: 1.4 See Also: Constant Field Values
	BUTTON3_MASK	`static int` BUTTON3_MASK The Mouse Button3 modifier constant. public static final int BUTTON3_MASK The Mouse Button3 modifier constant. It is recommended that BUTTON3_DOWN_MASK be used instead. Note that BUTTON3_MASK has the same value as META_MASK. See Also: Constant Field Values
	COMPONENT_EVENT_MASK	`static long` COMPONENT_EVENT_MASK The event mask for selecting component events. public static final long COMPONENT_EVENT_MASK The event mask for selecting component events. See Also: Constant Field Values
	COMPONENT_FIRST	`static int` COMPONENT_FIRST The first number in the range of ids used for component events. public static final int COMPONENT_FIRST The first number in the range of ids used for component events. See Also: Constant Field Values
	COMPONENT_HIDDEN	`static int` COMPONENT_HIDDEN This event indicates that the component was rendered invisible. public static final int COMPONENT_HIDDEN This event indicates that the component was rendered invisible. See Also: Constant Field Values
	COMPONENT_LAST	`static int` COMPONENT_LAST The last number in the range of ids used for component events. public static final int COMPONENT_LAST The last number in the range of ids used for component events. See Also: Constant Field Values
	COMPONENT_MOVED	`static int` COMPONENT_MOVED This event indicates that the component's position changed. public static final int COMPONENT_MOVED This event indicates that the component's position changed. See Also: Constant Field Values
	COMPONENT_RESIZED	`static int` COMPONENT_RESIZED This event indicates that the component's size changed. public static final int COMPONENT_RESIZED This event indicates that the component's size changed. See Also: Constant Field Values
	COMPONENT_SHOWN	`static int` COMPONENT_SHOWN This event indicates that the component was made visible. public static final int COMPONENT_SHOWN This event indicates that the component was made visible. See Also: Constant Field Values
	consumed	`protected boolean` consumed Controls whether or not the event is sent back down to the peer once the source has processed it - false means it's sent to the peer; true means it's not. protected boolean consumed Controls whether or not the event is sent back down to the peer once the source has processed it - false means it's sent to the peer; true means it's not. Semantic events always have a 'true' value since they were generated by the peer in response to a low-level event. See Also: `AWTEvent.consume()`, `AWTEvent.isConsumed()`
	CONTAINER_EVENT_MASK	`static long` CONTAINER_EVENT_MASK The event mask for selecting container events. public static final long CONTAINER_EVENT_MASK The event mask for selecting container events. See Also: Constant Field Values
	CTRL_DOWN_MASK	`static int` CTRL_DOWN_MASK The Control key extended modifier constant. public static final int CTRL_DOWN_MASK The Control key extended modifier constant. Since: 1.4 See Also: Constant Field Values
	CTRL_MASK	`static int` CTRL_MASK The Control key modifier constant. public static final int CTRL_MASK The Control key modifier constant. It is recommended that CTRL_DOWN_MASK be used instead. See Also: Constant Field Values
	FOCUS_EVENT_MASK	`static long` FOCUS_EVENT_MASK The event mask for selecting focus events. public static final long FOCUS_EVENT_MASK The event mask for selecting focus events. See Also: Constant Field Values
	HIERARCHY_BOUNDS_EVENT_MASK	`static long` HIERARCHY_BOUNDS_EVENT_MASK The event mask for selecting hierarchy bounds events. public static final long HIERARCHY_BOUNDS_EVENT_MASK The event mask for selecting hierarchy bounds events. See Also: Constant Field Values
	HIERARCHY_EVENT_MASK	`static long` HIERARCHY_EVENT_MASK The event mask for selecting hierarchy events. public static final long HIERARCHY_EVENT_MASK The event mask for selecting hierarchy events. See Also: Constant Field Values
	id	`protected int` id The event's id. protected int id The event's id. See Also: `AWTEvent.getID()`, `AWTEvent.AWTEvent(java.lang.Object, int)`
	INPUT_METHOD_EVENT_MASK	`static long` INPUT_METHOD_EVENT_MASK The event mask for selecting input method events. public static final long INPUT_METHOD_EVENT_MASK The event mask for selecting input method events. See Also: Constant Field Values
	INVOCATION_EVENT_MASK	`static long` INVOCATION_EVENT_MASK The event mask for selecting invocation events. public static final long INVOCATION_EVENT_MASK The event mask for selecting invocation events. See Also: Constant Field Values
	ITEM_EVENT_MASK	`static long` ITEM_EVENT_MASK The event mask for selecting item events. public static final long ITEM_EVENT_MASK The event mask for selecting item events. See Also: Constant Field Values
	KEY_EVENT_MASK	`static long` KEY_EVENT_MASK The event mask for selecting key events. public static final long KEY_EVENT_MASK The event mask for selecting key events. See Also: Constant Field Values
	META_DOWN_MASK	`static int` META_DOWN_MASK The Meta key extended modifier constant. public static final int META_DOWN_MASK The Meta key extended modifier constant. Since: 1.4 See Also: Constant Field Values
	META_MASK	`static int` META_MASK The Meta key modifier constant. public static final int META_MASK The Meta key modifier constant. It is recommended that META_DOWN_MASK be used instead. See Also: Constant Field Values
	MOUSE_EVENT_MASK	`static long` MOUSE_EVENT_MASK The event mask for selecting mouse events. public static final long MOUSE_EVENT_MASK The event mask for selecting mouse events. See Also: Constant Field Values
	MOUSE_MOTION_EVENT_MASK	`static long` MOUSE_MOTION_EVENT_MASK The event mask for selecting mouse motion events. public static final long MOUSE_MOTION_EVENT_MASK The event mask for selecting mouse motion events. See Also: Constant Field Values
	MOUSE_WHEEL_EVENT_MASK	`static long` MOUSE_WHEEL_EVENT_MASK The event mask for selecting mouse wheel events. public static final long MOUSE_WHEEL_EVENT_MASK The event mask for selecting mouse wheel events. Since: 1.4 See Also: Constant Field Values
	PAINT_EVENT_MASK	`static long` PAINT_EVENT_MASK The event mask for selecting paint events. public static final long PAINT_EVENT_MASK The event mask for selecting paint events. See Also: Constant Field Values
	RESERVED_ID_MAX	`static int` RESERVED_ID_MAX The maximum value for reserved AWT event IDs. public static final int RESERVED_ID_MAX The maximum value for reserved AWT event IDs. Programs defining their own event IDs should use IDs greater than this value. See Also: Constant Field Values
	SHIFT_DOWN_MASK	`static int` SHIFT_DOWN_MASK The Shift key extended modifier constant. public static final int SHIFT_DOWN_MASK The Shift key extended modifier constant. Since: 1.4 See Also: Constant Field Values
	SHIFT_MASK	`static int` SHIFT_MASK The Shift key modifier constant. public static final int SHIFT_MASK The Shift key modifier constant. It is recommended that SHIFT_DOWN_MASK be used instead. See Also: Constant Field Values
	source	`protected java.lang.Object` source The object on which the Event initially occurred. protected transient java.lang.Object source The object on which the Event initially occurred.
	TEXT_EVENT_MASK	`static long` TEXT_EVENT_MASK The event mask for selecting text events. public static final long TEXT_EVENT_MASK The event mask for selecting text events. See Also: Constant Field Values
	WINDOW_EVENT_MASK	`static long` WINDOW_EVENT_MASK The event mask for selecting window events. public static final long WINDOW_EVENT_MASK The event mask for selecting window events. See Also: Constant Field Values
	WINDOW_FOCUS_EVENT_MASK	`static long` WINDOW_FOCUS_EVENT_MASK The event mask for selecting window focus events. public static final long WINDOW_FOCUS_EVENT_MASK The event mask for selecting window focus events. Since: 1.4 See Also: Constant Field Values
	WINDOW_STATE_EVENT_MASK	`static long` WINDOW_STATE_EVENT_MASK The event mask for selecting window state events. public static final long WINDOW_STATE_EVENT_MASK The event mask for selecting window state events. Since: 1.4 See Also: Constant Field Values

Static Methods
	Modifier and Type	Static Method and Description
	getMaskForButton	`static int` getMaskForButton(int button) A method to obtain a mask for any existing mouse button. public static int getMaskForButton(int button) A method to obtain a mask for any existing mouse button. The returned mask may be used for different purposes. Following are some of them: `mousePress(buttons)` and `mouseRelease(buttons)` as a `modifiers` parameter when creating a new `MouseEvent` instance to check `modifiersEx` of existing `MouseEvent` Parameters: `button` - is a number to represent a button starting from 1. For example, int button = InputEvent.getMaskForButton(1); will have the same meaning as int button = InputEvent.getMaskForButton(MouseEvent.BUTTON1); because `MouseEvent.BUTTON1` equals to 1. If a mouse has three enabled buttons(see `MouseInfo.getNumberOfButtons()`) then the values from the left column passed into the method will return corresponding values from the right column: button returned mask `BUTTON1` `BUTTON1_DOWN_MASK` `BUTTON2` `BUTTON2_DOWN_MASK` `BUTTON3` `BUTTON3_DOWN_MASK` If a mouse has more than three enabled buttons then more values are admissible (4, 5, etc.). There is no assigned constants for these extended buttons. The button masks for the extra buttons returned by this method have no assigned names like the first three button masks. This method has the following implementation restriction. It returns masks for a limited number of buttons only. The maximum number is implementation dependent and may vary. This limit is defined by the relevant number of buttons that may hypothetically exist on the mouse but it is greater than the `MouseInfo.getNumberOfButtons()`. Throws: `java.lang.IllegalArgumentException` - if `button` is less than zero or greater than the number of button masks reserved for buttons Since: 7.0 See Also: `MouseInfo.getNumberOfButtons()`, `Toolkit.areExtraMouseButtonsEnabled()`, `getModifiers()`, `MouseEvent.getModifiersEx()`
	getModifiersExText	`static java.lang.String` getModifiersExText(int modifiers) Returns a String describing the extended modifier keys and mouse buttons, such as "Shift", "Button1", or "Ctrl+Shift". public static java.lang.String getModifiersExText(int modifiers) Returns a String describing the extended modifier keys and mouse buttons, such as "Shift", "Button1", or "Ctrl+Shift". These strings can be localized by changing the `awt.properties` file. Note that passing negative parameter is incorrect, and will cause the returning an unspecified string. Zero parameter means that no modifiers were passed and will cause the returning an empty string. Parameters: `modifiers` - a modifier mask describing the extended modifier keys and mouse buttons for the event Returns: a text description of the combination of extended modifier keys and mouse buttons that were held down during the event. Since: 1.4

Methods
	Modifier and Type	Method and Description
	consume	`void` consume() Consumes this event so that it will not be processed in the default manner by the source which originated it. public void consume() Consumes this event so that it will not be processed in the default manner by the source which originated it. Overrides: `consume` in class `AWTEvent`
	getComponent	`Component` getComponent() Returns the originator of the event. public Component getComponent() Description copied from class: `ComponentEvent` Returns the originator of the event. Returns: the `Component` object that originated the event, or `null` if the object is not a `Component`.
	getID	`int` getID() Returns the event type. public int getID() Description copied from class: `AWTEvent` Returns the event type.
	getModifiers	`int` getModifiers() Returns the modifier mask for this event. public int getModifiers() Returns the modifier mask for this event.
	getModifiersEx	`int` getModifiersEx() Returns the extended modifier mask for this event. public int getModifiersEx() Returns the extended modifier mask for this event. Extended modifiers represent the state of all modal keys, such as ALT, CTRL, META, and the mouse buttons just after the event occurred 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. Since: 1.4
	getSource	`java.lang.Object` getSource() The object on which the Event initially occurred. public java.lang.Object getSource() Description copied from class: `java.util.EventObject` The object on which the Event initially occurred. Returns: The object on which the Event initially occurred.
	getWhen	`long` getWhen() Returns the difference in milliseconds between the timestamp of when this event occurred and midnight, January 1, 1970 UTC. public long getWhen() Returns the difference in milliseconds between the timestamp of when this event occurred and midnight, January 1, 1970 UTC.
	isAltDown	`boolean` isAltDown() Returns whether or not the Alt modifier is down on this event. public boolean isAltDown() Returns whether or not the Alt modifier is down on this event.
	isAltGraphDown	`boolean` isAltGraphDown() Returns whether or not the AltGraph modifier is down on this event. public boolean isAltGraphDown() Returns whether or not the AltGraph modifier is down on this event.
	isConsumed	`boolean` isConsumed() Returns whether or not this event has been consumed. public boolean isConsumed() Returns whether or not this event has been consumed. Overrides: `isConsumed` in class `AWTEvent` See Also: `consume()`
	isControlDown	`boolean` isControlDown() Returns whether or not the Control modifier is down on this event. public boolean isControlDown() Returns whether or not the Control modifier is down on this event.
	isMetaDown	`boolean` isMetaDown() Returns whether or not the Meta modifier is down on this event. public boolean isMetaDown() Returns whether or not the Meta modifier is down on this event.
	isShiftDown	`boolean` isShiftDown() Returns whether or not the Shift modifier is down on this event. public boolean isShiftDown() Returns whether or not the Shift modifier is down on this event.
	paramString	`java.lang.String` paramString() Returns a parameter string identifying this event. public java.lang.String paramString() Description copied from class: `ComponentEvent` Returns a parameter string identifying this event. This method is useful for event-logging and for debugging. Overrides: `paramString` in class `AWTEvent` Returns: a string identifying the event and its attributes
	setSource	`void` setSource(java.lang.Object newSource) Retargets an event to a new source. public void setSource(java.lang.Object newSource) Description copied from class: `AWTEvent` Retargets an event to a new source. This method is typically used to retarget an event to a lightweight child Component of the original heavyweight source. This method is intended to be used only by event targeting subsystems, such as client-defined KeyboardFocusManagers. It is not for general client use. Parameters: `newSource` - the new Object to which the event should be dispatched Since: 1.4
	toString	`java.lang.String` toString() Returns a String representation of this object. public java.lang.String toString() Description copied from class: `AWTEvent` Returns a String representation of this object. Overrides: `toString` in class `java.util.EventObject` Returns: A a String representation of this EventObject.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

SourceForge

Class InputEvent

Methods inherited from class java.lang.Object