webgui/www/extras/yui-ext/docs/YAHOO.ext.EventManager.html
JT Smith 4f68a0933c added YUI and YUI-ext
fixed the resizable text area with IE problem
fixed the ad space with IE problem
merged the 7.2.0 and 7.1.4 change logs
2006-11-07 23:15:57 +00:00

412 lines
10 KiB
HTML

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN""http://www.w3.org/TR/REC-html40/loose.dtd">
<!--NewPage-->
<HTML>
<HEAD>
<TITLE>
YAHOO.ext.EventManager
</TITLE>
<LINK REL ="stylesheet" TYPE="text/css" HREF="stylesheet.css" TITLE="Style">
</HEAD>
<SCRIPT>
function asd()
{
parent.document.title="YAHOO.ext.EventManager";
}
</SCRIPT>
<BODY BGCOLOR="white" onload="asd();" style="margin:15px;">
<!-- ======== START OF CLASS DATA ======== -->
<H2>Class YAHOO.ext.EventManager</H2>
<PRE>Object
|
+--<b>YAHOO.ext.EventManager</b>
</PRE>
<HR>
<DL>
<!-- Class definition -->
<DT>class
<B>YAHOO.ext.EventManager</B>
</DL>
<HR>
<!-- ======== NESTED CLASS SUMMARY ======== -->
<!-- ======== END NESTED CLASS SUMMARY ======== -->
<!-- =========== FIELD SUMMARY =========== -->
<A NAME="field_summary"><!-- --></A>
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TD COLSPAN="2" class="title-cell">Field Summary</TD></TR>
<!-- This is one instance field summary -->
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;Object</CODE></FONT></TD>
<TD><CODE><B><A HREF="#ieDeferSrc">ieDeferSrc</A></B></CODE>
<BR>
&nbsp;&nbsp;</TD>
</TR>
</TABLE>
&nbsp;
<!-- =========== END FIELD SUMMARY =========== -->
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<!-- ======== END CONSTRUCTOR SUMMARY ======== -->
&nbsp;
<!-- ========== METHOD SUMMARY =========== -->
<A NAME="method_summary"><!-- --></A>
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TD COLSPAN="2" class="title-cell">
<span style="float:left">Method Summary</span>
<span style="float:right;font-weight:normal;font-size:8pt;">
<i>* Parameter types in italic indicate optional parameters</i>
</span>
</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<FONT SIZE="-1">
<CODE>&nbsp;<a href="Function.html">Function</a></CODE>
</FONT>
</TD>
<TD>
<CODE>
<B>
<A HREF="#addListener">addListener</A></B>(&lt;Object&gt; element, &lt;String&gt; eventName, &lt;<a href="Function.html">Function</a>&gt; fn, &lt;Object&gt; scope, &lt;boolean&gt; override)
</CODE>
<BR>
&nbsp;&nbsp;
Appends an event handler
</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<FONT SIZE="-1">
<CODE>&nbsp;<a href="Function.html">Function</a></CODE>
</FONT>
</TD>
<TD>
<CODE>
<B>
<A HREF="#on">on</A></B>(&lt;Object&gt; element, &lt;String&gt; eventName, &lt;<a href="Function.html">Function</a>&gt; fn, &lt;Object&gt; scope, &lt;boolean&gt; override)
</CODE>
<BR>
&nbsp;&nbsp;
Appends an event handler (shorthand for addListener)
</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="#onDocumentReady">onDocumentReady</A></B>(fn, scope, override)
</CODE>
<BR>
&nbsp;&nbsp;
Fires when the document is ready (before onload)
</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="#removeListener">removeListener</A></B>(&lt;Object&gt; element, &lt;String&gt; eventName, &lt;<a href="Function.html">Function</a>&gt; wrappedFn)
</CODE>
<BR>
&nbsp;&nbsp;
Removes an event handler
</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<FONT SIZE="-1">
<CODE>&nbsp;Object</CODE>
</FONT>
</TD>
<TD>
<CODE>
<B>
<A HREF="#wrap">wrap</A></B>(fn, scope, override)
</CODE>
<BR>
&nbsp;&nbsp;
Places a simple wrapper around an event handler to override the browser event
object with a YAHOO.ext.EventObject
</TD>
</TR>
</TABLE>
<P>
<!-- ========== END METHOD SUMMARY =========== -->
<!-- ============ FIELD DETAIL START =========== -->
<A NAME="field_detail"><!-- --></A>
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TD COLSPAN="1" class="title-cell">Field Detail</TD>
</TR>
</TABLE>
<A NAME="ieDeferSrc"><!-- --></A>
<H3>ieDeferSrc</H3>
<PRE>Object&nbsp;<B>ieDeferSrc</B></PRE>
<UL>
</UL>
<HR>
<!-- ============ FIELD DETAIL END =========== -->
<!-- ========= CONSTRUCTOR DETAIL START ======== -->
<!-- Constructor return value(s) -->
<!-- End constructor return value(s) -->
<!-- ADDITIONAL ATTRIBUTES -->
<HR/>
<!-- END ADDITIONAL ATTRIBUTES -->
<!-- ========= CONSTRUCTOR DETAIL END ======== -->
<!-- ============ METHOD DETAIL START ========== -->
<A NAME="method_detail"><!-- --></A>
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TD COLSPAN="1" class="title-cell">
Method Detail
</TD>
</TR>
</TABLE>
<!-- One single method detail entry -->
<A NAME="addListener"><!-- --></A>
<H3>addListener</H3>
<PRE><a href="Function.html">Function</a> <B>addListener</B>(&lt;Object&gt; element, &lt;String&gt; eventName, &lt;<a href="Function.html">Function</a>&gt; fn, &lt;Object&gt; scope, &lt;boolean&gt; override)</PRE>
<UL>Appends an event handler</UL>
<!-- METHOD PARAMETERS START -->
<UL>
<B>Parameters:</B>
<UL><CODE>element</CODE> - The html element to assign the event to
</UL>
<UL><CODE>eventName</CODE> - The type of event to append
</UL>
<UL><CODE>fn</CODE> - The method the event invokes
</UL>
<UL><CODE>scope</CODE> - An arbitrary object that will be passed as a parameter to the handler
</UL>
<UL><CODE>override</CODE> - If true, the obj passed in becomes the execution scope of the listener
</UL>
</UL>
<!-- METHOD PARAMETERS END -->
<UL>
<B>Returns:</B>
<UL>
The wrapper function created (to be used to remove the listener if necessary)
</UL>
</UL>
<!-- ADDITIONAL ATTRIBUTES START -->
<!-- ADDITIONAL ATTRIBUTES END -->
<HR>
<A NAME="on"><!-- --></A>
<H3>on</H3>
<PRE><a href="Function.html">Function</a> <B>on</B>(&lt;Object&gt; element, &lt;String&gt; eventName, &lt;<a href="Function.html">Function</a>&gt; fn, &lt;Object&gt; scope, &lt;boolean&gt; override)</PRE>
<UL>Appends an event handler (shorthand for addListener)</UL>
<!-- METHOD PARAMETERS START -->
<UL>
<B>Parameters:</B>
<UL><CODE>element</CODE> - The html element to assign the event to
</UL>
<UL><CODE>eventName</CODE> - The type of event to append
</UL>
<UL><CODE>fn</CODE> - The method the event invokes
</UL>
<UL><CODE>scope</CODE> - An arbitrary object that will be passed as a parameter to the handler
</UL>
<UL><CODE>override</CODE> - If true, the obj passed in becomes the execution scope of the listener
</UL>
</UL>
<!-- METHOD PARAMETERS END -->
<UL>
<B>Returns:</B>
<UL>
The wrapper function created (to be used to remove the listener if necessary)
</UL>
</UL>
<!-- ADDITIONAL ATTRIBUTES START -->
<!-- ADDITIONAL ATTRIBUTES END -->
<HR>
<A NAME="onDocumentReady"><!-- --></A>
<H3>onDocumentReady</H3>
<PRE>void <B>onDocumentReady</B>(fn, scope, override)</PRE>
<UL>Fires when the document is ready (before onload)</UL>
<!-- METHOD PARAMETERS START -->
<!-- METHOD PARAMETERS END -->
<!-- ADDITIONAL ATTRIBUTES START -->
<!-- ADDITIONAL ATTRIBUTES END -->
<HR>
<A NAME="removeListener"><!-- --></A>
<H3>removeListener</H3>
<PRE>Boolean <B>removeListener</B>(&lt;Object&gt; element, &lt;String&gt; eventName, &lt;<a href="Function.html">Function</a>&gt; wrappedFn)</PRE>
<UL>Removes an event handler</UL>
<!-- METHOD PARAMETERS START -->
<UL>
<B>Parameters:</B>
<UL><CODE>element</CODE> - The html element to remove the event from
</UL>
<UL><CODE>eventName</CODE> - The type of event to append
</UL>
<UL><CODE>wrappedFn</CODE> - The wrapper method returned when adding the listener
</UL>
</UL>
<!-- METHOD PARAMETERS END -->
<UL>
<B>Returns:</B>
<UL>
True if a listener was actually removed
</UL>
</UL>
<!-- ADDITIONAL ATTRIBUTES START -->
<!-- ADDITIONAL ATTRIBUTES END -->
<HR>
<A NAME="wrap"><!-- --></A>
<H3>wrap</H3>
<PRE>Object <B>wrap</B>(fn, scope, override)</PRE>
<UL>Places a simple wrapper around an event handler to override the browser event
object with a YAHOO.ext.EventObject</UL>
<!-- METHOD PARAMETERS START -->
<!-- METHOD PARAMETERS END -->
<!-- ADDITIONAL ATTRIBUTES START -->
<!-- ADDITIONAL ATTRIBUTES END -->
<HR>
<!-- ============ METHOD DETAIL END ========== -->
<!-- ========= END OF CLASS DATA ========= -->
<HR>
<FONT SIZE="-1">
</FONT>
<div class="jsdoc_ctime">Documentation generated by <a href="http://jsdoc.sourceforge.net/" target="_parent">JSDoc</a> on Sat Oct 14 06:07:10 2006</div>
</BODY>
</HTML>