org.apache.batik.gvt.event
Class GraphicsNodeKeyEvent

java.lang.Object
  extended by java.util.EventObject
      extended by org.apache.batik.gvt.event.GraphicsNodeEvent
          extended by org.apache.batik.gvt.event.GraphicsNodeInputEvent
              extended by org.apache.batik.gvt.event.GraphicsNodeKeyEvent
All Implemented Interfaces:
Serializable

public class GraphicsNodeKeyEvent
extends GraphicsNodeInputEvent

An event which indicates that a keystroke occurred in a graphics node.

See Also:
Serialized Form

Field Summary
static int KEY_PRESSED
          The "key pressed" event.
static int KEY_RELEASED
          The "key released" event.
static int KEY_TYPED
          The "key typed" event.
protected  char keyChar
          keyChar is a valid unicode character that is fired by a key or a key combination on a keyboard.
protected  int keyCode
          The unique value assigned to each of the keys on the keyboard.
protected  int keyLocation
          The key location.
 
Fields inherited from class org.apache.batik.gvt.event.GraphicsNodeInputEvent
ALT_GRAPH_MASK, ALT_MASK, BUTTON1_MASK, BUTTON2_MASK, BUTTON3_MASK, CAPS_LOCK_MASK, CTRL_MASK, KANA_LOCK_MASK, META_MASK, NUM_LOCK_MASK, SCROLL_LOCK_MASK, SHIFT_MASK
 
Fields inherited from class org.apache.batik.gvt.event.GraphicsNodeEvent
id
 
Fields inherited from class java.util.EventObject
source
 
Constructor Summary
GraphicsNodeKeyEvent(GraphicsNode source, int id, long when, int modifiers, int lockState, int keyCode, char keyChar, int keyLocation)
          Constructs a new graphics node key event.
 
Method Summary
 char getKeyChar()
          Return a character corresponding to physical key pressed.
 int getKeyCode()
          Return the integer code for the physical key pressed.
 int getKeyLocation()
          Returns the key location.
 
Methods inherited from class org.apache.batik.gvt.event.GraphicsNodeInputEvent
getLockState, getModifiers, getWhen, isAltDown, isAltGraphDown, isControlDown, isMetaDown, isShiftDown
 
Methods inherited from class org.apache.batik.gvt.event.GraphicsNodeEvent
consume, getGraphicsNode, getID, isConsumed
 
Methods inherited from class java.util.EventObject
getSource, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

KEY_TYPED

public static final int KEY_TYPED
The "key typed" event. This event is generated when a character is entered. In the simplest case, it is produced by a single key press. Often, however, characters are produced by series of key presses, and the mapping from key pressed events to key typed events may be many-to-one or many-to-many.

See Also:
Constant Field Values

KEY_PRESSED

public static final int KEY_PRESSED
The "key pressed" event. This event is generated when a key is pushed down.

See Also:
Constant Field Values

KEY_RELEASED

public static final int KEY_RELEASED
The "key released" event. This event is generated when a key is let up.

See Also:
Constant Field Values

keyCode

protected int keyCode
The unique value assigned to each of the keys on the keyboard. There is a common set of key codes that can be fired by most keyboards. The symbolic name for a key code should be used rather than the code value itself.


keyChar

protected char keyChar
keyChar is a valid unicode character that is fired by a key or a key combination on a keyboard.


keyLocation

protected int keyLocation
The key location.

Constructor Detail

GraphicsNodeKeyEvent

public GraphicsNodeKeyEvent(GraphicsNode source,
                            int id,
                            long when,
                            int modifiers,
                            int lockState,
                            int keyCode,
                            char keyChar,
                            int keyLocation)
Constructs a new graphics node key event.

Parameters:
source - the graphics node where the event originated
id - the id of this event
when - the time the event occurred
modifiers - the modifier keys down while event occurred
lockState - bitmask indicating which key locks were activated
keyCode - the Java key code
keyChar - the generated character
keyLocation - the location of the key
Method Detail

getKeyCode

public int getKeyCode()
Return the integer code for the physical key pressed. Not localized.


getKeyChar

public char getKeyChar()
Return a character corresponding to physical key pressed. May be localized.


getKeyLocation

public int getKeyLocation()
Returns the key location.



Copyright © 2008 Apache Software Foundation. All Rights Reserved.