public class

Event

extends Object
implements Serializable
java.lang.Object
   ↳ java.awt.Event

Class Overview

NOTE: The Event class is obsolete and is available only for backwards compatilibility. It has been replaced by the AWTEvent class and its subclasses.

Event is a platform-independent class that encapsulates events from the platform's Graphical User Interface in the Java 1.0 event model. In Java 1.1 and later versions, the Event class is maintained only for backwards compatibilty. The information in this class description is provided to assist programmers in converting Java 1.0 programs to the new event model.

In the Java 1.0 event model, an event contains an id field that indicates what type of event it is and which other Event variables are relevant for the event.

For keyboard events, key contains a value indicating which key was activated, and modifiers contains the modifiers for that event. For the KEY_PRESS and KEY_RELEASE event ids, the value of key is the unicode character code for the key. For KEY_ACTION and KEY_ACTION_RELEASE, the value of key is one of the defined action-key identifiers in the Event class (PGUP, PGDN, F1, F2, etc).

Summary

Constants
int ACTION_EVENT This event indicates that the user wants some action to occur.
int ALT_MASK This flag indicates that the Alt key was down when the event occurred.
int BACK_SPACE The BackSpace key.
int CAPS_LOCK The Caps Lock key, a non-ASCII action key.
int CTRL_MASK This flag indicates that the Control key was down when the event occurred.
int DELETE The Delete key.
int DOWN The Down Arrow key, a non-ASCII action key.
int END The End key, a non-ASCII action key.
int ENTER The Enter key.
int ESCAPE The Escape key.
int F1 The F1 function key, a non-ASCII action key.
int F10 The F10 function key, a non-ASCII action key.
int F11 The F11 function key, a non-ASCII action key.
int F12 The F12 function key, a non-ASCII action key.
int F2 The F2 function key, a non-ASCII action key.
int F3 The F3 function key, a non-ASCII action key.
int F4 The F4 function key, a non-ASCII action key.
int F5 The F5 function key, a non-ASCII action key.
int F6 The F6 function key, a non-ASCII action key.
int F7 The F7 function key, a non-ASCII action key.
int F8 The F8 function key, a non-ASCII action key.
int F9 The F9 function key, a non-ASCII action key.
int GOT_FOCUS A component gained the focus.
int HOME The Home key, a non-ASCII action key.
int INSERT The Insert key, a non-ASCII action key.
int KEY_ACTION The user has pressed a non-ASCII action key.
int KEY_ACTION_RELEASE The user has released a non-ASCII action key.
int KEY_PRESS The user has pressed a normal key.
int KEY_RELEASE The user has released a normal key.
int LEFT The Left Arrow key, a non-ASCII action key.
int LIST_DESELECT An item in a list has been deselected.
int LIST_SELECT An item in a list has been selected.
int LOAD_FILE A file loading event.
int LOST_FOCUS A component lost the focus.
int META_MASK This flag indicates that the Meta key was down when the event occurred.
int MOUSE_DOWN The user has pressed the mouse button.
int MOUSE_DRAG The user has moved the mouse with a button pressed.
int MOUSE_ENTER The mouse has entered a component.
int MOUSE_EXIT The mouse has exited a component.
int MOUSE_MOVE The mouse has moved with no button pressed.
int MOUSE_UP The user has released the mouse button.
int NUM_LOCK The Num Lock key, a non-ASCII action key.
int PAUSE The Pause key, a non-ASCII action key.
int PGDN The Page Down key, a non-ASCII action key.
int PGUP The Page Up key, a non-ASCII action key.
int PRINT_SCREEN The Print Screen key, a non-ASCII action key.
int RIGHT The Right Arrow key, a non-ASCII action key.
int SAVE_FILE A file saving event.
int SCROLL_ABSOLUTE The user has moved the bubble (thumb) in a scroll bar, moving to an "absolute" position, rather than to an offset from the last postion.
int SCROLL_BEGIN The scroll begin event.
int SCROLL_END The scroll end event.
int SCROLL_LINE_DOWN The user has activated the line down area of a scroll bar.
int SCROLL_LINE_UP The user has activated the line up area of a scroll bar.
int SCROLL_LOCK The Scroll Lock key, a non-ASCII action key.
int SCROLL_PAGE_DOWN The user has activated the page down area of a scroll bar.
int SCROLL_PAGE_UP The user has activated the page up area of a scroll bar.
int SHIFT_MASK This flag indicates that the Shift key was down when the event occurred.
int TAB The Tab key.
int UP The Up Arrow key, a non-ASCII action key.
int WINDOW_DEICONIFY The user has asked the window manager to de-iconify the window.
int WINDOW_DESTROY The user has asked the window manager to kill the window.
int WINDOW_EXPOSE The user has asked the window manager to expose the window.
int WINDOW_ICONIFY The user has asked the window manager to iconify the window.
int WINDOW_MOVED The user has asked the window manager to move the window.
Fields
public Object arg An arbitrary argument of the event.
public int clickCount For MOUSE_DOWN events, this field indicates the number of consecutive clicks.
public Event evt The next event.
public int id Indicates which type of event the event is, and which other Event variables are relevant for the event.
public int key The key code of the key that was pressed in a keyboard event.
public int modifiers The state of the modifier keys.
public Object target The target component.
public long when The time stamp.
public int x The x coordinate of the event.
public int y The y coordinate of the event.
Public Constructors
Event(Object target, long when, int id, int x, int y, int key, int modifiers, Object arg)
NOTE: The Event class is obsolete and is available only for backwards compatilibility.
Event(Object target, long when, int id, int x, int y, int key, int modifiers)
NOTE: The Event class is obsolete and is available only for backwards compatilibility.
Event(Object target, int id, Object arg)
NOTE: The Event class is obsolete and is available only for backwards compatilibility.
Public Methods
boolean controlDown()
NOTE: The Event class is obsolete and is available only for backwards compatilibility.
boolean metaDown()
NOTE: The Event class is obsolete and is available only for backwards compatilibility.
boolean shiftDown()
NOTE: The Event class is obsolete and is available only for backwards compatilibility.
String toString()
NOTE: The Event class is obsolete and is available only for backwards compatilibility.
void translate(int dx, int dy)
NOTE: The Event class is obsolete and is available only for backwards compatilibility.
Protected Methods
String paramString()
NOTE: The Event class is obsolete and is available only for backwards compatilibility.
[Expand]
Inherited Methods
From class java.lang.Object

