Package org.apache.batik.gvt.event
Class GraphicsNodeInputEvent
- java.lang.Object
-
- java.util.EventObject
-
- org.apache.batik.gvt.event.GraphicsNodeEvent
-
- org.apache.batik.gvt.event.GraphicsNodeInputEvent
-
- All Implemented Interfaces:
java.io.Serializable
- Direct Known Subclasses:
GraphicsNodeKeyEvent,GraphicsNodeMouseEvent,GraphicsNodeMouseWheelEvent
public abstract class GraphicsNodeInputEvent extends GraphicsNodeEvent
The root event class for all graphics node-level input events.- Version:
- $Id: GraphicsNodeInputEvent.java 1831615 2018-05-15 09:50:53Z ssteiner $
- See Also:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description static intALT_GRAPH_MASKThe alt-graph key modifier constant.static intALT_MASKThe alt key modifier constant.static intBUTTON1_MASKThe mouse button1 modifier constant.static intBUTTON2_MASKThe mouse button2 modifier constant.static intBUTTON3_MASKThe mouse button3 modifier constant.static intCAPS_LOCK_MASKThe caps lock constant.static intCTRL_MASKThe control key modifier constant.static intKANA_LOCK_MASKThe kana lock constant.(package private) intlockStateThe state of the key locks at the time the graphics node input event was fired.static intMETA_MASKThe meta key modifier constant.(package private) intmodifiersThe state of the modifier keys at the time the graphics node input event was fired.static intNUM_LOCK_MASKThe num lock constant.static intSCROLL_LOCK_MASKThe scroll lock constant.static intSHIFT_MASKThe shift key modifier constant.(package private) longwhenThe graphics node input events Time stamp.-
Fields inherited from class org.apache.batik.gvt.event.GraphicsNodeEvent
id
-
-
Constructor Summary
Constructors Modifier Constructor Description protectedGraphicsNodeInputEvent(GraphicsNode source, int id, long when, int modifiers, int lockState)Constructs a new graphics node input event.protectedGraphicsNodeInputEvent(GraphicsNode source, java.awt.event.InputEvent evt, int lockState)Constructs a new graphics node input event from an AWT InputEvent.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description intgetLockState()Returns the lock state flags for this event.intgetModifiers()Returns the modifiers flag for this event.longgetWhen()Returns the timestamp of when this event occurred.booleanisAltDown()Returns whether or not the Alt modifier is down on this event.booleanisAltGraphDown()Returns whether or not the Alt-Graph modifier is down on this event.booleanisControlDown()Returns whether or not the Control modifier is down on this event.booleanisMetaDown()Returns whether or not the Meta modifier is down on this event.booleanisShiftDown()Returns whether or not the Shift modifier is down on this event.-
Methods inherited from class org.apache.batik.gvt.event.GraphicsNodeEvent
consume, getGraphicsNode, getID, isConsumed
-
-
-
-
Field Detail
-
SHIFT_MASK
public static final int SHIFT_MASK
The shift key modifier constant.- See Also:
- Constant Field Values
-
CTRL_MASK
public static final int CTRL_MASK
The control key modifier constant.- See Also:
- Constant Field Values
-
META_MASK
public static final int META_MASK
The meta key modifier constant.- See Also:
- Constant Field Values
-
ALT_MASK
public static final int ALT_MASK
The alt key modifier constant.- See Also:
- Constant Field Values
-
ALT_GRAPH_MASK
public static final int ALT_GRAPH_MASK
The alt-graph key modifier constant.- See Also:
- Constant Field Values
-
BUTTON1_MASK
public static final int BUTTON1_MASK
The mouse button1 modifier constant.- See Also:
- Constant Field Values
-
BUTTON2_MASK
public static final int BUTTON2_MASK
The mouse button2 modifier constant.- See Also:
- Constant Field Values
-
BUTTON3_MASK
public static final int BUTTON3_MASK
The mouse button3 modifier constant.- See Also:
- Constant Field Values
-
CAPS_LOCK_MASK
public static final int CAPS_LOCK_MASK
The caps lock constant.- See Also:
- Constant Field Values
-
NUM_LOCK_MASK
public static final int NUM_LOCK_MASK
The num lock constant.- See Also:
- Constant Field Values
-
SCROLL_LOCK_MASK
public static final int SCROLL_LOCK_MASK
The scroll lock constant.- See Also:
- Constant Field Values
-
KANA_LOCK_MASK
public static final int KANA_LOCK_MASK
The kana lock constant.- See Also:
- Constant Field Values
-
when
long when
The graphics node input events Time stamp. The time stamp is in UTC format that indicates when the input event was created.
-
modifiers
int modifiers
The state of the modifier keys at the time the graphics node input event was fired.
-
lockState
int lockState
The state of the key locks at the time the graphics node input event was fired.
-
-
Constructor Detail
-
GraphicsNodeInputEvent
protected GraphicsNodeInputEvent(GraphicsNode source, int id, long when, int modifiers, int lockState)
Constructs a new graphics node input event.- Parameters:
source- the graphics node where the event originatedid- the id of this eventwhen- the time the event occurredmodifiers- the modifier keys down while event occurred
-
GraphicsNodeInputEvent
protected GraphicsNodeInputEvent(GraphicsNode source, java.awt.event.InputEvent evt, int lockState)
Constructs a new graphics node input event from an AWT InputEvent.- Parameters:
source- the graphics node where the event originatedevt- the AWT InputEvent triggering this event's creation
-
-
Method Detail
-
isShiftDown
public boolean isShiftDown()
Returns whether or not the Shift modifier is down on this event.
-
isControlDown
public boolean isControlDown()
Returns whether or not the Control modifier is down on this event.
-
isMetaDown
public boolean isMetaDown()
Returns whether or not the Meta modifier is down on this event.
-
isAltDown
public boolean isAltDown()
Returns whether or not the Alt modifier is down on this event.
-
isAltGraphDown
public boolean isAltGraphDown()
Returns whether or not the Alt-Graph modifier is down on this event.
-
getWhen
public long getWhen()
Returns the timestamp of when this event occurred.
-
getModifiers
public int getModifiers()
Returns the modifiers flag for this event.
-
getLockState
public int getLockState()
Returns the lock state flags for this event.
-
-