Event JDK 1.6)

Description

public class Event

NOTE: The Event class is obsolete and is available only for backwards compatilibility.

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 Event.id field that indicates what type of event it is and which other Event variables are relevant for the event.

For keyboard events, Event.key contains a value indicating which key was activated, and Event.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).

See also:

Constructors

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

NOTE: The Event class is obsolete and is available only for backwards compatilibility.

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 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.

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, 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.

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.

Methods

Hide/Show inherited methods

pack-private void consume ()

NOTE: The Event class is obsolete and is available only for backwards compatilibility.

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

public boolean controlDown ()

NOTE: The Event class is obsolete and is available only for backwards compatilibility.

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: Event.modifiers, Event.shiftDown(), Event.metaDown(),

pack-private char getKeyEventChar ()

pack-privatestatic int getOldEventKey (KeyEvent e)

pack-private boolean isConsumed ()

NOTE: The Event class is obsolete and is available only for backwards compatilibility.

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

public boolean metaDown ()

NOTE: The Event class is obsolete and is available only for backwards compatilibility.

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: Event.modifiers, Event.shiftDown(), Event.controlDown(),

protected String paramString ()

NOTE: The Event class is obsolete and is available only for backwards compatilibility.

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

public boolean shiftDown ()

NOTE: The Event class is obsolete and is available only for backwards compatilibility.

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: Event.modifiers, Event.controlDown(), Event.metaDown(),

public String toString ()

NOTE: The Event class is obsolete and is available only for backwards compatilibility.

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.
Since: JDK1.1
See Also: Event.paramString(),

public void translate (int dx, int dy)

NOTE: The Event class is obsolete and is available only for backwards compatilibility.

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.

Fields

Hide/Show inherited fields

publicfinalstatic int ACTION_EVENT = "1001"

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

publicfinalstatic int ALT_MASK = "8"

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

public Object arg

An arbitrary argument of the event.

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.
Serial:

publicfinalstatic int BACK_SPACE = "8"

The BackSpace key.

publicfinalstatic int CAPS_LOCK = "1022"

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

public int clickCount

For MOUSE_DOWN events, this field indicates the number of consecutive clicks.

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: MouseEvent.getClickCount().,

publicfinalstatic int CTRL_MASK = "2"

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

publicfinalstatic int DELETE = "127"

The Delete key.

publicfinalstatic int DOWN = "1005"

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

publicfinalstatic int END = "1001"

The End key, a non-ASCII action key.

publicfinalstatic int ENTER = "10"

The Enter key.

publicfinalstatic int ESCAPE = "27"

The Escape key.

public Event evt

The next event.

publicfinalstatic int F1 = "1008"

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

publicfinalstatic int F10 = "1017"

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

publicfinalstatic int F11 = "1018"

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

publicfinalstatic int F12 = "1019"

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

publicfinalstatic int F2 = "1009"

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

publicfinalstatic int F3 = "1010"

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

publicfinalstatic int F4 = "1011"

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

publicfinalstatic int F5 = "1012"

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

publicfinalstatic int F6 = "1013"

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

publicfinalstatic int F7 = "1014"

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

publicfinalstatic int F8 = "1015"

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

publicfinalstatic int F9 = "1016"

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

publicfinalstatic int GOT_FOCUS = "1004"

A component gained the focus.

publicfinalstatic int HOME = "1000"

The Home key, a non-ASCII action key.

public int id

Indicates which type of event the event is, and which other Event variables are relevant for the event.

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: AWTEvent.getID(),

publicfinalstatic int INSERT = "1025"

The Insert key, a non-ASCII action key.

public int key

The key code of the key that was pressed in a keyboard event.

publicfinalstatic int KEY_ACTION = "403"

The user has pressed a non-ASCII action key.

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.

publicfinalstatic int KEY_ACTION_RELEASE = "404"

The user has released a non-ASCII action key.

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.

publicfinalstatic int KEY_PRESS = "401"

The user has pressed a normal key.

publicfinalstatic int KEY_RELEASE = "402"

The user has released a normal key.

publicfinalstatic int LEFT = "1006"

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

publicfinalstatic int LIST_DESELECT = "702"

An item in a list has been deselected.

publicfinalstatic int LIST_SELECT = "701"

An item in a list has been selected.

publicfinalstatic int LOAD_FILE = "1002"

A file loading event.

publicfinalstatic int LOST_FOCUS = "1005"

A component lost the focus.

publicfinalstatic int META_MASK = "4"

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

public int modifiers

The state of the modifier keys.

publicfinalstatic int MOUSE_DOWN = "501"

The user has pressed the mouse button.

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: Event.ALT_MASK, Event.META_MASK,

publicfinalstatic int MOUSE_DRAG = "506"

The user has moved the mouse with a button pressed.

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: Event.ALT_MASK, Event.META_MASK,

publicfinalstatic int MOUSE_ENTER = "504"

The mouse has entered a component.

publicfinalstatic int MOUSE_EXIT = "505"

The mouse has exited a component.

publicfinalstatic int MOUSE_MOVE = "503"

The mouse has moved with no button pressed.

publicfinalstatic int MOUSE_UP = "502"

The user has released the mouse button.

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: Event.ALT_MASK, Event.META_MASK,

publicfinalstatic int NUM_LOCK = "1023"

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

publicfinalstatic int PAUSE = "1024"

The Pause key, a non-ASCII action key.

publicfinalstatic int PGDN = "1003"

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

publicfinalstatic int PGUP = "1002"

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

publicfinalstatic int PRINT_SCREEN = "1020"

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

publicfinalstatic int RIGHT = "1007"

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

publicfinalstatic int SAVE_FILE = "1003"

A file saving event.

publicfinalstatic int SCROLL_ABSOLUTE = "605"

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.

publicfinalstatic int SCROLL_BEGIN = "606"

The scroll begin event.

publicfinalstatic int SCROLL_END = "607"

The scroll end event.

publicfinalstatic int SCROLL_LINE_DOWN = "602"

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

publicfinalstatic int SCROLL_LINE_UP = "601"

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

publicfinalstatic int SCROLL_LOCK = "1021"

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

publicfinalstatic int SCROLL_PAGE_DOWN = "604"

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

publicfinalstatic int SCROLL_PAGE_UP = "603"

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

publicfinalstatic int SHIFT_MASK = "1"

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

publicfinalstatic int TAB = "9"

The Tab key.

public Object target

The target component.

publicfinalstatic int UP = "1004"

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

public long when

The time stamp.

publicfinalstatic int WINDOW_DEICONIFY = "204"

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

publicfinalstatic int WINDOW_DESTROY = "201"

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

publicfinalstatic int WINDOW_EXPOSE = "202"

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

publicfinalstatic int WINDOW_ICONIFY = "203"

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

publicfinalstatic int WINDOW_MOVED = "205"

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

public int x

The x coordinate of the event.

public int y

The y coordinate of the event.