| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!--NewPage--> |
| <HTML> |
| <HEAD> |
| <TITLE> |
| MouseEvent (Apache Batik Javadoc) |
| </TITLE> |
| |
| |
| <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style"> |
| |
| <SCRIPT type="text/javascript"> |
| function windowTitle() |
| { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="MouseEvent (Apache Batik Javadoc)"; |
| } |
| } |
| </SCRIPT> |
| <NOSCRIPT> |
| </NOSCRIPT> |
| |
| </HEAD> |
| |
| <BODY BGCOLOR="white" onload="windowTitle();"> |
| <HR> |
| |
| |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <A NAME="navbar_top"><!-- --></A> |
| <A HREF="#skip-navbar_top" title="Skip navigation links"></A> |
| <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> |
| <TR> |
| <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> |
| <A NAME="navbar_top_firstrow"><!-- --></A> |
| <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> |
| <TR ALIGN="center" VALIGN="top"> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> |
| <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/MouseEvent.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> |
| </TR> |
| </TABLE> |
| </TD> |
| <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> |
| </EM> |
| </TD> |
| </TR> |
| |
| <TR> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../org/w3c/dom/events/KeyboardEvent.html" title="interface in org.w3c.dom.events"><B>PREV CLASS</B></A> |
| <A HREF="../../../../org/w3c/dom/events/MutationEvent.html" title="interface in org.w3c.dom.events"><B>NEXT CLASS</B></A></FONT></TD> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../index.html?org/w3c/dom/events/MouseEvent.html" target="_top"><B>FRAMES</B></A> |
| <A HREF="MouseEvent.html" target="_top"><B>NO FRAMES</B></A> |
| <SCRIPT type="text/javascript"> |
| <!-- |
| if(window==top) { |
| document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>'); |
| } |
| //--> |
| </SCRIPT> |
| <NOSCRIPT> |
| <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A> |
| </NOSCRIPT> |
| |
| |
| </FONT></TD> |
| </TR> |
| <TR> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| SUMMARY: NESTED | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD> |
| </TR> |
| </TABLE> |
| <A NAME="skip-navbar_top"></A> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| |
| <HR> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <H2> |
| <FONT SIZE="-1"> |
| org.w3c.dom.events</FONT> |
| <BR> |
| Interface MouseEvent</H2> |
| <DL> |
| <DT><B>All Superinterfaces:</B> <DD><A HREF="../../../../org/w3c/dom/events/Event.html" title="interface in org.w3c.dom.events">Event</A>, <A HREF="../../../../org/w3c/dom/events/UIEvent.html" title="interface in org.w3c.dom.events">UIEvent</A></DD> |
| </DL> |
| <DL> |
| <DT><B>All Known Implementing Classes:</B> <DD><A HREF="../../../../org/apache/batik/dom/events/DOMMouseEvent.html" title="class in org.apache.batik.dom.events">DOMMouseEvent</A></DD> |
| </DL> |
| <HR> |
| <DL> |
| <DT><PRE>public interface <B>MouseEvent</B><DT>extends <A HREF="../../../../org/w3c/dom/events/UIEvent.html" title="interface in org.w3c.dom.events">UIEvent</A></DL> |
| </PRE> |
| |
| <P> |
| The <code>MouseEvent</code> interface provides specific contextual |
| information associated with Mouse events. |
| <p> In the case of nested elements mouse events are always targeted at the |
| most deeply nested element. Ancestors of the targeted element may use |
| bubbling to obtain notification of mouse events which occur within theirs |
| descendent elements. |
| <p> To create an instance of the <code>MouseEvent</code> interface, use the |
| <code>DocumentEvent.createEvent("MouseEvent")</code> method call. |
| <p ><b>Note:</b> When initializing <code>MouseEvent</code> objects using |
| <code>initMouseEvent</code> or <code>initMouseEventNS</code>, |
| implementations should use the client coordinates <code>clientX</code> |
| and <code>clientY</code> for calculation of other coordinates (such as |
| target coordinates exposed by DOM Level 0 implementations). |
| <p>See also the <a href='http://www.w3.org/TR/2006/WD-DOM-Level-3-Events-20060413'> |
| Document Object Model (DOM) Level 3 Events Specification |
| </a>. |
| <P> |
| |
| <P> |
| <DL> |
| <DT><B>Since:</B></DT> |
| <DD>DOM Level 2</DD> |
| </DL> |
| <HR> |
| |
| <P> |
| <!-- =========== FIELD SUMMARY =========== --> |
| |
| <A NAME="field_summary"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
| <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> |
| <B>Field Summary</B></FONT></TH> |
| </TR> |
| </TABLE> |
| <A NAME="fields_inherited_from_class_org.w3c.dom.events.Event"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> |
| <TH ALIGN="left"><B>Fields inherited from interface org.w3c.dom.events.<A HREF="../../../../org/w3c/dom/events/Event.html" title="interface in org.w3c.dom.events">Event</A></B></TH> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><CODE><A HREF="../../../../org/w3c/dom/events/Event.html#AT_TARGET">AT_TARGET</A>, <A HREF="../../../../org/w3c/dom/events/Event.html#BUBBLING_PHASE">BUBBLING_PHASE</A>, <A HREF="../../../../org/w3c/dom/events/Event.html#CAPTURING_PHASE">CAPTURING_PHASE</A></CODE></TD> |
| </TR> |
| </TABLE> |
| |
| <!-- ========== METHOD SUMMARY =========== --> |
| |
| <A NAME="method_summary"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
| <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> |
| <B>Method Summary</B></FONT></TH> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> boolean</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/w3c/dom/events/MouseEvent.html#getAltKey()">getAltKey</A></B>()</CODE> |
| |
| <BR> |
| <code>true</code> if the alt (alternative) key modifier is activated.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> short</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/w3c/dom/events/MouseEvent.html#getButton()">getButton</A></B>()</CODE> |
| |
| <BR> |
| During mouse events caused by the depression or release of a mouse |
| button, <code>button</code> is used to indicate which mouse button |
| changed state.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> int</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/w3c/dom/events/MouseEvent.html#getClientX()">getClientX</A></B>()</CODE> |
| |
| <BR> |
| The horizontal coordinate at which the event occurred relative to the |
| DOM implementation's client area.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> int</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/w3c/dom/events/MouseEvent.html#getClientY()">getClientY</A></B>()</CODE> |
| |
| <BR> |
| The vertical coordinate at which the event occurred relative to the |
| DOM implementation's client area.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> boolean</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/w3c/dom/events/MouseEvent.html#getCtrlKey()">getCtrlKey</A></B>()</CODE> |
| |
| <BR> |
| <code>true</code> if the control (Ctrl) key modifier is activated.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> boolean</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/w3c/dom/events/MouseEvent.html#getMetaKey()">getMetaKey</A></B>()</CODE> |
| |
| <BR> |
| <code>true</code> if the meta (Meta) key modifier is activated.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> boolean</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/w3c/dom/events/MouseEvent.html#getModifierState(java.lang.String)">getModifierState</A></B>(<A HREF="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> keyIdentifierArg)</CODE> |
| |
| <BR> |
| This methods queries the state of a modifier using a key identifier.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../../org/w3c/dom/events/EventTarget.html" title="interface in org.w3c.dom.events">EventTarget</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/w3c/dom/events/MouseEvent.html#getRelatedTarget()">getRelatedTarget</A></B>()</CODE> |
| |
| <BR> |
| Used to identify a secondary <code>EventTarget</code> related to a UI |
| event, depending on the type of event.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> int</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/w3c/dom/events/MouseEvent.html#getScreenX()">getScreenX</A></B>()</CODE> |
| |
| <BR> |
| The horizontal coordinate at which the event occurred relative to the |
| origin of the screen coordinate system.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> int</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/w3c/dom/events/MouseEvent.html#getScreenY()">getScreenY</A></B>()</CODE> |
| |
| <BR> |
| The vertical coordinate at which the event occurred relative to the |
| origin of the screen coordinate system.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> boolean</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/w3c/dom/events/MouseEvent.html#getShiftKey()">getShiftKey</A></B>()</CODE> |
| |
| <BR> |
| <code>true</code> if the shift (Shift) key modifier is activated.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/w3c/dom/events/MouseEvent.html#initMouseEvent(java.lang.String, boolean, boolean, org.w3c.dom.views.AbstractView, int, int, int, int, int, boolean, boolean, boolean, boolean, short, org.w3c.dom.events.EventTarget)">initMouseEvent</A></B>(<A HREF="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> typeArg, |
| boolean canBubbleArg, |
| boolean cancelableArg, |
| <A HREF="http://www.w3.org/2003/01/dom2-javadoc/org/w3c/dom/views/AbstractView.html?is-external=true" title="class or interface in org.w3c.dom.views">AbstractView</A> viewArg, |
| int detailArg, |
| int screenXArg, |
| int screenYArg, |
| int clientXArg, |
| int clientYArg, |
| boolean ctrlKeyArg, |
| boolean altKeyArg, |
| boolean shiftKeyArg, |
| boolean metaKeyArg, |
| short buttonArg, |
| <A HREF="../../../../org/w3c/dom/events/EventTarget.html" title="interface in org.w3c.dom.events">EventTarget</A> relatedTargetArg)</CODE> |
| |
| <BR> |
| The <code>initMouseEvent</code> method is used to initialize the value |
| of a <code>MouseEvent</code> object and has the same behavior as |
| <code>UIEvent.initUIEvent()</code>.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/w3c/dom/events/MouseEvent.html#initMouseEventNS(java.lang.String, java.lang.String, boolean, boolean, org.w3c.dom.views.AbstractView, int, int, int, int, int, short, org.w3c.dom.events.EventTarget, java.lang.String)">initMouseEventNS</A></B>(<A HREF="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> namespaceURI, |
| <A HREF="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> typeArg, |
| boolean canBubbleArg, |
| boolean cancelableArg, |
| <A HREF="http://www.w3.org/2003/01/dom2-javadoc/org/w3c/dom/views/AbstractView.html?is-external=true" title="class or interface in org.w3c.dom.views">AbstractView</A> viewArg, |
| int detailArg, |
| int screenXArg, |
| int screenYArg, |
| int clientXArg, |
| int clientYArg, |
| short buttonArg, |
| <A HREF="../../../../org/w3c/dom/events/EventTarget.html" title="interface in org.w3c.dom.events">EventTarget</A> relatedTargetArg, |
| <A HREF="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> modifiersList)</CODE> |
| |
| <BR> |
| The <code>initMouseEventNS</code> method is used to initialize the |
| value of a <code>MouseEvent</code> object and has the same behavior |
| as <code>UIEvent.initUIEventNS()</code>.</TD> |
| </TR> |
| </TABLE> |
| <A NAME="methods_inherited_from_class_org.w3c.dom.events.UIEvent"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> |
| <TH ALIGN="left"><B>Methods inherited from interface org.w3c.dom.events.<A HREF="../../../../org/w3c/dom/events/UIEvent.html" title="interface in org.w3c.dom.events">UIEvent</A></B></TH> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><CODE><A HREF="../../../../org/w3c/dom/events/UIEvent.html#getDetail()">getDetail</A>, <A HREF="../../../../org/w3c/dom/events/UIEvent.html#getView()">getView</A>, <A HREF="../../../../org/w3c/dom/events/UIEvent.html#initUIEvent(java.lang.String, boolean, boolean, org.w3c.dom.views.AbstractView, int)">initUIEvent</A>, <A HREF="../../../../org/w3c/dom/events/UIEvent.html#initUIEventNS(java.lang.String, java.lang.String, boolean, boolean, org.w3c.dom.views.AbstractView, int)">initUIEventNS</A></CODE></TD> |
| </TR> |
| </TABLE> |
| <A NAME="methods_inherited_from_class_org.w3c.dom.events.Event"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> |
| <TH ALIGN="left"><B>Methods inherited from interface org.w3c.dom.events.<A HREF="../../../../org/w3c/dom/events/Event.html" title="interface in org.w3c.dom.events">Event</A></B></TH> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><CODE><A HREF="../../../../org/w3c/dom/events/Event.html#getBubbles()">getBubbles</A>, <A HREF="../../../../org/w3c/dom/events/Event.html#getCancelable()">getCancelable</A>, <A HREF="../../../../org/w3c/dom/events/Event.html#getCurrentTarget()">getCurrentTarget</A>, <A HREF="../../../../org/w3c/dom/events/Event.html#getDefaultPrevented()">getDefaultPrevented</A>, <A HREF="../../../../org/w3c/dom/events/Event.html#getEventPhase()">getEventPhase</A>, <A HREF="../../../../org/w3c/dom/events/Event.html#getNamespaceURI()">getNamespaceURI</A>, <A HREF="../../../../org/w3c/dom/events/Event.html#getTarget()">getTarget</A>, <A HREF="../../../../org/w3c/dom/events/Event.html#getTimeStamp()">getTimeStamp</A>, <A HREF="../../../../org/w3c/dom/events/Event.html#getType()">getType</A>, <A HREF="../../../../org/w3c/dom/events/Event.html#initEvent(java.lang.String, boolean, boolean)">initEvent</A>, <A HREF="../../../../org/w3c/dom/events/Event.html#initEventNS(java.lang.String, java.lang.String, boolean, boolean)">initEventNS</A>, <A HREF="../../../../org/w3c/dom/events/Event.html#preventDefault()">preventDefault</A>, <A HREF="../../../../org/w3c/dom/events/Event.html#stopImmediatePropagation()">stopImmediatePropagation</A>, <A HREF="../../../../org/w3c/dom/events/Event.html#stopPropagation()">stopPropagation</A></CODE></TD> |
| </TR> |
| </TABLE> |
| |
| <P> |
| |
| <!-- ============ METHOD DETAIL ========== --> |
| |
| <A NAME="method_detail"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
| <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> |
| <B>Method Detail</B></FONT></TH> |
| </TR> |
| </TABLE> |
| |
| <A NAME="getScreenX()"><!-- --></A><H3> |
| getScreenX</H3> |
| <PRE> |
| int <B>getScreenX</B>()</PRE> |
| <DL> |
| <DD>The horizontal coordinate at which the event occurred relative to the |
| origin of the screen coordinate system. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getScreenY()"><!-- --></A><H3> |
| getScreenY</H3> |
| <PRE> |
| int <B>getScreenY</B>()</PRE> |
| <DL> |
| <DD>The vertical coordinate at which the event occurred relative to the |
| origin of the screen coordinate system. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getClientX()"><!-- --></A><H3> |
| getClientX</H3> |
| <PRE> |
| int <B>getClientX</B>()</PRE> |
| <DL> |
| <DD>The horizontal coordinate at which the event occurred relative to the |
| DOM implementation's client area. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getClientY()"><!-- --></A><H3> |
| getClientY</H3> |
| <PRE> |
| int <B>getClientY</B>()</PRE> |
| <DL> |
| <DD>The vertical coordinate at which the event occurred relative to the |
| DOM implementation's client area. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getCtrlKey()"><!-- --></A><H3> |
| getCtrlKey</H3> |
| <PRE> |
| boolean <B>getCtrlKey</B>()</PRE> |
| <DL> |
| <DD><code>true</code> if the control (Ctrl) key modifier is activated. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getShiftKey()"><!-- --></A><H3> |
| getShiftKey</H3> |
| <PRE> |
| boolean <B>getShiftKey</B>()</PRE> |
| <DL> |
| <DD><code>true</code> if the shift (Shift) key modifier is activated. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getAltKey()"><!-- --></A><H3> |
| getAltKey</H3> |
| <PRE> |
| boolean <B>getAltKey</B>()</PRE> |
| <DL> |
| <DD><code>true</code> if the alt (alternative) key modifier is activated. |
| <p ><b>Note:</b> The Option key modifier on Macintosh systems must be |
| represented using this key modifier. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getMetaKey()"><!-- --></A><H3> |
| getMetaKey</H3> |
| <PRE> |
| boolean <B>getMetaKey</B>()</PRE> |
| <DL> |
| <DD><code>true</code> if the meta (Meta) key modifier is activated. |
| <p ><b>Note:</b> The Command key modifier on Macintosh system must be |
| represented using this meta key. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getButton()"><!-- --></A><H3> |
| getButton</H3> |
| <PRE> |
| short <B>getButton</B>()</PRE> |
| <DL> |
| <DD>During mouse events caused by the depression or release of a mouse |
| button, <code>button</code> is used to indicate which mouse button |
| changed state. <code>0</code> indicates the normal button of the |
| mouse (in general on the left or the one button on Macintosh mice, |
| used to activate a button or select text). <code>2</code> indicates |
| the contextual property (in general on the right, used to display a |
| context menu) button of the mouse if present. <code>1</code> |
| indicates the extra (in general in the middle and often combined with |
| the mouse wheel) button. Some mice may provide or simulate more |
| buttons, and values higher than <code>2</code> can be used to |
| represent such buttons. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getRelatedTarget()"><!-- --></A><H3> |
| getRelatedTarget</H3> |
| <PRE> |
| <A HREF="../../../../org/w3c/dom/events/EventTarget.html" title="interface in org.w3c.dom.events">EventTarget</A> <B>getRelatedTarget</B>()</PRE> |
| <DL> |
| <DD>Used to identify a secondary <code>EventTarget</code> related to a UI |
| event, depending on the type of event. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="initMouseEvent(java.lang.String, boolean, boolean, org.w3c.dom.views.AbstractView, int, int, int, int, int, boolean, boolean, boolean, boolean, short, org.w3c.dom.events.EventTarget)"><!-- --></A><H3> |
| initMouseEvent</H3> |
| <PRE> |
| void <B>initMouseEvent</B>(<A HREF="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> typeArg, |
| boolean canBubbleArg, |
| boolean cancelableArg, |
| <A HREF="http://www.w3.org/2003/01/dom2-javadoc/org/w3c/dom/views/AbstractView.html?is-external=true" title="class or interface in org.w3c.dom.views">AbstractView</A> viewArg, |
| int detailArg, |
| int screenXArg, |
| int screenYArg, |
| int clientXArg, |
| int clientYArg, |
| boolean ctrlKeyArg, |
| boolean altKeyArg, |
| boolean shiftKeyArg, |
| boolean metaKeyArg, |
| short buttonArg, |
| <A HREF="../../../../org/w3c/dom/events/EventTarget.html" title="interface in org.w3c.dom.events">EventTarget</A> relatedTargetArg)</PRE> |
| <DL> |
| <DD>The <code>initMouseEvent</code> method is used to initialize the value |
| of a <code>MouseEvent</code> object and has the same behavior as |
| <code>UIEvent.initUIEvent()</code>. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>typeArg</CODE> - Refer to the <code>UIEvent.initUIEvent()</code> method |
| for a description of this parameter.<DD><CODE>canBubbleArg</CODE> - Refer to the <code>UIEvent.initUIEvent()</code> |
| method for a description of this parameter.<DD><CODE>cancelableArg</CODE> - Refer to the <code>UIEvent.initUIEvent()</code> |
| method for a description of this parameter.<DD><CODE>viewArg</CODE> - Refer to the <code>UIEvent.initUIEvent()</code> method |
| for a description of this parameter.<DD><CODE>detailArg</CODE> - Refer to the <code>UIEvent.initUIEvent()</code> |
| method for a description of this parameter.<DD><CODE>screenXArg</CODE> - Specifies <code>MouseEvent.screenX</code>.<DD><CODE>screenYArg</CODE> - Specifies <code>MouseEvent.screenY</code>.<DD><CODE>clientXArg</CODE> - Specifies <code>MouseEvent.clientX</code>.<DD><CODE>clientYArg</CODE> - Specifies <code>MouseEvent.clientY</code>.<DD><CODE>ctrlKeyArg</CODE> - Specifies <code>MouseEvent.ctrlKey</code>.<DD><CODE>altKeyArg</CODE> - Specifies <code>MouseEvent.altKey</code>.<DD><CODE>shiftKeyArg</CODE> - Specifies <code>MouseEvent.shiftKey</code>.<DD><CODE>metaKeyArg</CODE> - Specifies <code>MouseEvent.metaKey</code>.<DD><CODE>buttonArg</CODE> - Specifies <code>MouseEvent.button</code>.<DD><CODE>relatedTargetArg</CODE> - Specifies |
| <code>MouseEvent.relatedTarget</code>. This value may be |
| <code>null</code>.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getModifierState(java.lang.String)"><!-- --></A><H3> |
| getModifierState</H3> |
| <PRE> |
| boolean <B>getModifierState</B>(<A HREF="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> keyIdentifierArg)</PRE> |
| <DL> |
| <DD>This methods queries the state of a modifier using a key identifier. |
| See also . |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>keyIdentifierArg</CODE> - A modifier key identifier, as defined by the |
| <code>KeyboardEvent.keyIdentifier</code> attribute. Common modifier |
| keys are <code>"Alt"</code>, <code>"AltGraph"</code>, |
| <code>"CapsLock"</code>, <code>"Control"</code>, <code>"Meta"</code> |
| , <code>"NumLock"</code>, <code>"Scroll"</code>, or |
| <code>"Shift"</code>. |
| <p ><b>Note:</b> If an application wishes to distinguish between |
| right and left modifiers, this information could be deduced using |
| keyboard events and <code>KeyboardEvent.keyLocation</code>. |
| <DT><B>Returns:</B><DD><code>true</code> if it is modifier key and the modifier is |
| activated, <code>false</code> otherwise.<DT><B>Since:</B></DT> |
| <DD>DOM Level 3</DD> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="initMouseEventNS(java.lang.String, java.lang.String, boolean, boolean, org.w3c.dom.views.AbstractView, int, int, int, int, int, short, org.w3c.dom.events.EventTarget, java.lang.String)"><!-- --></A><H3> |
| initMouseEventNS</H3> |
| <PRE> |
| void <B>initMouseEventNS</B>(<A HREF="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> namespaceURI, |
| <A HREF="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> typeArg, |
| boolean canBubbleArg, |
| boolean cancelableArg, |
| <A HREF="http://www.w3.org/2003/01/dom2-javadoc/org/w3c/dom/views/AbstractView.html?is-external=true" title="class or interface in org.w3c.dom.views">AbstractView</A> viewArg, |
| int detailArg, |
| int screenXArg, |
| int screenYArg, |
| int clientXArg, |
| int clientYArg, |
| short buttonArg, |
| <A HREF="../../../../org/w3c/dom/events/EventTarget.html" title="interface in org.w3c.dom.events">EventTarget</A> relatedTargetArg, |
| <A HREF="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> modifiersList)</PRE> |
| <DL> |
| <DD>The <code>initMouseEventNS</code> method is used to initialize the |
| value of a <code>MouseEvent</code> object and has the same behavior |
| as <code>UIEvent.initUIEventNS()</code>. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>namespaceURI</CODE> - Refer to the <code>UIEvent.initUIEventNS()</code> |
| method for a description of this parameter.<DD><CODE>typeArg</CODE> - Refer to the <code>UIEvent.initUIEventNS()</code> |
| method for a description of this parameter.<DD><CODE>canBubbleArg</CODE> - Refer to the <code>UIEvent.initUIEventNS()</code> |
| method for a description of this parameter.<DD><CODE>cancelableArg</CODE> - Refer to the <code>UIEvent.initUIEventNS()</code> |
| method for a description of this parameter.<DD><CODE>viewArg</CODE> - Refer to the <code>UIEvent.initUIEventNS()</code> |
| method for a description of this parameter.<DD><CODE>detailArg</CODE> - Refer to the <code>UIEvent.initUIEventNS()</code> |
| method for a description of this parameter.<DD><CODE>screenXArg</CODE> - Refer to the |
| <code>MouseEvent.initMouseEvent()</code> method for a description |
| of this parameter.<DD><CODE>screenYArg</CODE> - Refer to the |
| <code>MouseEvent.initMouseEvent()</code> method for a description |
| of this parameter.<DD><CODE>clientXArg</CODE> - Refer to the |
| <code>MouseEvent.initMouseEvent()</code> method for a description |
| of this parameter.<DD><CODE>clientYArg</CODE> - Refer to the |
| <code>MouseEvent.initMouseEvent()</code> method for a description |
| of this parameter.<DD><CODE>buttonArg</CODE> - Refer to the <code>MouseEvent.initMouseEvent()</code> |
| method for a description of this parameter.<DD><CODE>relatedTargetArg</CODE> - Refer to the |
| <code>MouseEvent.initMouseEvent()</code> method for a description |
| of this parameter.<DD><CODE>modifiersList</CODE> - A <a href='http://www.w3.org/TR/2004/REC-xml-20040204/#NT-S'>white space</a> separated list of modifier key identifiers to be activated on this |
| object. As an example, <code>"Control Alt"</code> will activated |
| the control and alt modifiers.<DT><B>Since:</B></DT> |
| <DD>DOM Level 3</DD> |
| </DL> |
| </DD> |
| </DL> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <HR> |
| |
| |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <A NAME="navbar_bottom"><!-- --></A> |
| <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A> |
| <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> |
| <TR> |
| <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> |
| <A NAME="navbar_bottom_firstrow"><!-- --></A> |
| <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> |
| <TR ALIGN="center" VALIGN="top"> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> |
| <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/MouseEvent.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> |
| </TR> |
| </TABLE> |
| </TD> |
| <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> |
| </EM> |
| </TD> |
| </TR> |
| |
| <TR> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../org/w3c/dom/events/KeyboardEvent.html" title="interface in org.w3c.dom.events"><B>PREV CLASS</B></A> |
| <A HREF="../../../../org/w3c/dom/events/MutationEvent.html" title="interface in org.w3c.dom.events"><B>NEXT CLASS</B></A></FONT></TD> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../index.html?org/w3c/dom/events/MouseEvent.html" target="_top"><B>FRAMES</B></A> |
| <A HREF="MouseEvent.html" target="_top"><B>NO FRAMES</B></A> |
| <SCRIPT type="text/javascript"> |
| <!-- |
| if(window==top) { |
| document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>'); |
| } |
| //--> |
| </SCRIPT> |
| <NOSCRIPT> |
| <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A> |
| </NOSCRIPT> |
| |
| |
| </FONT></TD> |
| </TR> |
| <TR> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| SUMMARY: NESTED | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD> |
| </TR> |
| </TABLE> |
| <A NAME="skip-navbar_bottom"></A> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| |
| <HR> |
| Copyright © 2017 <a href='http://www.apache.org/'>Apache Software Foundation</a>. All Rights Reserved. |
| </BODY> |
| </HTML> |
