All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class java.awt.Event

java.lang.Object
   |
   +----java.awt.Event

public class Event
extends Object
implements Serializable
Event is a platform-independent class that encapsulates events from the local Graphical User Interface(GUI) platform.

The event contains an id which indicates the type of event it is and which other Event variables are relavent for the event. For keyboard events, key will contain a value indicating the key that was activated and modifiers will contain the modifiers. For KEY_PRESS and KEY_RELEASE event ids, the value of key will be the unicode character code for the key; for KEY_ACTION and KEY_ACTION_RELEASE, the value of key will be one of the defined action-key identifiers in the Event class (PGUP, PGDN, F1, F2, etc).


Variable Index

 o ACTION_EVENT
An action event.
 o ALT_MASK
The alt modifier constant.
 o arg
An arbitrary argument.
 o BACK_SPACE
The BackSpace key.
 o CAPS_LOCK
The CapsLock action-key.
 o clickCount
The number of consecutive clicks.
 o CTRL_MASK
The control modifier constant.
 o DELETE
The Delete key.
 o DOWN
The down arrow action-key.
 o END
The end action-key.
 o ENTER
The Enter key.
 o ESCAPE
The Escape key.
 o evt
The next event.
 o F1
The F1 function action-key.
 o F10
The F10 function action-key.
 o F11
The F11 function action-key.
 o F12
The F12 function action-key.
 o F2
The F2 function action-key.
 o F3
The F3 function action-key.
 o F4
The F4 function action-key.
 o F5
The F5 function action-key.
 o F6
The F6 function action-key.
 o F7
The F7 function action-key.
 o F8
The F8 function action-key.
 o F9
The F9 function action-key.
 o GOT_FOCUS
A component gained the focus.
 o HOME
The home action-key.
 o id
The type of this event.
 o INSERT
The Insert key.
 o key
The key code that was pressed in a keyboard event.
 o KEY_ACTION
The action-key press keyboard event.
 o KEY_ACTION_RELEASE
The action-key release keyboard event.
 o KEY_PRESS
The key press keyboard event.
 o KEY_RELEASE
The key release keyboard event.
 o LEFT
The left arrow action-key.
 o LIST_DESELECT
 o LIST_SELECT
 o LOAD_FILE
A file loading event.
 o LOST_FOCUS
A component lost the focus.
 o META_MASK
The meta modifier constant.
 o modifiers
The state of the modifier keys.
 o MOUSE_DOWN
The mouse down event.
 o MOUSE_DRAG
The mouse drag event.
 o MOUSE_ENTER
The mouse enter event.
 o MOUSE_EXIT
The mouse exit event.
 o MOUSE_MOVE
The mouse move event.
 o MOUSE_UP
The mouse up event.
 o NUM_LOCK
The NumLock action-key.
 o PAUSE
The Pause action-key.
 o PGDN
The page down action-key.
 o PGUP
The page up action-key.
 o PRINT_SCREEN
The PrintScreen action-key.
 o RIGHT
The right arrow action-key.
 o SAVE_FILE
A file saving event.
 o SCROLL_ABSOLUTE
The absolute scroll event.
 o SCROLL_BEGIN
The scroll begin event.
 o SCROLL_END
The scroll end event.
 o SCROLL_LINE_DOWN
The line down scroll event.
 o SCROLL_LINE_UP
The line up scroll event.
 o SCROLL_LOCK
The ScrollLock action-key.
 o SCROLL_PAGE_DOWN
The page down scroll event.
 o SCROLL_PAGE_UP
The page up scroll event.
 o SHIFT_MASK
The shift modifier constant.
 o TAB
The Tab key.
 o target
The target component.
 o UP
The up arrow action-key.
 o when
The time stamp.
 o WINDOW_DEICONIFY
The de-iconify window event.
 o WINDOW_DESTROY
The destroy window event.
 o WINDOW_EXPOSE
The expose window event.
 o WINDOW_ICONIFY
The iconify window event.
 o WINDOW_MOVED
The move window event.
 o x
The x coordinate of the event.
 o y
The y coordinate of the event.

Constructor Index

 o Event(Object, int, Object)
Constructs an event with the specified target component, event type, and argument.
 o Event(Object, long, int, int, int, int, int)
Constructs an 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.
 o Event(Object, long, int, int, int, int, int, Object)
Constructs an event with the specified target component, time stamp, event type, x and y coordinates, keyboard key, state of the modifier keys and argument.

Method Index

 o controlDown()
Checks if the control key is down.
 o metaDown()
Checks if the meta key is down.
 o paramString()
Returns the parameter String of this Event.
 o shiftDown()
