[ Mini Kiebo ]
Server: Windows NT DESKTOP-5B8S0D4 6.2 build 9200 (Windows 8 Professional Edition) i586
Path:
D:
/
xampp182
/
htdocs
/
simpeg
/
administrator
/
zpmenu
/
jsdocs
/
Zapatec
/
[
Home
]
File: Menu.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.Menu </TITLE> <LINK REL ="stylesheet" TYPE="text/css" HREF="../stylesheet.css" TITLE="Style"> </HEAD> <SCRIPT> function asd() { parent.document.title="Zapatec.Menu"; } </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-zpmenu-core.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 Menu</B> </EM> </TD </TR> <TR> <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> <A HREF="../Zapatec.html"><B>PREV CLASS</B></A><!-- NEXT CLASS --> <A HREF="../"><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.Menu</H2> <PRE>Object | +--<a href='../'>Zapatec.Widget</a> | +--<b>Zapatec.Menu</b> </PRE> <HR> <DL> <!-- Class definition --> <DT>class <B>Zapatec.Menu</B> <DT>extends <a href='../'>Zapatec.Widget</a> </DL> <P> <I>Defined in <a href='../overview-summary-zpmenu-core.js.html'>zpmenu-core.js</a></I><BR/><BR/> </P> <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><FONT SIZE="+2"> <B>Field Summary</B></FONT></TD> </TR> <!-- This is one instance field summary --> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE><static> Object</CODE></FONT></TD> <TD><CODE><B><A HREF="#!s!animations">animations</A></B></CODE> <BR> Collection of animations (function references).</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE><static> Object</CODE></FONT></TD> <TD><CODE><B><A HREF="#!s!CLICK">CLICK</A></B></CODE> <BR> </TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE><static> Object</CODE></FONT></TD> <TD><CODE><B><A HREF="#!s!id">id</A></B></CODE> <BR> </TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE><static> Object</CODE></FONT></TD> <TD><CODE><B><A HREF="#!s!MOUSEOUT">MOUSEOUT</A></B></CODE> <BR> </TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE><static> Object</CODE></FONT></TD> <TD><CODE><B><A HREF="#!s!MOUSEOVER">MOUSEOVER</A></B></CODE> <BR> </TD> </TR> </TABLE> <!-- =========== 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.Menu()">Zapatec.Menu</A></B>(<object> objArgs) </CODE> <BR> Extends base Zapatec Widget class (utils/zpwidget.js). </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> void</CODE> </FONT> </TD> <TD> <CODE> <B> <A HREF="#addAnimation">addAnimation</A></B>(<string> animation) </CODE> <BR> Called with the name of an animation (in the Zapatec.Menu.animations[] array) to apply that animation to this menu object. </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="#collapseAll">collapseAll</A></B>() </CODE> <BR> Call this function to collapse all items in the tree. </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="#destroy">destroy</A></B>() </CODE> <BR> Destroys the tree. </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="#discard">discard</A></B>() </CODE> <BR> Extends parent method. </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="#expandAll">expandAll</A></B>() </CODE> <BR> Call this function to expand all items in the tree. </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="#highlightPath">highlightPath</A></B>(<string> item_id) </CODE> <BR> Highlight specified item and all higher items. </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="#init">init</A></B>(<object> objArgs) </CODE> <BR> Initializes menu. </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="#itemClicked">itemClicked</A></B>(<string> item_id) </CODE> <BR> This function gets called from a global event handler when some item was clicked. </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="#itemDisable">itemDisable</A></B>(<string> item_id) </CODE> <BR> Disables item from an external script. </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="#itemEnable">itemEnable</A></B>(<string> item_id) </CODE> <BR> Enables previously disabled item from an external script. </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="#onItemSelect">onItemSelect</A></B>() </CODE> <BR> Third party code can override this member in order to add an event handler that gets called each time a tree item is selected. </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="#setTriggerObject">setTriggerObject</A></B>(<object> triggerObject) </CODE> <BR> Sets additional trigger object or several trigger objects at once. </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="#sync">sync</A></B>(<string> item_id) </CODE> <BR> Call this function to synchronize the tree to a given item. </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="#toggleAll">toggleAll</A></B>() </CODE> <BR> Call this function to toggle all items in the tree. </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="#toggleItem">toggleItem</A></B>(<string> item_id, <boolean> state) </CODE> <BR> This function toggles an item if the state parameter is not specified. </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><FONT SIZE="+2"><B>Field Detail</B></FONT></TD> </TR> </TABLE> <A NAME="!s!animations"><!-- --></A> <H3>animations</H3> <PRE><static> Object <B>animations</B></PRE> <UL> Collection of animations (function references). These are called to progressively style the DOM elements as menus show and hide. They do not have to set item visibility, but may want to set DOM properties like clipping, opacity and position to create custom effects. </UL> <HR> <A NAME="!s!CLICK"><!-- --></A> <H3>CLICK</H3> <PRE><static> Object <B>CLICK</B></PRE> <UL> </UL> <HR> <A NAME="!s!id"><!-- --></A> <H3>id</H3> <PRE><static> Object <B>id</B></PRE> <UL> </UL> <HR> <A NAME="!s!MOUSEOUT"><!-- --></A> <H3>MOUSEOUT</H3> <PRE><static> Object <B>MOUSEOUT</B></PRE> <UL> </UL> <HR> <A NAME="!s!MOUSEOVER"><!-- --></A> <H3>MOUSEOVER</H3> <PRE><static> Object <B>MOUSEOVER</B></PRE> <UL> </UL> <HR> <!-- ============ 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.Menu()"><!-- --></A><H3> Zapatec.Menu</H3> <PRE><B>Zapatec.Menu</B>(<object> objArgs)</PRE> <UL> Extends base Zapatec Widget class (utils/zpwidget.js). <pre> <strong>In addition to config options defined in base Zapatec.Widget class provides following config options:</strong> <b>container</b> [object or string] Element or id of element that will hold the menu. Required when sourceType is other than "html". If sourceType is "html" and "container" is not specified, menu "source" element will be replaced with the menu. <b>dynamic</b> [boolean] If true is passed, the tree will use the "dynamic initialization" technique which greatly improves generation time. Some functionality is not available in this mode until all the tree was generated. In "dynamic" mode the tree is initially collapsed and levels are generated "on the fly" as the end user expands them. You can't retrieve nodes by ID (which implies you can't synchronize to certain nodes) until they have been generated. <b>showDelay</b> [number] Delay before a submenu is shown, in milliseconds. <b>hideDelay</b> [number] Delay before a submenu is hidden, in milliseconds. <b>onClick</b> [boolean] Top menu drops on click not on hover. <b>vertical</b> [boolean] Make it a vertical menu. <b>scrollWithWindow</b> [boolean] <b>dropShadow</b> [number] <b>drag</b> [boolean] <b>slide</b> [boolean] <b>glide</b> [boolean] <b>fade</b> [boolean] <b>wipe</b> [boolean] <b>unfurl</b> [boolean] <b>animSpeed</b> [number] percentage animation per frame. <b>defaultIcons</b> [string] If set, all tree items will get an additional TD element containing that string in the class attribute. This helps you to include custom default icons without specifying them as IMG tags in the tree. <b>zIndex</b> [number] Can be used for two menus on the same page. Use higher value for menu which must be in front of other menus. <b>rememberPath</b> [boolean or string] Used to keep track of previous menu location. Optional if pathCookie flag value differs from "__zp_item". Possible values: 1) true: keep track. 2) false: do not keep track. 3) "expand": the menu will open expanded to this previously location. <b>pathCookie</b> [string] Used to keep track of previous menu location. Use this option with or instead of "rememberPath" when you need to specify which cookie will contain path information. This is needed e.g. when you have several menus on a page. If "rememberPath" option is not false and "pathCookie" option is not set, cookie name "__zp_item" will be used by default. <b>triggerEvent</b> [string] Event that will trigger showing of the menu. Possible values: 1) For mouse click: 'mousedown' or 'mouseup' or 'click' (no matter which, all values treated the same). 2) For keyboard: 'keydown' or 'keyup' or 'keypress' (no matter which, all values treated the same). <b>triggerKey</b> [number or string] Decimal keyboard scan code or mouse button: "left" or "both". Default: right mouse button. Requires "triggerEvent" to be set. See keyboard scan codes at: http://techwww.in.tu-clausthal.de/Dokumentation/Standards_Bussysteme/ASCII-Tabelle/ http://www.nthelp.com/charts.htm <b>triggerObject</b> [string or object] Element id or HTMLElement object associated with the menu. E.g. div inside which user must click to open the menu. Default: window.document. Requires triggerEvent to be set. Also can be following array (to set trigger on several elements): [ [object or string] HTMLElement object or element id || { triggerObject: [object or string] HTMLElement object or element id, triggerArgs: [any] args that should be available for external scripts }, ... ] When trigger menu is shown, its "triggerObject" property contains reference to trigger object that last invoked the menu, "triggerArgs" property contains corresponding arguments. External scripts can access those properties. This gives ability to attach menu to several objects and to pass through some piece of data from those objects to external scripts. E.g. to determine, which cell of the grid was clicked, etc. If array is empty (triggerObject: []), trigger objects are not set initially and can be set later using setTriggerObject() method. <b>top</b> [string or int] menu initial top offset. <b>right</b> [string or int] menu initial right offset. <b>bottom</b> [string or int] menu initial bottom offset. <b>left</b> [string or int] menu initial left offset. If set, top_parent div will be absolute positioned. Their values will be assigned to corresponding CSS properties of top_parent div. Important: For drag and scroll menus set either "top" or "bottom" and "right" or "left" options instead of putting menu inside absolute positioned div. Otherwise menu can be wrong positioned. <b>onInit</b> [function] function reference to call when menu is initialized. Can be used e.g. to disable certain items, etc. <strong>In addition to events fired from base Zapatec.Widget class fires following events:</strong> <b>menuShown</b> when menu is shown. <b>menuHidden</b> when menu is hidden. </pre> </UL> <UL> <B>Parameters:</B> <UL><CODE>objArgs</CODE> - User configuration </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="addAnimation"><!-- --></A> <H3>addAnimation</H3> <PRE>void <B>addAnimation</B>(<string> animation)</PRE> <UL>Called with the name of an animation (in the Zapatec.Menu.animations[] array) to apply that animation to this menu object.</UL> <!-- METHOD PARAMETERS START --> <UL> <B>Parameters:</B> <UL><CODE>animation</CODE> - Name of the animation </UL> </UL> <!-- METHOD PARAMETERS END --> <!-- ADDITIONAL ATTRIBUTES START --> <!-- ADDITIONAL ATTRIBUTES END --> <HR> <A NAME="collapseAll"><!-- --></A> <H3>collapseAll</H3> <PRE>void <B>collapseAll</B>()</PRE> <UL>Call this function to collapse all items in the tree.</UL> <!-- METHOD PARAMETERS START --> <!-- METHOD PARAMETERS END --> <!-- ADDITIONAL ATTRIBUTES START --> <!-- ADDITIONAL ATTRIBUTES END --> <HR> <A NAME="destroy"><!-- --></A> <H3>destroy</H3> <PRE>void <B>destroy</B>()</PRE> <UL>Destroys the tree. Removes all elements. Does not destroy the Zapatec.Menu object itself (actually there's no proper way in JavaScript to do that).</UL> <!-- METHOD PARAMETERS START --> <!-- METHOD PARAMETERS END --> <!-- ADDITIONAL ATTRIBUTES START --> <!-- ADDITIONAL ATTRIBUTES END --> <HR> <A NAME="discard"><!-- --></A> <H3>discard</H3> <PRE>void <B>discard</B>()</PRE> <UL>Extends parent method. Unregisters scrolling to let JavaScript garbage collector delete the object.</UL> <!-- METHOD PARAMETERS START --> <!-- METHOD PARAMETERS END --> <!-- ADDITIONAL ATTRIBUTES START --> <!-- ADDITIONAL ATTRIBUTES END --> <HR> <A NAME="expandAll"><!-- --></A> <H3>expandAll</H3> <PRE>void <B>expandAll</B>()</PRE> <UL>Call this function to expand all items in the tree.</UL> <!-- METHOD PARAMETERS START --> <!-- METHOD PARAMETERS END --> <!-- ADDITIONAL ATTRIBUTES START --> <!-- ADDITIONAL ATTRIBUTES END --> <HR> <A NAME="highlightPath"><!-- --></A> <H3>highlightPath</H3> <PRE>void <B>highlightPath</B>(<string> item_id)</PRE> <UL>Highlight specified item and all higher items.</UL> <!-- METHOD PARAMETERS START --> <UL> <B>Parameters:</B> <UL><CODE>item_id</CODE> - ID of the item </UL> </UL> <!-- METHOD PARAMETERS END --> <!-- ADDITIONAL ATTRIBUTES START --> <!-- ADDITIONAL ATTRIBUTES END --> <HR> <A NAME="init"><!-- --></A> <H3>init</H3> <PRE>void <B>init</B>(<object> objArgs)</PRE> <UL>Initializes menu.</UL> <!-- METHOD PARAMETERS START --> <UL> <B>Parameters:</B> <UL><CODE>objArgs</CODE> - User configuration </UL> </UL> <!-- METHOD PARAMETERS END --> <!-- ADDITIONAL ATTRIBUTES START --> <!-- ADDITIONAL ATTRIBUTES END --> <HR> <A NAME="itemClicked"><!-- --></A> <H3>itemClicked</H3> <PRE>void <B>itemClicked</B>(<string> item_id)</PRE> <UL>This function gets called from a global event handler when some item was clicked. It selects the item and toggles it if it has a subtree (expands or collapses it).</UL> <!-- METHOD PARAMETERS START --> <UL> <B>Parameters:</B> <UL><CODE>item_id</CODE> - Item ID </UL> </UL> <!-- METHOD PARAMETERS END --> <!-- ADDITIONAL ATTRIBUTES START --> <!-- ADDITIONAL ATTRIBUTES END --> <HR> <A NAME="itemDisable"><!-- --></A> <H3>itemDisable</H3> <PRE>void <B>itemDisable</B>(<string> item_id)</PRE> <UL>Disables item from an external script. <xmp> Example: <ul id="myMenu"> <li id="itemToDisable">Menu Item</li> </ul> <script type="text/javascript"> var menu = new Zapatec.Menu('myMenu', {}); menu.itemDisable('itemToDisable'); </script> </xmp></UL> <!-- METHOD PARAMETERS START --> <UL> <B>Parameters:</B> <UL><CODE>item_id</CODE> - Item ID to disable </UL> </UL> <!-- METHOD PARAMETERS END --> <!-- ADDITIONAL ATTRIBUTES START --> <!-- ADDITIONAL ATTRIBUTES END --> <HR> <A NAME="itemEnable"><!-- --></A> <H3>itemEnable</H3> <PRE>void <B>itemEnable</B>(<string> item_id)</PRE> <UL>Enables previously disabled item from an external script.</UL> <!-- METHOD PARAMETERS START --> <UL> <B>Parameters:</B> <UL><CODE>item_id</CODE> - Item ID to enable </UL> </UL> <!-- METHOD PARAMETERS END --> <!-- ADDITIONAL ATTRIBUTES START --> <!-- ADDITIONAL ATTRIBUTES END --> <HR> <A NAME="onItemSelect"><!-- --></A> <H3>onItemSelect</H3> <PRE>void <B>onItemSelect</B>()</PRE> <UL>Third party code can override this member in order to add an event handler that gets called each time a tree item is selected. It receives a single string parameter containing the item ID.</UL> <!-- METHOD PARAMETERS START --> <!-- METHOD PARAMETERS END --> <!-- ADDITIONAL ATTRIBUTES START --> <!-- ADDITIONAL ATTRIBUTES END --> <HR> <A NAME="setTriggerObject"><!-- --></A> <H3>setTriggerObject</H3> <PRE>void <B>setTriggerObject</B>(<object> triggerObject)</PRE> <UL>Sets additional trigger object or several trigger objects at once.</UL> <!-- METHOD PARAMETERS START --> <UL> <B>Parameters:</B> <UL><CODE>triggerObject</CODE> - One of the following: <pre> element id [string] || HTMLElement object [object] || [ element id [string] || HTMLElement object [object] || { triggerObject: element id [string] || HTMLElement object [object], triggerArgs: any args that should be available to external scripts [any] }, ... ] </pre> </UL> </UL> <!-- METHOD PARAMETERS END --> <!-- ADDITIONAL ATTRIBUTES START --> <!-- ADDITIONAL ATTRIBUTES END --> <HR> <A NAME="sync"><!-- --></A> <H3>sync</H3> <PRE>void <B>sync</B>(<string> item_id)</PRE> <UL>Call this function to synchronize the tree to a given item. This means that all items will be collapsed, except that item and the full path to it.</UL> <!-- METHOD PARAMETERS START --> <UL> <B>Parameters:</B> <UL><CODE>item_id</CODE> - ID of the item to sync to </UL> </UL> <!-- METHOD PARAMETERS END --> <!-- ADDITIONAL ATTRIBUTES START --> <!-- ADDITIONAL ATTRIBUTES END --> <HR> <A NAME="toggleAll"><!-- --></A> <H3>toggleAll</H3> <PRE>void <B>toggleAll</B>()</PRE> <UL>Call this function to toggle all items in the tree.</UL> <!-- METHOD PARAMETERS START --> <!-- METHOD PARAMETERS END --> <!-- ADDITIONAL ATTRIBUTES START --> <!-- ADDITIONAL ATTRIBUTES END --> <HR> <A NAME="toggleItem"><!-- --></A> <H3>toggleItem</H3> <PRE>object <B>toggleItem</B>(<string> item_id, <boolean> state)</PRE> <UL>This function toggles an item if the state parameter is not specified. If state is true then it expands the item, and if state is false then it collapses the item.</UL> <!-- METHOD PARAMETERS START --> <UL> <B>Parameters:</B> <UL><CODE>item_id</CODE> - Item ID </UL> <UL><CODE>state</CODE> - Optional. Desired item state </UL> </UL> <!-- METHOD PARAMETERS END --> <UL> <B>Returns:</B> <UL> Item element if found, null otherwise </UL> </UL> <!-- 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-zpmenu-core.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 Menu</B> </EM> </TD </TR> <TR> <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> <A HREF="../Zapatec.html"><B>PREV CLASS</B></A><!-- NEXT CLASS --> <A HREF="../"><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:19:01 2007</div> </BODY> </HTML>