Constants

public static final int ACTION_EVENT

This event indicates that the user wants some action to occur.

Constant Value: 1001 (0x000003e9)

public static final int ALT_MASK

This flag indicates that the Alt key was down when the event occurred. For mouse events, this flag indicates that the middle mouse button was pressed or released.

Constant Value: 8 (0x00000008)

public static final int BACK_SPACE

The BackSpace key.

Constant Value: 8 (0x00000008)

public static final int CAPS_LOCK

The Caps Lock key, a non-ASCII action key.

Constant Value: 1022 (0x000003fe)

public static final int CTRL_MASK

This flag indicates that the Control key was down when the event occurred.

Constant Value: 2 (0x00000002)

public static final int DELETE

The Delete key.

Constant Value: 127 (0x0000007f)

public static final int DOWN

The Down Arrow key, a non-ASCII action key.

Constant Value: 1005 (0x000003ed)

public static final int END

The End key, a non-ASCII action key.

Constant Value: 1001 (0x000003e9)

public static final int ENTER

The Enter key.

Constant Value: 10 (0x0000000a)

public static final int ESCAPE

The Escape key.

Constant Value: 27 (0x0000001b)

public static final int F1

The F1 function key, a non-ASCII action key.

Constant Value: 1008 (0x000003f0)

public static final int F10