Checks if the shift key is down.
 o toString()
Returns the String representation of this Event's values.
 o translate(int, int)
Translates an event relative to the given component.

Variables

 o SHIFT_MASK
Properties Public Constant 
   SHIFT_MASK=int 
The shift modifier constant.

 o CTRL_MASK
Properties Public Constant 
   CTRL_MASK=int 
The control modifier constant.

 o META_MASK
Properties Public Constant 
   META_MASK=int 
The meta modifier constant.

 o ALT_MASK
Properties Public Constant 
   ALT_MASK=int 
The alt modifier constant.

 o HOME
Properties Public Constant 
   HOME=int 
The home action-key.

 o END
Properties Public Constant 
   END=int 
The end action-key.

 o PGUP
Properties Public Constant 
   PGUP=int 
The page up action-key.

 o PGDN
Properties Public Constant 
   PGDN=int 
The page down action-key.

 o UP
Properties Public Constant 
   UP=int 
The up arrow action-key.

 o DOWN
Properties Public Constant 
   DOWN=int 
The down arrow action-key.

 o LEFT
Properties Public Constant 
   LEFT=int 
The left arrow action-key.

 o RIGHT
Properties Public Constant 
   RIGHT=int 
The right arrow action-key.

 o F1
Properties Public Constant 
   F1=int 
The F1 function action-key.

 o F2
Properties Public Constant 
   F2=int 
The F2 function action-key.

 o F3
Properties Public Constant 
   F3=int 
The F3 function action-key.

 o F4
Properties Public Constant 
   F4=int 
The F4 function action-key.

 o F5
Properties Public Constant 
   F5=int 
The F5 function action-key.

 o F6
Properties Public Constant 
   F6=int 
The F6 function action-key.

 o F7
Properties Public Constant 
   F7=int 
The F7 function action-key.

 o F8
Properties Public Constant 
   F8=int 
The F8 function action-key.

 o F9
Properties Public Constant 
   F9=int 
The F9 function action-key.

 o F10
Properties Public Constant 
   F10=int 
The F10 function action-key.

 o F11
Properties Public Constant 
   F11=int 
The F11 function action-key.

 o F12
Properties Public Constant 
   F12=int 
The F12 function action-key.

 o PRINT_SCREEN
Properties Public Constant 
   PRINT_SCREEN=int 
The PrintScreen action-key.

 o SCROLL_LOCK
Properties Public Constant 
   SCROLL_LOCK=int 
The ScrollLock action-key.

 o CAPS_LOCK
Properties Public Constant 
   CAPS_LOCK=int 
The CapsLock action-key.

 o NUM_LOCK
Properties Public Constant 
   NUM_LOCK=int 
The NumLock action-key.

 o PAUSE
Properties Public Constant 
   PAUSE=int 
The Pause action-key.

 o INSERT
Properties Public Constant 
   INSERT=int 
The Insert key.

 o ENTER
Properties Public Constant 
   ENTER=int 
The Enter key.

 o BACK_SPACE
Properties Public Constant 
   BACK_SPACE=int 
The BackSpace key.

 o TAB
Properties Public Constant 
   TAB=int 
The Tab key.

 o ESCAPE
Properties Public Constant 
   ESCAPE=int 
The Escape key.

 o DELETE
Properties Public Constant 
   DELETE=int 
The Delete key.

 o WINDOW_DESTROY
Properties Public Constant 
   WINDOW_DESTROY=int 
The destroy window event.

 o WINDOW_EXPOSE
Properties Public Constant 
   WINDOW_EXPOSE=int 
The expose window event.

 o WINDOW_ICONIFY
Properties Public Constant 
   WINDOW_ICONIFY=int 
The iconify window event.

 o WINDOW_DEICONIFY
Properties Public Constant 
   WINDOW_DEICONIFY=int 
The de-iconify window event.

 o WINDOW_MOVED
Properties Public Constant 
   WINDOW_MOVED=int 
The move window event.

 o KEY_PRESS
Properties Public Constant 
   KEY_PRESS=int 
The key press keyboard event.

 o KEY_RELEASE
Properties Public Constant 
   KEY_RELEASE=int 
The key release keyboard event.

 o KEY_ACTION
Properties Public Constant 
   KEY_ACTION=int 
The action-key press keyboard event.

 o KEY_ACTION_RELEASE
Properties Public Constant 
   KEY_ACTION_RELEASE=int 
The action-key release keyboard event.

 o MOUSE_DOWN
Properties Public Constant 
   MOUSE_DOWN=int 
The mouse down event.

 o MOUSE_UP
Properties Public Constant 
   MOUSE_UP=int 
