Package org.apache.batik.dom.events
Class DOMMouseEvent
java.lang.Object
org.apache.batik.dom.events.AbstractEvent
org.apache.batik.dom.events.DOMUIEvent
org.apache.batik.dom.events.DOMMouseEvent
- All Implemented Interfaces:
Cloneable
,OriginalEvent
,Event
,MouseEvent
,UIEvent
The MouseEvent class provides specific contextual information
associated with Mouse events.
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected HashSet
The modifier keys in effect at the time of the event.Fields inherited from class org.apache.batik.dom.events.AbstractEvent
bubbleLimit, cancelable, currentTarget, defaultActions, eventPhase, isBubbling, namespaceURI, originalEvent, preventDefault, stopImmediatePropagation, stopPropagation, target, timeStamp, type
Fields inherited from interface org.w3c.dom.events.Event
AT_TARGET, BUBBLING_PHASE, CAPTURING_PHASE
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionboolean
DOM:altKey
indicates whether the 'alt' key was depressed during the firing of the event.short
DOM: During mouse events caused by the depression or release of a mouse button,button
is used to indicate which mouse button changed state.int
DOM:clientX
indicates the horizontal coordinate at which the event occurred relative to the DOM implementation's client area.int
DOM:clientY
indicates the vertical coordinate at which the event occurred relative to the DOM implementation's client area.boolean
DOM:ctrlKey
indicates whether the 'ctrl' key was depressed during the firing of the event.boolean
DOM:metaKey
indicates whether the 'meta' key was depressed during the firing of the event.Returns the modifiers string for this event.boolean
getModifierState
(String keyIdentifierArg) DOM: Returns whether the given modifier key was pressed at the time of the event.DOM: Used to identify a secondaryEventTarget
related to a UI event.int
DOM:screenX
indicates the horizontal coordinate at which the event occurred relative to the origin of the screen coordinate system.int
DOM:screenY
indicates the vertical coordinate at which the event occurred relative to the origin of the screen coordinate system.boolean
DOM:shiftKey
indicates whether the 'shift' key was depressed during the firing of the event.void
initMouseEvent
(String typeArg, boolean canBubbleArg, boolean cancelableArg, org.w3c.dom.views.AbstractView viewArg, int detailArg, int screenXArg, int screenYArg, int clientXArg, int clientYArg, boolean ctrlKeyArg, boolean altKeyArg, boolean shiftKeyArg, boolean metaKeyArg, short buttonArg, EventTarget relatedTargetArg) DOM: TheinitMouseEvent
method is used to initialize the value of aMouseEvent
created through theDocumentEvent
interface.void
initMouseEventNS
(String namespaceURIArg, String typeArg, boolean canBubbleArg, boolean cancelableArg, org.w3c.dom.views.AbstractView viewArg, int detailArg, int screenXArg, int screenYArg, int clientXArg, int clientYArg, short buttonArg, EventTarget relatedTargetArg, String modifiersList) DOM: Initializes this event object.Methods inherited from class org.apache.batik.dom.events.DOMUIEvent
getDetail, getView, initUIEvent, initUIEventNS, split
Methods inherited from class org.apache.batik.dom.events.AbstractEvent
addDefaultAction, clone, cloneEvent, getBubbleLimit, getBubbles, getCancelable, getCurrentTarget, getDefaultActions, getDefaultPrevented, getEventPhase, getNamespaceURI, getOriginalEvent, getTarget, getTimeStamp, getType, initEvent, initEventNS, preventDefault, setBubbleLimit, stopImmediatePropagation, stopPropagation
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface org.w3c.dom.events.Event
getBubbles, getCancelable, getCurrentTarget, getEventPhase, getTarget, getTimeStamp, getType, initEvent, preventDefault, stopPropagation
Methods inherited from interface org.w3c.dom.events.UIEvent
getDetail, getView, initUIEvent
-
Field Details
-
modifierKeys
The modifier keys in effect at the time of the event.
-
-
Constructor Details
-
DOMMouseEvent
public DOMMouseEvent()
-
-
Method Details
-
getScreenX
public int getScreenX()DOM:screenX
indicates the horizontal coordinate at which the event occurred relative to the origin of the screen coordinate system.- Specified by:
getScreenX
in interfaceMouseEvent
-
getScreenY
public int getScreenY()DOM:screenY
indicates the vertical coordinate at which the event occurred relative to the origin of the screen coordinate system.- Specified by:
getScreenY
in interfaceMouseEvent
-
getClientX
public int getClientX()DOM:clientX
indicates the horizontal coordinate at which the event occurred relative to the DOM implementation's client area.- Specified by:
getClientX
in interfaceMouseEvent
-
getClientY
public int getClientY()DOM:clientY
indicates the vertical coordinate at which the event occurred relative to the DOM implementation's client area.- Specified by:
getClientY
in interfaceMouseEvent
-
getCtrlKey
public boolean getCtrlKey()DOM:ctrlKey
indicates whether the 'ctrl' key was depressed during the firing of the event.- Specified by:
getCtrlKey
in interfaceMouseEvent
-
getShiftKey
public boolean getShiftKey()DOM:shiftKey
indicates whether the 'shift' key was depressed during the firing of the event.- Specified by:
getShiftKey
in interfaceMouseEvent
-
getAltKey
public boolean getAltKey()DOM:altKey
indicates whether the 'alt' key was depressed during the firing of the event. On some platforms this key may map to an alternative key name.- Specified by:
getAltKey
in interfaceMouseEvent
-
getMetaKey
public boolean getMetaKey()DOM:metaKey
indicates whether the 'meta' key was depressed during the firing of the event. On some platforms this key may map to an alternative key name.- Specified by:
getMetaKey
in interfaceMouseEvent
-
getButton
public short getButton()DOM: During mouse events caused by the depression or release of a mouse button,button
is used to indicate which mouse button changed state. The values forbutton
range from zero to indicate the left button of the mouse, one to indicate the middle button if present, and two to indicate the right button. For mice configured for left handed use in which the button actions are reversed the values are instead read from right to left.- Specified by:
getButton
in interfaceMouseEvent
-
getRelatedTarget
DOM: Used to identify a secondaryEventTarget
related to a UI event. Currently this attribute is used with the mouseover event to indicate theEventTarget
which the pointing device exited and with the mouseout event to indicate theEventTarget
which the pointing device entered.- Specified by:
getRelatedTarget
in interfaceMouseEvent
-
getModifierState
DOM: Returns whether the given modifier key was pressed at the time of the event. -
getModifiersString
Returns the modifiers string for this event. -
initMouseEvent
public void initMouseEvent(String typeArg, boolean canBubbleArg, boolean cancelableArg, org.w3c.dom.views.AbstractView viewArg, int detailArg, int screenXArg, int screenYArg, int clientXArg, int clientYArg, boolean ctrlKeyArg, boolean altKeyArg, boolean shiftKeyArg, boolean metaKeyArg, short buttonArg, EventTarget relatedTargetArg) DOM: TheinitMouseEvent
method is used to initialize the value of aMouseEvent
created through theDocumentEvent
interface. This method may only be called before theMouseEvent
has been dispatched via thedispatchEvent
method, though it may be called multiple times during that phase if necessary. If called multiple times, the final invocation takes precedence.- Specified by:
initMouseEvent
in interfaceMouseEvent
- Parameters:
typeArg
- Specifies the event type.canBubbleArg
- Specifies whether or not the event can bubble.cancelableArg
- Specifies whether or not the event's default action can be prevented.viewArg
- Specifies theEvent
'sAbstractView
.detailArg
- Specifies theEvent
's mouse click count.screenXArg
- Specifies theEvent
's screen x coordinatescreenYArg
- Specifies theEvent
's screen y coordinateclientXArg
- Specifies theEvent
's client x coordinateclientYArg
- Specifies theEvent
's client y coordinatectrlKeyArg
- Specifies whether or not control key was depressed during theEvent
.altKeyArg
- Specifies whether or not alt key was depressed during theEvent
.shiftKeyArg
- Specifies whether or not shift key was depressed during theEvent
.metaKeyArg
- Specifies whether or not meta key was depressed during theEvent
.buttonArg
- Specifies theEvent
's mouse button.relatedTargetArg
- Specifies theEvent
's relatedEventTarget
.
-
initMouseEventNS
public void initMouseEventNS(String namespaceURIArg, String typeArg, boolean canBubbleArg, boolean cancelableArg, org.w3c.dom.views.AbstractView viewArg, int detailArg, int screenXArg, int screenYArg, int clientXArg, int clientYArg, short buttonArg, EventTarget relatedTargetArg, String modifiersList) DOM: Initializes this event object.
-