The F10 function key, a non-ASCII action key.

Constant Value: 1017 (0x000003f9)

public static final int F11

The F11 function key, a non-ASCII action key.

Constant Value: 1018 (0x000003fa)

public static final int F12

The F12 function key, a non-ASCII action key.

Constant Value: 1019 (0x000003fb)

public static final int F2

The F2 function key, a non-ASCII action key.

Constant Value: 1009 (0x000003f1)

public static final int F3

The F3 function key, a non-ASCII action key.

Constant Value: 1010 (0x000003f2)

public static final int F4

The F4 function key, a non-ASCII action key.

Constant Value: 1011 (0x000003f3)

public static final int F5

The F5 function key, a non-ASCII action key.

Constant Value: 1012 (0x000003f4)

public static final int F6

The F6 function key, a non-ASCII action key.

Constant Value: 1013 (0x000003f5)

public static final int F7

The F7 function key, a non-ASCII action key.

Constant Value: 1014 (0x000003f6)

public static final int F8

The F8 function key, a non-ASCII action key.

Constant Value: 1015 (0x000003f7)

public static final int F9

The F9 function key, a non-ASCII action key.

Constant Value: 1016 (0x000003f8)

public static final int GOT_FOCUS

A component gained the focus.

Constant Value: 1004 (0x000003ec)

public static final int HOME

The Home key, a non-ASCII action key.

Constant Value: 1000 (0x000003e8)

public static final int INSERT

The Insert key, a non-ASCII action key.

Constant Value: 1025 (0x00000401)

public static final int KEY_ACTION

The user has pressed a non-ASCII action key. The key field contains a value that indicates that the event occurred on one of the action keys, which comprise the 12 function keys, the arrow (cursor) keys, Page Up, Page Down, Home, End, Print Screen, Scroll Lock, Caps Lock, Num Lock, Pause, and Insert.

Constant Value: 403 (0x00000193)

public static final int KEY_ACTION_RELEASE

The user has released a non-ASCII action key. The key field contains a value that indicates that the event occurred on one of the action keys, which comprise the 12 function keys, the arrow (cursor) keys, Page Up, Page Down, Home, End, Print Screen, Scroll Lock, Caps Lock, Num Lock, Pause, and Insert.

Constant Value: 404 (0x00000194)

public static final int KEY_PRESS

The user has pressed a normal key.

Constant Value: 401 (0x00000191)

public static final int KEY_RELEASE

The user has released a normal key.

Constant Value: 402 (0x00000192)

public static final int LEFT

The Left Arrow key, a non-ASCII action key.

Constant Value: 1006 (0x000003ee)

public static final int LIST_DESELECT

An item in a list has been deselected.

Constant Value: 702 (0x000002be)

public static final int LIST_SELECT

An item in a list has been selected.

Constant Value: 701 (0x000002bd)

public static final int LOAD_FILE

A file loading event.

Constant Value: 1002 (0x000003ea)

public static final int LOST_FOCUS

A component lost the focus.

Constant Value: 1005 (0x000003ed)

public static final int META_MASK

This flag indicates that the Meta key was down when the event occurred. For mouse events, this flag indicates that the right button was pressed or released.

Constant Value: 4 (0x00000004)

public static final int MOUSE_DOWN

The user has pressed the mouse button. The ALT_MASK flag indicates that the middle button has been pressed. The META_MASKflag indicates that the right button has been pressed.

See Also
Constant Value: 501 (0x000001f5)

public static final int MOUSE_DRAG

The user has moved the mouse with a button pressed. The ALT_MASK flag indicates that the middle button is being pressed. The META_MASK flag indicates that the right button is being pressed.

See Also
Constant Value: 506 (0x000001fa)

public static final int MOUSE_ENTER

The mouse has entered a component.

Constant Value: 504 (0x000001f8)

public static final int MOUSE_EXIT

The mouse has exited a component.

Constant Value: 505 (0x000001f9)

