blob: 57dc47c442e3faff726de4f01716385e42f62fdc [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!--NewPage-->
<HTML>
<HEAD>
<TITLE>
Event (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="Event (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>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/Event.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="../../../../org/w3c/dom/events/DocumentEvent.html" title="interface in org.w3c.dom.events"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="../../../../org/w3c/dom/events/EventException.html" title="class 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/Event.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="Event.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
&nbsp;<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:&nbsp;NESTED&nbsp;|&nbsp;<A HREF="#field_summary">FIELD</A>&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;<A HREF="#field_detail">FIELD</A>&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<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 Event</H2>
<DL>
<DT><B>All Known Subinterfaces:</B> <DD><A HREF="../../../../org/w3c/dom/events/CustomEvent.html" title="interface in org.w3c.dom.events">CustomEvent</A>, <A HREF="../../../../org/w3c/dom/events/KeyboardEvent.html" title="interface in org.w3c.dom.events">KeyboardEvent</A>, <A HREF="../../../../org/w3c/dom/events/MouseEvent.html" title="interface in org.w3c.dom.events">MouseEvent</A>, <A HREF="../../../../org/w3c/dom/events/MutationEvent.html" title="interface in org.w3c.dom.events">MutationEvent</A>, <A HREF="../../../../org/w3c/dom/events/MutationNameEvent.html" title="interface in org.w3c.dom.events">MutationNameEvent</A>, <A HREF="../../../../org/apache/batik/dom/xbl/ShadowTreeEvent.html" title="interface in org.apache.batik.dom.xbl">ShadowTreeEvent</A>, <A HREF="../../../../org/w3c/dom/events/TextEvent.html" title="interface in org.w3c.dom.events">TextEvent</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/AbstractEvent.html" title="class in org.apache.batik.dom.events">AbstractEvent</A>, <A HREF="../../../../org/apache/batik/dom/events/DOMCustomEvent.html" title="class in org.apache.batik.dom.events">DOMCustomEvent</A>, <A HREF="../../../../org/apache/batik/dom/events/DOMEvent.html" title="class in org.apache.batik.dom.events">DOMEvent</A>, <A HREF="../../../../org/apache/batik/dom/events/DOMKeyboardEvent.html" title="class in org.apache.batik.dom.events">DOMKeyboardEvent</A>, <A HREF="../../../../org/apache/batik/dom/events/DOMKeyEvent.html" title="class in org.apache.batik.dom.events">DOMKeyEvent</A>, <A HREF="../../../../org/apache/batik/dom/events/DOMMouseEvent.html" title="class in org.apache.batik.dom.events">DOMMouseEvent</A>, <A HREF="../../../../org/apache/batik/dom/events/DOMMutationEvent.html" title="class in org.apache.batik.dom.events">DOMMutationEvent</A>, <A HREF="../../../../org/apache/batik/dom/events/DOMMutationNameEvent.html" title="class in org.apache.batik.dom.events">DOMMutationNameEvent</A>, <A HREF="../../../../org/apache/batik/dom/events/DOMTextEvent.html" title="class in org.apache.batik.dom.events">DOMTextEvent</A>, <A HREF="../../../../org/apache/batik/dom/events/DOMTimeEvent.html" title="class in org.apache.batik.dom.events">DOMTimeEvent</A>, <A HREF="../../../../org/apache/batik/dom/events/DOMUIEvent.html" title="class in org.apache.batik.dom.events">DOMUIEvent</A>, <A HREF="../../../../org/apache/batik/dom/svg/SVGOMEvent.html" title="class in org.apache.batik.dom.svg">SVGOMEvent</A>, <A HREF="../../../../org/apache/batik/dom/svg12/SVGOMWheelEvent.html" title="class in org.apache.batik.dom.svg12">SVGOMWheelEvent</A>, <A HREF="../../../../org/apache/batik/dom/svg12/XBLOMShadowTreeEvent.html" title="class in org.apache.batik.dom.svg12">XBLOMShadowTreeEvent</A></DD>
</DL>
<HR>
<DL>
<DT><PRE>public interface <B>Event</B></DL>
</PRE>
<P>
The <code>Event</code> interface is used to provide contextual information
about an event to the listener processing the event. An object which
implements the <code>Event</code> interface is passed as the parameter to
an <code>EventListener</code>. More specific context information is
passed to event listeners by deriving additional interfaces from
<code>Event</code> which contain information directly relating to the
type of event they represent. These derived interfaces are also
implemented by the object passed to the event listener.
<p> To create an instance of the <code>Event</code> interface, use the
<code>DocumentEvent.createEvent("Event")</code> method call.
<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>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;short</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/w3c/dom/events/Event.html#AT_TARGET">AT_TARGET</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The current event is in the target phase, i.e.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;short</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/w3c/dom/events/Event.html#BUBBLING_PHASE">BUBBLING_PHASE</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The current event phase is the bubbling phase.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;short</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/w3c/dom/events/Event.html#CAPTURING_PHASE">CAPTURING_PHASE</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The current event phase is the capture phase.</TD>
</TR>
</TABLE>
&nbsp;
<!-- ========== 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>&nbsp;boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/w3c/dom/events/Event.html#getBubbles()">getBubbles</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Used to indicate whether or not an event is a bubbling event.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/w3c/dom/events/Event.html#getCancelable()">getCancelable</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Used to indicate whether or not an event can have its default action
prevented (see also ).</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;<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/Event.html#getCurrentTarget()">getCurrentTarget</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Used to indicate the <code>EventTarget</code> whose
<code>EventListeners</code> are currently being processed.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/w3c/dom/events/Event.html#getDefaultPrevented()">getDefaultPrevented</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Used to indicate whether <code>Event.preventDefault()</code> has been
called for this event.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;short</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/w3c/dom/events/Event.html#getEventPhase()">getEventPhase</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Used to indicate which phase of event flow is currently being
accomplished.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;<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></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/w3c/dom/events/Event.html#getNamespaceURI()">getNamespaceURI</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The namespace URI associated with this event at creation time, or
<code>null</code> if it is unspecified.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;<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/Event.html#getTarget()">getTarget</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Used to indicate the event target.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;long</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/w3c/dom/events/Event.html#getTimeStamp()">getTimeStamp</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Used to specify the time at which the event was created in
milliseconds relative to 1970-01-01T00:00:00Z.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;<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></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/w3c/dom/events/Event.html#getType()">getType</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The local name of the event type.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/w3c/dom/events/Event.html#initEvent(java.lang.String, boolean, boolean)">initEvent</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>&nbsp;eventTypeArg,
boolean&nbsp;canBubbleArg,
boolean&nbsp;cancelableArg)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The <code>initEvent</code> method is used to initialize the value of
an <code>Event</code> created through the
<code>DocumentEvent.createEvent</code> method.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/w3c/dom/events/Event.html#initEventNS(java.lang.String, java.lang.String, boolean, boolean)">initEventNS</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>&nbsp;namespaceURIArg,
<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>&nbsp;eventTypeArg,
boolean&nbsp;canBubbleArg,
boolean&nbsp;cancelableArg)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The <code>initEventNS</code> method is used to initialize the value of
an <code>Event</code> object and has the same behavior as
<code>Event.initEvent()</code>.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/w3c/dom/events/Event.html#preventDefault()">preventDefault</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;If an event is cancelable, the <code>preventDefault</code> method is
used to signify that the event is to be canceled, meaning any default
action normally taken by the implementation as a result of the event
will not occur (see also ), and thus independently of event groups.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/w3c/dom/events/Event.html#stopImmediatePropagation()">stopImmediatePropagation</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;This method is used to prevent event listeners of the same group to be
triggered and, unlike <code>Event.stopPropagation()</code> its effect
is immediate (see ).</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/w3c/dom/events/Event.html#stopPropagation()">stopPropagation</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;This method is used to prevent event listeners of the same group to be
triggered but its effect is deferred until all event listeners
attached on the <code>Event.currentTarget</code> have been triggered
(see ).</TD>
</TR>
</TABLE>
&nbsp;
<P>
<!-- ============ FIELD DETAIL =========== -->
<A NAME="field_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>Field Detail</B></FONT></TH>
</TR>
</TABLE>
<A NAME="CAPTURING_PHASE"><!-- --></A><H3>
CAPTURING_PHASE</H3>
<PRE>
static final short <B>CAPTURING_PHASE</B></PRE>
<DL>
<DD>The current event phase is the capture phase.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.w3c.dom.events.Event.CAPTURING_PHASE">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="AT_TARGET"><!-- --></A><H3>
AT_TARGET</H3>
<PRE>
static final short <B>AT_TARGET</B></PRE>
<DL>
<DD>The current event is in the target phase, i.e. it is being evaluated
at the event target.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.w3c.dom.events.Event.AT_TARGET">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="BUBBLING_PHASE"><!-- --></A><H3>
BUBBLING_PHASE</H3>
<PRE>
static final short <B>BUBBLING_PHASE</B></PRE>
<DL>
<DD>The current event phase is the bubbling phase.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.w3c.dom.events.Event.BUBBLING_PHASE">Constant Field Values</A></DL>
</DL>
<!-- ============ 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="getType()"><!-- --></A><H3>
getType</H3>
<PRE>
<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> <B>getType</B>()</PRE>
<DL>
<DD>The local name of the event type. The name must be an <a href='http://www.w3.org/TR/2004/REC-xml-names11-20040204/#NT-NCName'>NCName</a> as defined in [<a href='http://www.w3.org/TR/2004/REC-xml-names11-20040204/'>XML Namespaces 1.1</a>]
and is case-sensitive.
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="getTarget()"><!-- --></A><H3>
getTarget</H3>
<PRE>
<A HREF="../../../../org/w3c/dom/events/EventTarget.html" title="interface in org.w3c.dom.events">EventTarget</A> <B>getTarget</B>()</PRE>
<DL>
<DD>Used to indicate the event target. This attribute contains the target
node when used with the .
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="getCurrentTarget()"><!-- --></A><H3>
getCurrentTarget</H3>
<PRE>
<A HREF="../../../../org/w3c/dom/events/EventTarget.html" title="interface in org.w3c.dom.events">EventTarget</A> <B>getCurrentTarget</B>()</PRE>
<DL>
<DD>Used to indicate the <code>EventTarget</code> whose
<code>EventListeners</code> are currently being processed. This is
particularly useful during the capture and bubbling phases. This
attribute could contain the target node or a target ancestor when
used with the .
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="getEventPhase()"><!-- --></A><H3>
getEventPhase</H3>
<PRE>
short <B>getEventPhase</B>()</PRE>
<DL>
<DD>Used to indicate which phase of event flow is currently being
accomplished.
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="getBubbles()"><!-- --></A><H3>
getBubbles</H3>
<PRE>
boolean <B>getBubbles</B>()</PRE>
<DL>
<DD>Used to indicate whether or not an event is a bubbling event. If the
event can bubble the value is <code>true</code>, otherwise the value
is <code>false</code>.
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="getCancelable()"><!-- --></A><H3>
getCancelable</H3>
<PRE>
boolean <B>getCancelable</B>()</PRE>
<DL>
<DD>Used to indicate whether or not an event can have its default action
prevented (see also ). If the default action can be prevented the
value is <code>true</code>, otherwise the value is <code>false</code>
.
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="getTimeStamp()"><!-- --></A><H3>
getTimeStamp</H3>
<PRE>
long <B>getTimeStamp</B>()</PRE>
<DL>
<DD>Used to specify the time at which the event was created in
milliseconds relative to 1970-01-01T00:00:00Z. Due to the fact that
some systems may not provide this information the value of
<code>timeStamp</code> may be not available for all events. When not
available, the value is <code>0</code>.
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="stopPropagation()"><!-- --></A><H3>
stopPropagation</H3>
<PRE>
void <B>stopPropagation</B>()</PRE>
<DL>
<DD>This method is used to prevent event listeners of the same group to be
triggered but its effect is deferred until all event listeners
attached on the <code>Event.currentTarget</code> have been triggered
(see ). Once it has been called, further calls to that method have no
additional effect.
<p ><b>Note:</b> This method does not prevent the default action from
being invoked; use <code>Event.preventDefault()</code> for that
effect.
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="preventDefault()"><!-- --></A><H3>
preventDefault</H3>
<PRE>
void <B>preventDefault</B>()</PRE>
<DL>
<DD>If an event is cancelable, the <code>preventDefault</code> method is
used to signify that the event is to be canceled, meaning any default
action normally taken by the implementation as a result of the event
will not occur (see also ), and thus independently of event groups.
Calling this method for a non-cancelable event has no effect.
<p ><b>Note:</b> This method does not stop the event propagation; use
<code>Event.stopPropagation()</code> or
<code>Event.stopImmediatePropagation()</code> for that effect.
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="initEvent(java.lang.String, boolean, boolean)"><!-- --></A><H3>
initEvent</H3>
<PRE>
void <B>initEvent</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>&nbsp;eventTypeArg,
boolean&nbsp;canBubbleArg,
boolean&nbsp;cancelableArg)</PRE>
<DL>
<DD>The <code>initEvent</code> method is used to initialize the value of
an <code>Event</code> created through the
<code>DocumentEvent.createEvent</code> method. This method may only
be called before the <code>Event</code> has been dispatched via the
<code>EventTarget.dispatchEvent()</code> method. If the method is
called several times before invoking
<code>EventTarget.dispatchEvent</code>, only the final invocation
takes precedence. This method has no effect if called after the event
has been dispatched. If called from a subclass of the
<code>Event</code> interface only the values specified in this method
are modified, all other attributes are left unchanged.
<br> This method sets the <code>Event.type</code> attribute to
<code>eventTypeArg</code>, and <code>Event.namespaceURI</code> to
<code>null</code>. To initialize an event with a namespace URI, use
the <code>Event.initEventNS()</code> method.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>eventTypeArg</CODE> - Specifies <code>Event.type</code>, the local name
of the event type.<DD><CODE>canBubbleArg</CODE> - Specifies <code>Event.bubbles</code>. This
parameter overrides the intrinsic bubbling behavior of the event.<DD><CODE>cancelableArg</CODE> - Specifies <code>Event.cancelable</code>. This
parameter overrides the intrinsic cancelable behavior of the event.</DL>
</DD>
</DL>
<HR>
<A NAME="getNamespaceURI()"><!-- --></A><H3>
getNamespaceURI</H3>
<PRE>
<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> <B>getNamespaceURI</B>()</PRE>
<DL>
<DD>The namespace URI associated with this event at creation time, or
<code>null</code> if it is unspecified.
<br> For events initialized with a DOM Level 2 Events method, such as
<code>Event.initEvent()</code>, this is always <code>null</code>.
<P>
<DD><DL>
<DT><B>Since:</B></DT>
<DD>DOM Level 3</DD>
</DL>
</DD>
</DL>
<HR>
<A NAME="stopImmediatePropagation()"><!-- --></A><H3>
stopImmediatePropagation</H3>
<PRE>
void <B>stopImmediatePropagation</B>()</PRE>
<DL>
<DD>This method is used to prevent event listeners of the same group to be
triggered and, unlike <code>Event.stopPropagation()</code> its effect
is immediate (see ). Once it has been called, further calls to that
method have no additional effect.
<p ><b>Note:</b> This method does not prevent the default action from
being invoked; use <code>Event.preventDefault()</code> for that
effect.
<P>
<DD><DL>
<DT><B>Since:</B></DT>
<DD>DOM Level 3</DD>
</DL>
</DD>
</DL>
<HR>
<A NAME="getDefaultPrevented()"><!-- --></A><H3>
getDefaultPrevented</H3>
<PRE>
boolean <B>getDefaultPrevented</B>()</PRE>
<DL>
<DD>Used to indicate whether <code>Event.preventDefault()</code> has been
called for this event.
<P>
<DD><DL>
<DT><B>Since:</B></DT>
<DD>DOM Level 3</DD>
</DL>
</DD>
</DL>
<HR>
<A NAME="initEventNS(java.lang.String, java.lang.String, boolean, boolean)"><!-- --></A><H3>
initEventNS</H3>
<PRE>
void <B>initEventNS</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>&nbsp;namespaceURIArg,
<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>&nbsp;eventTypeArg,
boolean&nbsp;canBubbleArg,
boolean&nbsp;cancelableArg)</PRE>
<DL>
<DD>The <code>initEventNS</code> method is used to initialize the value of
an <code>Event</code> object and has the same behavior as
<code>Event.initEvent()</code>.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>namespaceURIArg</CODE> - Specifies <code>Event.namespaceURI</code>, the
namespace URI associated with this event, or <code>null</code> if
no namespace.<DD><CODE>eventTypeArg</CODE> - Refer to the <code>Event.initEvent()</code>
method for a description of this parameter.<DD><CODE>canBubbleArg</CODE> - Refer to the <code>Event.initEvent()</code>
method for a description of this parameter.<DD><CODE>cancelableArg</CODE> - Refer to the <code>Event.initEvent()</code>
method for a description of this parameter.<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>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/Event.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="../../../../org/w3c/dom/events/DocumentEvent.html" title="interface in org.w3c.dom.events"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="../../../../org/w3c/dom/events/EventException.html" title="class 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/Event.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="Event.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
&nbsp;<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:&nbsp;NESTED&nbsp;|&nbsp;<A HREF="#field_summary">FIELD</A>&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;<A HREF="#field_detail">FIELD</A>&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<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>