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

##

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

##

Event(Object, int, Object)
  Constructs an event with the specified target component, event type, and argument.
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.
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.

##

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

##

SHIFT_MASK

      public final static int SHIFT_MASK

  The shift modifier constant.

CTRL_MASK

      public final static int CTRL_MASK

  The control modifier constant.

META_MASK

      public final static int META_MASK

  The meta modifier constant.

ALT_MASK

      public final static int ALT_MASK

  The alt modifier constant.

HOME

      public final static int HOME

  The home action-key.

END

      public final static int END

  The end action-key.

PGUP

      public final static int PGUP

  The page up action-key.

PGDN

      public final static int PGDN

  The page down action-key.

UP

      public final static int UP

  The up arrow action-key.

DOWN

      public final static int DOWN

  The down arrow action-key.

LEFT

      public final static int LEFT

  The left arrow action-key.

RIGHT

      public final static int RIGHT

  The right arrow action-key.

F1

      public final static int F1

  The F1 function action-key.

F2

      public final static int F2

  The F2 function action-key.

F3

      public final static int F3

  The F3 function action-key.

F4

      public final static int F4

  The F4 function action-key.

F5

      public final static int F5

  The F5 function action-key.

F6

      public final static int F6

  The F6 function action-key.

F7

      public final static int F7

  The F7 function action-key.

F8

      public final static int F8

  The F8 function action-key.

F9

      public final static int F9

  The F9 function action-key.

F10

      public final static int F10

  The F10 function action-key.

F11

      public final static int F11

  The F11 function action-key.

F12

      public final static int F12

  The F12 function action-key.

PRINT_SCREEN

      public final static int PRINT_SCREEN

  The PrintScreen action-key.

SCROLL_LOCK

      public final static int SCROLL_LOCK

  The ScrollLock action-key.

CAPS_LOCK

      public final static int CAPS_LOCK

  The CapsLock action-key.

NUM_LOCK

      public final static int NUM_LOCK

  The NumLock action-key.

PAUSE

      public final static int PAUSE

  The Pause action-key.

INSERT

      public final static int INSERT

  The Insert key.

ENTER

      public final static int ENTER

  The Enter key.

BACK_SPACE

      public final static int BACK_SPACE

  The BackSpace key.

TAB

      public final static int TAB

  The Tab key.

ESCAPE

      public final static int ESCAPE

  The Escape key.

DELETE

      public final static int DELETE

  The Delete key.

WINDOW_DESTROY

      public final static int WINDOW_DESTROY

  The destroy window event.

WINDOW_EXPOSE

      public final static int WINDOW_EXPOSE

  The expose window event.

WINDOW_ICONIFY

      public final static int WINDOW_ICONIFY

  The iconify window event.

WINDOW_DEICONIFY

      public final static int WINDOW_DEICONIFY

  The de-iconify window event.

WINDOW_MOVED

      public final static int WINDOW_MOVED

  The move window event.

KEY_PRESS

      public final static int KEY_PRESS

  The key press keyboard event.

KEY_RELEASE

      public final static int KEY_RELEASE

  The key release keyboard event.

KEY_ACTION

      public final static int KEY_ACTION

  The action-key press keyboard event.

KEY_ACTION_RELEASE

      public final static int KEY_ACTION_RELEASE

  The action-key release keyboard event.

MOUSE_DOWN

      public final static int MOUSE_DOWN

  The mouse down event.

MOUSE_UP

      public final static int MOUSE_UP

  The mouse up event.

MOUSE_MOVE

      public final static int MOUSE_MOVE

  The mouse move event.

MOUSE_ENTER

      public final static int MOUSE_ENTER

  The mouse enter event.

MOUSE_EXIT

      public final static int MOUSE_EXIT

  The mouse exit event.

MOUSE_DRAG

      public final static int MOUSE_DRAG

  The mouse drag event.

SCROLL_LINE_UP

      public final static int SCROLL_LINE_UP

  The line up scroll event.

SCROLL_LINE_DOWN

      public final static int SCROLL_LINE_DOWN

  The line down scroll event.

SCROLL_PAGE_UP

      public final static int SCROLL_PAGE_UP

  The page up scroll event.

SCROLL_PAGE_DOWN

      public final static int SCROLL_PAGE_DOWN

  The page down scroll event.

SCROLL_ABSOLUTE

      public final static int SCROLL_ABSOLUTE

  The absolute scroll event.

SCROLL_BEGIN

      public final static int SCROLL_BEGIN

  The scroll begin event.

SCROLL_END

      public final static int SCROLL_END

  The scroll end event.

LIST_SELECT

      public final static int LIST_SELECT

LIST_DESELECT

      public final static int LIST_DESELECT

ACTION_EVENT

      public final static int ACTION_EVENT

  An action event.

LOAD_FILE

      public final static int LOAD_FILE

  A file loading event.

SAVE_FILE

      public final static int SAVE_FILE

  A file saving event.

GOT_FOCUS

      public final static int GOT_FOCUS

  A component gained the focus.

LOST_FOCUS

      public final static int LOST_FOCUS

  A component lost the focus.

target

      public Object target

  The target component.

when

      public long when

  The time stamp.

id

      public int id

  The type of this event.

x

      public int x

  The x coordinate of the event.

y

      public int y

  The y coordinate of the event.

key

      public int key

  The key code that was pressed in a keyboard event.

modifiers

      public int modifiers

  The state of the modifier keys.

clickCount

      public int clickCount

  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.

arg

      public Object arg

  An arbitrary argument.

evt

      public Event evt

  The next event. Used when putting events into a linked list.

##

Event

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

  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

Event

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

  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

Event

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

  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

##

translate

      public void translate(int x,
                            int y)

  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

shiftDown

      public boolean shiftDown()

  Checks if the shift key is down.

  See Also:
    modifiers, controlDown, metaDown

controlDown

      public boolean controlDown()

  Checks if the control key is down.

  See Also:
    modifiers, shiftDown, metaDown

metaDown

      public boolean metaDown()

  Checks if the meta key is down.

  See Also:
    modifiers, shiftDown, controlDown

paramString

      protected String paramString()

  Returns the parameter String of this Event.

toString

      public String toString()

  Returns the String representation of this Event's values.

  Overrides:
    toString in class Object

    All Packages  Class Hierarchy  This Package  Previous  Next  Index