public static final int MOUSE_MOVE

The mouse has moved with no button pressed.

Constant Value: 503 (0x000001f7)

public static final int MOUSE_UP

The user has released the mouse button. The ALT_MASK flag indicates that the middle button has been released. The META_MASKflag indicates that the right button has been released.

See Also
Constant Value: 502 (0x000001f6)

public static final int NUM_LOCK

The Num Lock key, a non-ASCII action key.

Constant Value: 1023 (0x000003ff)

public static final int PAUSE

The Pause key, a non-ASCII action key.

Constant Value: 1024 (0x00000400)

public static final int PGDN

The Page Down key, a non-ASCII action key.

Constant Value: 1003 (0x000003eb)

public static final int PGUP

The Page Up key, a non-ASCII action key.

Constant Value: 1002 (0x000003ea)

public static final int PRINT_SCREEN

The Print Screen key, a non-ASCII action key.

Constant Value: 1020 (0x000003fc)

public static final int RIGHT

The Right Arrow key, a non-ASCII action key.

Constant Value: 1007 (0x000003ef)

public static final int SAVE_FILE

A file saving event.

Constant Value: 1003 (0x000003eb)

public static final int SCROLL_ABSOLUTE

The user has moved the bubble (thumb) in a scroll bar, moving to an "absolute" position, rather than to an offset from the last postion.

Constant Value: 605 (0x0000025d)

public static final int SCROLL_BEGIN

The scroll begin event.

Constant Value: 606 (0x0000025e)

public static final int SCROLL_END

The scroll end event.

Constant Value: 607 (0x0000025f)

public static final int SCROLL_LINE_DOWN

The user has activated the line down area of a scroll bar.

Constant Value: 602 (0x0000025a)

public static final int SCROLL_LINE_UP

The user has activated the line up area of a scroll bar.

Constant Value: 601 (0x00000259)

public static final int SCROLL_LOCK

The Scroll Lock key, a non-ASCII action key.

Constant Value: 1021 (0x000003fd)

public static final int SCROLL_PAGE_DOWN

The user has activated the page down area of a scroll bar.

Constant Value: 604 (0x0000025c)

public static final int SCROLL_PAGE_UP

The user has activated the page up area of a scroll bar.

Constant Value: 603 (0x0000025b)

public static final int SHIFT_MASK

This flag indicates that the Shift key was down when the event occurred.

Constant Value: 1 (0x00000001)

public static final int TAB

The Tab key.

Constant Value: 9 (0x00000009)

public static final int UP

The Up Arrow key, a non-ASCII action key.

Constant Value: 1004 (0x000003ec)

public static final int WINDOW_DEICONIFY

The user has asked the window manager to de-iconify the window.

Constant Value: 204 (0x000000cc)

public static final int WINDOW_DESTROY

The user has asked the window manager to kill the window.

Constant Value: 201 (0x000000c9)

public static final int WINDOW_EXPOSE

The user has asked the window manager to expose the window.

Constant Value: 202 (0x000000ca)

public static final int WINDOW_ICONIFY

The user has asked the window manager to iconify the window.

Constant Value: 203 (0x000000cb)

public static final int WINDOW_MOVED

The user has asked the window manager to move the window.

Constant Value: 205 (0x000000cd)

Fields

public Object arg

An arbitrary argument of the event. The value of this field depends on the type of event. arg has been replaced by event specific property.

public int clickCount

For MOUSE_DOWN events, this field indicates the number of consecutive clicks. For other events, its value is 0. This field has been replaced by MouseEvent.getClickCount().@serial

See Also

public Event evt

The next event. This field is set when putting events into a linked list. This has been replaced by EventQueue.@serial

See Also

public int id

Indicates which type of event the event is, and which other Event variables are relevant for the event. This has been replaced by AWTEvent.getID()@serial

See Also

public int key

The key code of the key that was pressed in a keyboard event. This has been replaced by KeyEvent.getKeyCode()@serial

