[ Mini Kiebo ]
Server: Windows NT DESKTOP-5B8S0D4 6.2 build 9200 (Windows 8 Professional Edition) i586
Path:
D:
/
xampp182
/
htdocs
/
simpeg
/
zapatec
/
zpcal
/
utils
/
jsdocs
/
Zapatec
/
[
Home
]
File: EventDriven.html
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN""http://www.w3.org/TR/REC-html40/loose.dtd"> <!--NewPage--> <HTML> <HEAD> <TITLE> Zapatec.EventDriven </TITLE> <LINK REL ="stylesheet" TYPE="text/css" HREF="../stylesheet.css" TITLE="Style"> </HEAD> <SCRIPT> function asd() { parent.document.title="Zapatec.EventDriven"; } </SCRIPT> <BODY BGCOLOR="white" onload="asd();"> <!-- ========== START OF NAVBAR ========== --> <A NAME="navbar_bottom"><!-- --></A> <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0"> <TR> <TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A NAME="navbar_bottom_firstrow"><!-- --></A> <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3"> <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="../overview-summary-zpeventdriven.js.html"><FONT CLASS="NavBarFont1"><B>File</B></FONT></A> </TD> <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../overview-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> <!--TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"--> <!--A HREF="deprecated-list.html"--><!--FONT CLASS="NavBarFont1">Deprecated</FONT--><!--/A--><!-- </TD--> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../index-all.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> <B>Zapatec Utils</B> </EM> </TD </TR> <TR> <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> <A HREF="../Zapatec/EditInline.html"><B>PREV CLASS</B></A><!-- NEXT CLASS --> <A HREF="../Zapatec/ImagePreloader.html"><B>NEXT CLASS</B></A></FONT></TD> <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> <A HREF="../index.html" TARGET="_top"><B>FRAMES</B></A> <A HREF="" TARGET="_top"><B>NO FRAMES</B></A> <SCRIPT> <!-- if(window==top) { document.writeln('<A HREF="../allclasses-noframe.html" TARGET=""><B>All Classes</B></A>'); } //--> </SCRIPT> <NOSCRIPT> <A HREF="../allclasses-noframe.html" TARGET=""><B>All Classes</B></A> </NOSCRIPT> </FONT></TD> </TR> <TR> <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> SUMMARY: <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> </TR> </TABLE> <!-- =========== END OF NAVBAR =========== --> <HR> <!-- ======== START OF CLASS DATA ======== --> <H2>Class Zapatec.EventDriven</H2> <PRE>Object | +--<b>Zapatec.EventDriven</b> </PRE> <DL> <DT> <B>Direct Known Subclasses:</B> <DD> <a href='../Zapatec/Widget.html'>Zapatec.Widget</a> </DD> </DL> <HR> <DL> <!-- Class definition --> <DT>class <B>Zapatec.EventDriven</B> </DL> <P> <I>Defined in <a href='../overview-summary-zpeventdriven.js.html'>zpeventdriven.js</a></I><BR/><BR/> </P> <HR> <!-- ======== NESTED CLASS SUMMARY ======== --> <!-- ======== END NESTED CLASS SUMMARY ======== --> <!-- =========== FIELD SUMMARY =========== --> <!-- =========== END FIELD SUMMARY =========== --> <!-- ======== CONSTRUCTOR SUMMARY ======== --> <A NAME="constructor_summary"><!-- --></A> <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%"> <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> <TD COLSPAN=2><FONT SIZE="+2"> <B>Constructor Summary</B></FONT></TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD> <CODE> <B> <A HREF="#Zapatec.EventDriven()">Zapatec.EventDriven</A></B>() </CODE> <BR> Base event-driven class. </TD> </TR> </TABLE> <!-- ======== END CONSTRUCTOR SUMMARY ======== --> <!-- ========== METHOD SUMMARY =========== --> <A NAME="method_summary"><!-- --></A> <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%"> <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> <TD COLSPAN=2><FONT SIZE="+2"> <B>Method Summary</B></FONT></TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"> <FONT SIZE="-1"> <CODE> <a href="../Object.html">Object</a></CODE> </FONT> </TD> <TD> <CODE> <B> <A HREF="#addEventListener">addEventListener</A></B>(<string> sEv, <function> fLsnr) </CODE> <BR> Adds event listener to the end of list. </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="#fireEvent">fireEvent</A></B>(<string> sEv) </CODE> <BR> Fires event. </TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"> <FONT SIZE="-1"> <CODE> object</CODE> </FONT> </TD> <TD> <CODE> <B> <A HREF="#getEventListeners">getEventListeners</A></B>(<string> sEv) </CODE> <BR> Returns array of listeners for the specified event. </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="#isEvent">isEvent</A></B>(<string> sEv) </CODE> <BR> Checks if the event exists. </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="#isEventListener">isEventListener</A></B>(<string> sEv, <function> fLsnr) </CODE> <BR> Checks if the event listener is attached to the event. </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="#removeEvent">removeEvent</A></B>(<string> sEv) </CODE> <BR> Removes all listeners for the event. </TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"> <FONT SIZE="-1"> <CODE> number</CODE> </FONT> </TD> <TD> <CODE> <B> <A HREF="#removeEventListener">removeEventListener</A></B>(<string> sEv, <function> fLsnr) </CODE> <BR> Removes event listener. </TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"> <FONT SIZE="-1"> <CODE> <a href="../Object.html">Object</a></CODE> </FONT> </TD> <TD> <CODE> <B> <A HREF="#unshiftEventListener">unshiftEventListener</A></B>(<string> sEv, <function> fLsnr) </CODE> <BR> Adds event listener to the beginning of list. </TD> </TR> </TABLE> <P> <!-- ========== END METHOD SUMMARY =========== --> <!-- ============ FIELD DETAIL START =========== --> <!-- ============ FIELD DETAIL END =========== --> <!-- ========= CONSTRUCTOR DETAIL START ======== --> <A NAME="constructor_detail"><!-- --></A> <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%"> <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> <TD COLSPAN=1> <FONT SIZE="+2"><B>Constructor Detail</B></FONT> </TD> </TR> </TABLE> <A NAME="Zapatec.EventDriven()"><!-- --></A><H3> Zapatec.EventDriven</H3> <PRE><B>Zapatec.EventDriven</B>()</PRE> <UL> Base event-driven class. </UL> </UL> <!-- 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><FONT SIZE="+2"> <B>Method Detail</B></FONT> </TD> </TR> </TABLE> <!-- One single method detail entry --> <A NAME="addEventListener"><!-- --></A> <H3>addEventListener</H3> <PRE><a href="../Object.html">Object</a> <B>addEventListener</B>(<string> sEv, <function> fLsnr)</PRE> <UL>Adds event listener to the end of list. <pre> If multiple identical event listeners are registered on the same event, the duplicate instances are discarded. They do not cause the event listener to be called twice, and since the duplicates are discarded, they do not need to be removed manually with the removeEventListener method. Synopsis: oEventDriven.addEventListener('eventName', fEventListener); There is also static method doing the same with global events: Zapatec.EventDriven.addEventListener('globalEventName', fEventListener); </pre></UL> <!-- METHOD PARAMETERS START --> <UL> <B>Parameters:</B> <UL><CODE>sEv</CODE> - Event name </UL> <UL><CODE>fLsnr</CODE> - Event listener </UL> </UL> <!-- METHOD PARAMETERS END --> <!-- ADDITIONAL ATTRIBUTES START --> <!-- ADDITIONAL ATTRIBUTES END --> <HR> <A NAME="fireEvent"><!-- --></A> <H3>fireEvent</H3> <PRE>void <B>fireEvent</B>(<string> sEv)</PRE> <UL>Fires event. Takes in one mandatory argument sEv and optionally any number of other arguments that should be passed to the listeners. <pre> Synopsis: oEventDriven.fireEvent('eventName'); There is also static method doing the same with global events: Zapatec.EventDriven.fireEvent('globalEventName'); </pre></UL> <!-- METHOD PARAMETERS START --> <UL> <B>Parameters:</B> <UL><CODE>sEv</CODE> - Event name </UL> </UL> <!-- METHOD PARAMETERS END --> <!-- ADDITIONAL ATTRIBUTES START --> <!-- ADDITIONAL ATTRIBUTES END --> <HR> <A NAME="getEventListeners"><!-- --></A> <H3>getEventListeners</H3> <PRE>object <B>getEventListeners</B>(<string> sEv)</PRE> <UL>Returns array of listeners for the specified event. <pre> Synopsis: oEventDriven.getEventListeners('eventName'); There is also static method doing the same with global events: Zapatec.EventDriven.getEventListeners('globalEventName'); </pre></UL> <!-- METHOD PARAMETERS START --> <UL> <B>Parameters:</B> <UL><CODE>sEv</CODE> - Event name </UL> </UL> <!-- METHOD PARAMETERS END --> <UL> <B>Returns:</B> <UL> Array of function references </UL> </UL> <!-- ADDITIONAL ATTRIBUTES START --> <!-- ADDITIONAL ATTRIBUTES END --> <HR> <A NAME="isEvent"><!-- --></A> <H3>isEvent</H3> <PRE>boolean <B>isEvent</B>(<string> sEv)</PRE> <UL>Checks if the event exists. <pre> Synopsis: oEventDriven.isEvent('eventName'); There is also static method doing the same with global events: Zapatec.EventDriven.isEvent('globalEventName'); </pre></UL> <!-- METHOD PARAMETERS START --> <UL> <B>Parameters:</B> <UL><CODE>sEv</CODE> - Event name </UL> </UL> <!-- METHOD PARAMETERS END --> <UL> <B>Returns:</B> <UL> Exists </UL> </UL> <!-- ADDITIONAL ATTRIBUTES START --> <!-- ADDITIONAL ATTRIBUTES END --> <HR> <A NAME="isEventListener"><!-- --></A> <H3>isEventListener</H3> <PRE>boolean <B>isEventListener</B>(<string> sEv, <function> fLsnr)</PRE> <UL>Checks if the event listener is attached to the event. <pre> Synopsis: oEventDriven.isEventListener('eventName', fEventListener); There is also static method doing the same with global events: Zapatec.EventDriven.isEventListener('globalEventName', fEventListener); </pre></UL> <!-- METHOD PARAMETERS START --> <UL> <B>Parameters:</B> <UL><CODE>sEv</CODE> - Event name </UL> <UL><CODE>fLsnr</CODE> - Event listener </UL> </UL> <!-- METHOD PARAMETERS END --> <UL> <B>Returns:</B> <UL> True if event listener is attached to the event </UL> </UL> <!-- ADDITIONAL ATTRIBUTES START --> <!-- ADDITIONAL ATTRIBUTES END --> <HR> <A NAME="removeEvent"><!-- --></A> <H3>removeEvent</H3> <PRE>void <B>removeEvent</B>(<string> sEv)</PRE> <UL>Removes all listeners for the event. <pre> Synopsis: oEventDriven.removeEvent('eventName'); There is also static method doing the same with global events: Zapatec.EventDriven.removeEvent('globalEventName'); </pre></UL> <!-- METHOD PARAMETERS START --> <UL> <B>Parameters:</B> <UL><CODE>sEv</CODE> - Event name </UL> </UL> <!-- METHOD PARAMETERS END --> <!-- ADDITIONAL ATTRIBUTES START --> <!-- ADDITIONAL ATTRIBUTES END --> <HR> <A NAME="removeEventListener"><!-- --></A> <H3>removeEventListener</H3> <PRE>number <B>removeEventListener</B>(<string> sEv, <function> fLsnr)</PRE> <UL>Removes event listener. <pre> Synopsis: oEventDriven.removeEventListener('eventName', fEventListener); There is also static method doing the same with global events: Zapatec.EventDriven.removeEventListener('globalEventName', fEventListener); </pre></UL> <!-- METHOD PARAMETERS START --> <UL> <B>Parameters:</B> <UL><CODE>sEv</CODE> - Event name </UL> <UL><CODE>fLsnr</CODE> - Event listener </UL> </UL> <!-- METHOD PARAMETERS END --> <UL> <B>Returns:</B> <UL> Number of listeners removed </UL> </UL> <!-- ADDITIONAL ATTRIBUTES START --> <!-- ADDITIONAL ATTRIBUTES END --> <HR> <A NAME="unshiftEventListener"><!-- --></A> <H3>unshiftEventListener</H3> <PRE><a href="../Object.html">Object</a> <B>unshiftEventListener</B>(<string> sEv, <function> fLsnr)</PRE> <UL>Adds event listener to the beginning of list. Note that there is no guarantee that it will be always first in the list. It will become second once this method is called again. Never rely on that! <pre> If multiple identical event listeners are registered on the same event, the duplicate instances are discarded. They do not cause the event listener to be called twice, and since the duplicates are discarded, they do not need to be removed manually with the removeEventListener method. Synopsis: oEventDriven.unshiftEventListener('eventName', fEventListener); There is also static method doing the same with global events: Zapatec.EventDriven.unshiftEventListener('globalEventName', fEventListener); </pre></UL> <!-- METHOD PARAMETERS START --> <UL> <B>Parameters:</B> <UL><CODE>sEv</CODE> - Event name </UL> <UL><CODE>fLsnr</CODE> - Event listener </UL> </UL> <!-- METHOD PARAMETERS END --> <!-- ADDITIONAL ATTRIBUTES START --> <!-- ADDITIONAL ATTRIBUTES END --> <HR> <!-- ============ METHOD DETAIL END ========== --> <!-- ========= END OF CLASS DATA ========= --> <!-- ========== START OF NAVBAR ========== --> <A NAME="navbar_bottom"><!-- --></A> <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0"> <TR> <TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A NAME="navbar_bottom_firstrow"><!-- --></A> <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3"> <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="../overview-summary-zpeventdriven.js.html"><FONT CLASS="NavBarFont1"><B>File</B></FONT></A> </TD> <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../overview-tree.html"><FONT CLASS="NavBarFont1"><b>Tree</b></FONT></A> </TD> <!--TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"--> <!--A HREF="deprecated-list.html"--><!--FONT CLASS="NavBarFont1">Deprecated</FONT--><!--/A--><!-- </TD--> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../index-all.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> <B>Zapatec Utils</B> </EM> </TD </TR> <TR> <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> <A HREF="../Zapatec/EditInline.html"><B>PREV CLASS</B></A><!-- NEXT CLASS --> <A HREF="../Zapatec/ImagePreloader.html"><B>NEXT CLASS</B></A></FONT></TD> <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> <A HREF="../index.html" TARGET="_top"><B>FRAMES</B></A> <A HREF="" TARGET="_top"><B>NO FRAMES</B></A> <SCRIPT> <!-- if(window==top) { document.writeln('<A HREF="../allclasses-noframe.html" TARGET=""><B>All Classes</B></A>'); } //--> </SCRIPT> <NOSCRIPT> <A HREF="../allclasses-noframe.html" TARGET=""><B>All Classes</B></A> </NOSCRIPT> </FONT></TD> </TR> <TR> <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> SUMMARY: <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> </TR> </TABLE> <!-- =========== END OF NAVBAR =========== --> <HR> <FONT SIZE="-1"> </FONT> <div class="jsdoc_ctime">Documentation generated by <a href="http://jsdoc.sourceforge.net/" target="_parent">JSDoc</a> on Thu Aug 16 12:18:39 2007</div> </BODY> </HTML>