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:
java.lang.Cloneable,OriginalEvent,org.w3c.dom.events.Event,org.w3c.dom.events.MouseEvent,org.w3c.dom.events.UIEvent
public class DOMMouseEvent extends DOMUIEvent implements org.w3c.dom.events.MouseEvent
The MouseEvent class provides specific contextual information associated with Mouse events.- Version:
- $Id: DOMMouseEvent.java 1804130 2017-08-04 14:41:11Z ssteiner $
-
-
Field Summary
Fields Modifier and Type Field Description private shortbuttonprivate intclientXprivate intclientYprotected java.util.HashSetmodifierKeysThe modifier keys in effect at the time of the event.private org.w3c.dom.events.EventTargetrelatedTargetprivate intscreenXprivate intscreenY-
Fields inherited from class org.apache.batik.dom.events.AbstractEvent
bubbleLimit, cancelable, currentTarget, defaultActions, eventPhase, isBubbling, namespaceURI, originalEvent, preventDefault, stopImmediatePropagation, stopPropagation, target, timeStamp, type
-
-
Constructor Summary
Constructors Constructor Description DOMMouseEvent()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description booleangetAltKey()DOM:altKeyindicates whether the 'alt' key was depressed during the firing of the event.shortgetButton()DOM: During mouse events caused by the depression or release of a mouse button,buttonis used to indicate which mouse button changed state.intgetClientX()DOM:clientXindicates the horizontal coordinate at which the event occurred relative to the DOM implementation's client area.intgetClientY()DOM:clientYindicates the vertical coordinate at which the event occurred relative to the DOM implementation's client area.booleangetCtrlKey()DOM:ctrlKeyindicates whether the 'ctrl' key was depressed during the firing of the event.booleangetMetaKey()DOM:metaKeyindicates whether the 'meta' key was depressed during the firing of the event.java.lang.StringgetModifiersString()Returns the modifiers string for this event.booleangetModifierState(java.lang.String keyIdentifierArg)DOM: Returns whether the given modifier key was pressed at the time of the event.org.w3c.dom.events.EventTargetgetRelatedTarget()DOM: Used to identify a secondaryEventTargetrelated to a UI event.intgetScreenX()DOM:screenXindicates the horizontal coordinate at which the event occurred relative to the origin of the screen coordinate system.intgetScreenY()DOM:screenYindicates the vertical coordinate at which the event occurred relative to the origin of the screen coordinate system.booleangetShiftKey()DOM:shiftKeyindicates whether the 'shift' key was depressed during the firing of the event.voidinitMouseEvent(java.lang.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, org.w3c.dom.events.EventTarget relatedTargetArg)DOM: TheinitMouseEventmethod is used to initialize the value of aMouseEventcreated through theDocumentEventinterface.voidinitMouseEventNS(java.lang.String namespaceURIArg, java.lang.String typeArg, boolean canBubbleArg, boolean cancelableArg, org.w3c.dom.views.AbstractView viewArg, int detailArg, int screenXArg, int screenYArg, int clientXArg, int clientYArg, short buttonArg, org.w3c.dom.events.EventTarget relatedTargetArg, java.lang.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, getStopImmediatePropagation, getStopPropagation, getTarget, getTimeStamp, getType, initEvent, initEventNS, preventDefault, preventDefault, setBubbleLimit, setCurrentTarget, setEventPhase, setTarget, stopImmediatePropagation, stopImmediatePropagation, stopPropagation, stopPropagation
-
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
-
-
-
Field Detail
-
screenX
private int screenX
-
screenY
private int screenY
-
clientX
private int clientX
-
clientY
private int clientY
-
button
private short button
-
relatedTarget
private org.w3c.dom.events.EventTarget relatedTarget
-
modifierKeys
protected java.util.HashSet modifierKeys
The modifier keys in effect at the time of the event.
-
-
Method Detail
-
getScreenX
public int getScreenX()
DOM:screenXindicates the horizontal coordinate at which the event occurred relative to the origin of the screen coordinate system.- Specified by:
getScreenXin interfaceorg.w3c.dom.events.MouseEvent
-
getScreenY
public int getScreenY()
DOM:screenYindicates the vertical coordinate at which the event occurred relative to the origin of the screen coordinate system.- Specified by:
getScreenYin interfaceorg.w3c.dom.events.MouseEvent
-
getClientX
public int getClientX()
DOM:clientXindicates the horizontal coordinate at which the event occurred relative to the DOM implementation's client area.- Specified by:
getClientXin interfaceorg.w3c.dom.events.MouseEvent
-
getClientY
public int getClientY()
DOM:clientYindicates the vertical coordinate at which the event occurred relative to the DOM implementation's client area.- Specified by:
getClientYin interfaceorg.w3c.dom.events.MouseEvent
-
getCtrlKey
public boolean getCtrlKey()
DOM:ctrlKeyindicates whether the 'ctrl' key was depressed during the firing of the event.- Specified by:
getCtrlKeyin interfaceorg.w3c.dom.events.MouseEvent
-
getShiftKey
public boolean getShiftKey()
DOM:shiftKeyindicates whether the 'shift' key was depressed during the firing of the event.- Specified by:
getShiftKeyin interfaceorg.w3c.dom.events.MouseEvent
-
getAltKey
public boolean getAltKey()
DOM:altKeyindicates 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:
getAltKeyin interfaceorg.w3c.dom.events.MouseEvent
-
getMetaKey
public boolean getMetaKey()
DOM:metaKeyindicates 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:
getMetaKeyin interfaceorg.w3c.dom.events.MouseEvent
-
getButton
public short getButton()
DOM: During mouse events caused by the depression or release of a mouse button,buttonis used to indicate which mouse button changed state. The values forbuttonrange 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:
getButtonin interfaceorg.w3c.dom.events.MouseEvent
-
getRelatedTarget
public org.w3c.dom.events.EventTarget getRelatedTarget()
DOM: Used to identify a secondaryEventTargetrelated to a UI event. Currently this attribute is used with the mouseover event to indicate theEventTargetwhich the pointing device exited and with the mouseout event to indicate theEventTargetwhich the pointing device entered.- Specified by:
getRelatedTargetin interfaceorg.w3c.dom.events.MouseEvent
-
getModifierState
public boolean getModifierState(java.lang.String keyIdentifierArg)
DOM: Returns whether the given modifier key was pressed at the time of the event.
-
getModifiersString
public java.lang.String getModifiersString()
Returns the modifiers string for this event.
-
initMouseEvent
public void initMouseEvent(java.lang.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, org.w3c.dom.events.EventTarget relatedTargetArg)DOM: TheinitMouseEventmethod is used to initialize the value of aMouseEventcreated through theDocumentEventinterface. This method may only be called before theMouseEventhas been dispatched via thedispatchEventmethod, though it may be called multiple times during that phase if necessary. If called multiple times, the final invocation takes precedence.- Specified by:
initMouseEventin interfaceorg.w3c.dom.events.MouseEvent- 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(java.lang.String namespaceURIArg, java.lang.String typeArg, boolean canBubbleArg, boolean cancelableArg, org.w3c.dom.views.AbstractView viewArg, int detailArg, int screenXArg, int screenYArg, int clientXArg, int clientYArg, short buttonArg, org.w3c.dom.events.EventTarget relatedTargetArg, java.lang.String modifiersList)DOM: Initializes this event object.
-
-