Class 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.
    • Constructor Summary

      Constructors 
      Constructor Description
      DOMMouseEvent()  
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean getAltKey()
      DOM: altKey indicates whether the 'alt' key was depressed during the firing of the event.
      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.
      int getClientX()
      DOM: clientX indicates the horizontal coordinate at which the event occurred relative to the DOM implementation's client area.
      int getClientY()
      DOM: clientY indicates the vertical coordinate at which the event occurred relative to the DOM implementation's client area.
      boolean getCtrlKey()
      DOM: ctrlKey indicates whether the 'ctrl' key was depressed during the firing of the event.
      boolean getMetaKey()
      DOM: metaKey indicates whether the 'meta' key was depressed during the firing of the event.
      java.lang.String getModifiersString()
      Returns the modifiers string for this event.
      boolean getModifierState​(java.lang.String keyIdentifierArg)
      DOM: Returns whether the given modifier key was pressed at the time of the event.
      org.w3c.dom.events.EventTarget getRelatedTarget()
      DOM: Used to identify a secondary EventTarget related to a UI event.
      int getScreenX()
      DOM: screenX indicates the horizontal coordinate at which the event occurred relative to the origin of the screen coordinate system.
      int getScreenY()
      DOM: screenY indicates the vertical coordinate at which the event occurred relative to the origin of the screen coordinate system.
      boolean getShiftKey()
      DOM: shiftKey indicates whether the 'shift' key was depressed during the firing of the event.
      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: The initMouseEvent method is used to initialize the value of a MouseEvent created through the DocumentEvent interface.
      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.
      • 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 Detail

      • modifierKeys

        protected java.util.HashSet modifierKeys
        The modifier keys in effect at the time of the event.
    • Constructor Detail

      • DOMMouseEvent

        public DOMMouseEvent()
    • Method Detail

      • 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 interface org.w3c.dom.events.MouseEvent
      • 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 interface org.w3c.dom.events.MouseEvent
      • 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 interface org.w3c.dom.events.MouseEvent
      • 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 interface org.w3c.dom.events.MouseEvent
      • getCtrlKey

        public boolean getCtrlKey()
        DOM: ctrlKey indicates whether the 'ctrl' key was depressed during the firing of the event.
        Specified by:
        getCtrlKey in interface org.w3c.dom.events.MouseEvent
      • getShiftKey

        public boolean getShiftKey()
        DOM: shiftKey indicates whether the 'shift' key was depressed during the firing of the event.
        Specified by:
        getShiftKey in interface org.w3c.dom.events.MouseEvent
      • 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 interface org.w3c.dom.events.MouseEvent
      • 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 interface org.w3c.dom.events.MouseEvent
      • 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 for button 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 interface org.w3c.dom.events.MouseEvent
      • getRelatedTarget

        public org.w3c.dom.events.EventTarget getRelatedTarget()
        DOM: Used to identify a secondary EventTarget related to a UI event. Currently this attribute is used with the mouseover event to indicate the EventTarget which the pointing device exited and with the mouseout event to indicate the EventTarget which the pointing device entered.
        Specified by:
        getRelatedTarget in interface org.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: The initMouseEvent method is used to initialize the value of a MouseEvent created through the DocumentEvent interface. This method may only be called before the MouseEvent has been dispatched via the dispatchEvent 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 interface org.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 the Event's AbstractView.
        detailArg - Specifies the Event's mouse click count.
        screenXArg - Specifies the Event's screen x coordinate
        screenYArg - Specifies the Event's screen y coordinate
        clientXArg - Specifies the Event's client x coordinate
        clientYArg - Specifies the Event's client y coordinate
        ctrlKeyArg - Specifies whether or not control key was depressed during the Event.
        altKeyArg - Specifies whether or not alt key was depressed during the Event.
        shiftKeyArg - Specifies whether or not shift key was depressed during the Event.
        metaKeyArg - Specifies whether or not meta key was depressed during the Event.
        buttonArg - Specifies the Event's mouse button.
        relatedTargetArg - Specifies the Event's related EventTarget.
      • 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.