See Also

public int modifiers

The state of the modifier keys. This is replaced with InputEvent.getModifiers() In java 1.1 MouseEvent and KeyEvent are subclasses of InputEvent.@serial

See Also

public Object target

The target component. This indicates the component over which the event occurred or with which the event is associated. This object has been replaced by AWTEvent.getSource()@serial

See Also

public long when

The time stamp. Replaced by InputEvent.getWhen().@serial

See Also

public int x

The x coordinate of the event. Replaced by MouseEvent.getX()@serial

See Also

public int y

The y coordinate of the event. Replaced by MouseEvent.getY()@serial

See Also

Public Constructors

public Event (Object target, long when, int id, int x, int y, int key, int modifiers, Object arg)

NOTE: The Event class is obsolete and is available only for backwards compatilibility. It has been replaced by the AWTEvent class and its subclasses.

Creates an instance of Event with the specified target component, time stamp, event type, x and y coordinates, keyboard key, state of the modifier keys, and argument.

Parameters
target the target component.
when the time stamp.
id the event type.
x the x coordinate.
y the y coordinate.
key the key pressed in a keyboard event.
modifiers the state of the modifier keys.
arg the specified argument.

public Event (Object target, long when, int id, int x, int y, int key, int modifiers)

NOTE: The Event class is obsolete and is available only for backwards compatilibility. It has been replaced by the AWTEvent class and its subclasses.

Creates an instance of Event, with the specified target component, time stamp, event type, x and y coordinates, keyboard key, state of the modifier keys, and an argument set to null.

Parameters
target the target component.
when the time stamp.
id the event type.
x the x coordinate.
y the y coordinate.
key the key pressed in a keyboard event.
modifiers the state of the modifier keys.

public Event (Object target, int id, Object arg)

NOTE: The Event class is obsolete and is available only for backwards compatilibility. It has been replaced by the AWTEvent class and its subclasses.

Creates an instance of Event with the specified target component, event type, and argument.

Parameters
target the target component.
id the event type.
arg the specified argument.

Public Methods

public boolean controlDown ()

NOTE: The Event class is obsolete and is available only for backwards compatilibility. It has been replaced by the AWTEvent class and its subclasses.

Checks if the Control key is down.

Returns
  • true if the key is down; false otherwise.
See Also

public boolean metaDown ()

NOTE: The Event class is obsolete and is available only for backwards compatilibility. It has been replaced by the AWTEvent class and its subclasses.

Checks if the Meta key is down.

Returns
  • true if the key is down; false otherwise.
See Also

public boolean shiftDown ()

NOTE: The Event class is obsolete and is available only for backwards compatilibility. It has been replaced by the AWTEvent class and its subclasses.

Checks if the Shift key is down.

Returns
  • true if the key is down; false otherwise.
See Also

public String toString ()

NOTE: The Event class is obsolete and is available only for backwards compatilibility. It has been replaced by the AWTEvent class and its subclasses.

Returns a representation of this event's values as a string.

Returns
  • a string that represents the event and the values of its member fields.
See Also

public void translate (int dx, int dy)

NOTE: The Event class is obsolete and is available only for backwards compatilibility. It has been replaced by the AWTEvent class and its subclasses.

Translates this event so that its x and y coordinates are increased by dx and dy, respectively.

This method translates an event relative to the given component. This involves, at a minimum, translating the coordinates into the local coordinate system of the given component. It may also involve translating a region in the case of an expose event.

Parameters
dx the distance to translate the x coordinate.
dy the distance to translate the y coordinate.

Protected Methods

protected String paramString ()

NOTE: The Event class is obsolete and is available only for backwards compatilibility. It has been replaced by the AWTEvent class and its subclasses.

Returns a string representing the state of this Event. This method is intended to be used only for debugging purposes, and the content and format of the returned string may vary between implementations. The returned string may be empty but may not be null.

Returns
  • the parameter string of this event