The mouse up event.

 o MOUSE_MOVE
Properties Public Constant 
   MOUSE_MOVE=int 
The mouse move event.

 o MOUSE_ENTER
Properties Public Constant 
   MOUSE_ENTER=int 
The mouse enter event.

 o MOUSE_EXIT
Properties Public Constant 
   MOUSE_EXIT=int 
The mouse exit event.

 o MOUSE_DRAG
Properties Public Constant 
   MOUSE_DRAG=int 
The mouse drag event.

 o SCROLL_LINE_UP
Properties Public Constant 
   SCROLL_LINE_UP=int 
The line up scroll event.

 o SCROLL_LINE_DOWN
Properties Public Constant 
   SCROLL_LINE_DOWN=int 
The line down scroll event.

 o SCROLL_PAGE_UP
Properties Public Constant 
   SCROLL_PAGE_UP=int 
The page up scroll event.

 o SCROLL_PAGE_DOWN
Properties Public Constant 
   SCROLL_PAGE_DOWN=int 
The page down scroll event.

 o SCROLL_ABSOLUTE
Properties Public Constant 
   SCROLL_ABSOLUTE=int 
The absolute scroll event.

 o SCROLL_BEGIN
Properties Public Constant 
   SCROLL_BEGIN=int 
The scroll begin event.

 o SCROLL_END
Properties Public Constant 
   SCROLL_END=int 
The scroll end event.

 o LIST_SELECT
Properties Public Constant 
   LIST_SELECT=int 
 o LIST_DESELECT
Properties Public Constant 
   LIST_DESELECT=int 
 o ACTION_EVENT
Properties Public Constant 
   ACTION_EVENT=int 
An action event.

 o LOAD_FILE
Properties Public Constant 
   LOAD_FILE=int 
A file loading event.

 o SAVE_FILE
Properties Public Constant 
   SAVE_FILE=int 
A file saving event.

 o GOT_FOCUS
Properties Public Constant 
   GOT_FOCUS=int 
A component gained the focus.

 o LOST_FOCUS
Properties Public Constant 
   LOST_FOCUS=int 
A component lost the focus.

 o target
Properties Public 
    target=Object 
The target component.

 o when
Properties Public 
   when=long 
The time stamp.

 o id
Properties Public 
   id=int 
The type of this event.

 o x
Properties Public 
   x=int 
The x coordinate of the event.

 o y
Properties Public 
   y=int 
The y coordinate of the event.

 o key
Properties Public 
   key=int 
The key code that was pressed in a keyboard event.

 o modifiers
Properties Public 
   modifiers=int 
The state of the modifier keys.

 o clickCount
Properties Public 
   clickCount=int 
The number of consecutive clicks. This field is relevant only for MOUSE_DOWN events. If the field isn't set it will be 0. Otherwise, it will be 1 for single-clicks, 2 for double-clicks, and so on.

 o arg
Properties Public 
    arg=Object 
An arbitrary argument.

 o evt
Properties Public 
    evt=Event 
The next event. Used when putting events into a linked list.

Constructors

 o Event
    method Event(target=Object, -
                 when=long, -
                 id=int, -
                 x=int, -
                 y=int, -
                 key=int, -
                 modifiers=int, -
                 arg=Object) public 
Constructs an 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
 o Event
    method Event(target=Object, -
                 when=long, -
                 id=int, -
                 x=int, -
                 y=int, -
                 key=int, -
                 modifiers=int) public 
Constructs an 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
 o Event
    method Event(target=Object, -
                 id=int, -
                 arg=Object) public 
Constructs an event with the specified target component, event type, and argument.

Parameters:
target - the target component
id - the event type
arg - the specified argument

Methods

 o translate
    method translate(x=int, -
                     y=int)  public     
Translates an event relative to the given component. This involves at a minimum translating the coordinates so they make sense within the given component. It may also involve translating a region in the case of an expose event.

Parameters:
x - the x coordinate
y - the y coordinate
 o shiftDown
    method shiftDown() returns boolean public     
Checks if the shift key is down.

See Also:
modifiers, controlDown, metaDown
 o controlDown
    method controlDown() returns boolean public     
Checks if the control key is down.

See Also:
modifiers, shiftDown, metaDown
 o metaDown
    method metaDown() returns boolean public     
Checks if the meta key is down.

See Also:
modifiers, shiftDown, controlDown
 o paramString
    method paramString() returns String Inheritable     
Returns the parameter String of this Event.

 o toString
    method toString() returns String public     
Returns the String representation of this Event's values.

Overrides:
toString in class Object

All Packages  Class Hierarchy  This Package  Previous  Next  Index