src/org/w3c/dom/events/MouseEvent.java

Print this page
rev 602 : 8047723: @since tag cleanup in jaxp
Reviewed-by:


  41 
  42 package org.w3c.dom.events;
  43 
  44 import org.w3c.dom.views.AbstractView;
  45 
  46 /**
  47  * The <code>MouseEvent</code> interface provides specific contextual
  48  * information associated with Mouse events.
  49  * <p>The <code>detail</code> attribute inherited from <code>UIEvent</code>
  50  * indicates the number of times a mouse button has been pressed and
  51  * released over the same screen location during a user action. The
  52  * attribute value is 1 when the user begins this action and increments by 1
  53  * for each full sequence of pressing and releasing. If the user moves the
  54  * mouse between the mousedown and mouseup the value will be set to 0,
  55  * indicating that no click is occurring.
  56  * <p>In the case of nested elements mouse events are always targeted at the
  57  * most deeply nested element. Ancestors of the targeted element may use
  58  * bubbling to obtain notification of mouse events which occur within its
  59  * descendent elements.
  60  * <p>See also the <a href='http://www.w3.org/TR/2000/REC-DOM-Level-2-Events-20001113'>Document Object Model (DOM) Level 2 Events Specification</a>.
  61  * @since DOM Level 2
  62  */
  63 public interface MouseEvent extends UIEvent {
  64     /**
  65      * The horizontal coordinate at which the event occurred relative to the
  66      * origin of the screen coordinate system.
  67      */
  68     public int getScreenX();
  69 
  70     /**
  71      * The vertical coordinate at which the event occurred relative to the
  72      * origin of the screen coordinate system.
  73      */
  74     public int getScreenY();
  75 
  76     /**
  77      * The horizontal coordinate at which the event occurred relative to the
  78      * DOM implementation's client area.
  79      */
  80     public int getClientX();
  81 




  41 
  42 package org.w3c.dom.events;
  43 
  44 import org.w3c.dom.views.AbstractView;
  45 
  46 /**
  47  * The <code>MouseEvent</code> interface provides specific contextual
  48  * information associated with Mouse events.
  49  * <p>The <code>detail</code> attribute inherited from <code>UIEvent</code>
  50  * indicates the number of times a mouse button has been pressed and
  51  * released over the same screen location during a user action. The
  52  * attribute value is 1 when the user begins this action and increments by 1
  53  * for each full sequence of pressing and releasing. If the user moves the
  54  * mouse between the mousedown and mouseup the value will be set to 0,
  55  * indicating that no click is occurring.
  56  * <p>In the case of nested elements mouse events are always targeted at the
  57  * most deeply nested element. Ancestors of the targeted element may use
  58  * bubbling to obtain notification of mouse events which occur within its
  59  * descendent elements.
  60  * <p>See also the <a href='http://www.w3.org/TR/2000/REC-DOM-Level-2-Events-20001113'>Document Object Model (DOM) Level 2 Events Specification</a>.
  61  * @since 1.5, DOM Level 2
  62  */
  63 public interface MouseEvent extends UIEvent {
  64     /**
  65      * The horizontal coordinate at which the event occurred relative to the
  66      * origin of the screen coordinate system.
  67      */
  68     public int getScreenX();
  69 
  70     /**
  71      * The vertical coordinate at which the event occurred relative to the
  72      * origin of the screen coordinate system.
  73      */
  74     public int getScreenY();
  75 
  76     /**
  77      * The horizontal coordinate at which the event occurred relative to the
  78      * DOM implementation's client area.
  79      */
  80     public int getClientX();
  81