?  search:
summary | log | graphiclog1 | graphiclog2 | commit | commitdiff | tree | refs | edit | fork
blame | history | raw | HEAD
Simple status box for the sidebar.
[elgg_plugins.git] / yui / docs / YAHOO.widget.Menu.html
blob673916f60db3a91e5b5e9bcfd7fdf7e1a5b8c87f
1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
2 <html>
3 <head>
4 <title>API: menu YAHOO.widget.Menu (YUI Library)</title>
5 <link rel="stylesheet" type="text/css" href="assets/api.css">
6 </head>
7
8 <body id="yahoo-com">
9 <div id="doc3" class="yui-t2">
10
11 <div id="hd">
12 <h1>Yahoo! UI Library</h1>
13 <h3>Menu&nbsp; <span class="subtitle">2.2.0</span></h3>
14 <p>
15 <a href="./index.html">Yahoo! UI Library</a>
16 &gt; <a href="./module_menu.html">menu</a>
17 &gt; YAHOO.widget.Menu
18
19 </p>
20 </div>
21
22 <div id="bd">
23 <div id="yui-main">
24 <div class="yui-b">
25
26
27 <h2>
28
29
30
31
32 Class <b>YAHOO.widget.Menu</b>
33 <span class="extends">
34 - extends <a href="YAHOO.widget.Overlay.html">YAHOO.widget.Overlay</a>
35 </span>
36
37 <span class="extends">
38 </span>
39
40 </code>
41 </h2>
42 <!-- class tree goes here -->
43
44 <dl class="subclasses">
45 <dt>Known Subclasses:</dd>
46 <dd>
47 <a href="YAHOO.widget.ContextMenu.html">YAHOO.widget.ContextMenu</a>
48 <a href="YAHOO.widget.Menubar.html">YAHOO.widget.Menubar</a>
49 </dd>
50 </dl>
51
52
53
54 <div class="summary description">
55 The Menu class creates a container that holds a vertical list representing
56 a set of options or commands. Menu is the base class for all
57 menu containers.
58 </div>
59
60 <div class="section constructor details">
61 <h3><a name="constructor_detail">Constructor</a></h3>
62 <div class="content">
63 <div class="detail">
64 <strong>YAHOO.widget.Menu</strong>
65 <code>
66 (
67
68
69
70 p_oElement
71
72
73
74
75 ,
76 p_oConfig
77 )
78 </code>
79 <div class="description">
80 <dl>
81 <dt>Parameters:</dt>
82 <dd>
83 <code>p_oElement
84 &lt;String&gt;
85 </code>
86 String specifying the id attribute of the
87 <code>&#60;div&#62;</code> element of the menu.
88 </dd>
89 <dd>
90 <code>p_oElement
91 &lt;String&gt;
92 </code>
93 String specifying the id attribute of the
94 <code>&#60;select&#62;</code> element to be used as the data source
95 for the menu.
96 </dd>
97 <dd>
98 <code>p_oElement
99 &lt;<a href="http://www.w3.org/TR/2000/WD-DOM-Level-1-20000929/
100 level-one-html.html#ID-22445964">HTMLDivElement</a>&gt;
101 </code>
102 Object
103 specifying the <code>&#60;div&#62;</code> element of the menu.
104 </dd>
105 <dd>
106 <code>p_oElement
107 &lt;<a href="http://www.w3.org/TR/2000/WD-DOM-Level-1-20000929/
108 level-one-html.html#ID-94282980">HTMLSelectElement</a>&gt;
109 </code>
110
111 Object specifying the <code>&#60;select&#62;</code> element to be used as
112 the data source for the menu.
113 </dd>
114 <dd>
115 <code>p_oConfig
116 &lt;Object&gt;
117 </code>
118 Optional. Object literal specifying the
119 configuration for the menu. See configuration class documentation for
120 more details.
121 </dd>
122 </dl>
123
124
125 </div>
126 </div>
127 </div>
128 </div>
129
130 <div class="section field details">
131 <h3><a name="field_detail">Properties</a></h3>
132 <div class="content">
133 <h4><a name="_aGroupTitleElements">_aGroupTitleElements</a>
134 <code>- private Array</code>
135 </h4>
136 <div class="detail">
137 <div class="description">
138 Array of HTML element used to title groups of menu items.
139 </div>
140 </div>
141
142
143 <div class="default">
144 Default Value: []
145 </div>
146
147
148 <hr />
149 <h4><a name="_aItemGroups">_aItemGroups</a>
150 <code>- private Array</code>
151 </h4>
152 <div class="detail">
153 <div class="description">
154 Multi-dimensional Array representing the menu items as they
155 are grouped in the menu.
156 </div>
157 </div>
158
159
160 <div class="default">
161 Default Value: []
162 </div>
163
164
165 <hr />
166 <h4><a name="_aListElements">_aListElements</a>
167 <code>- private Array</code>
168 </h4>
169 <div class="detail">
170 <div class="description">
171 Array of <code>&#60;ul&#62;</code> elements, each of which is
172 the parent node for each item's <code>&#60;li&#62;</code> element.
173 </div>
174 </div>
175
176
177 <div class="default">
178 Default Value: []
179 </div>
180
181
182 <hr />
183 <h4><a name="_bHandledMouseOutEvent">_bHandledMouseOutEvent</a>
184 <code>- private Boolean</code>
185 </h4>
186 <div class="detail">
187 <div class="description">
188 Boolean indicating the current state of the menu's
189 "mouseout" event.
190 </div>
191 </div>
192
193
194 <div class="default">
195 Default Value: false
196 </div>
197
198
199 <hr />
200 <h4><a name="_bHandledMouseOverEvent">_bHandledMouseOverEvent</a>
201 <code>- private Boolean</code>
202 </h4>
203 <div class="detail">
204 <div class="description">
205 Boolean indicating the current state of the menu's
206 "mouseover" event.
207 </div>
208 </div>
209
210
211 <div class="default">
212 Default Value: false
213 </div>
214
215
216 <hr />
217 <h4><a name="_bHideDelayEventHandlersAssigned">_bHideDelayEventHandlersAssigned</a>
218 <code>- private Boolean</code>
219 </h4>
220 <div class="detail">
221 <div class="description">
222 Boolean indicating if the "mouseover" and "mouseout" event
223 handlers used for hiding the menu via a call to "window.setTimeout" have
224 already been assigned.
225 </div>
226 </div>
227
228
229 <div class="default">
230 Default Value: false
231 </div>
232
233
234 <hr />
235 <h4><a name="_bStopMouseEventHandlers">_bStopMouseEventHandlers</a>
236 <code>- private Boolean</code>
237 </h4>
238 <div class="detail">
239 <div class="description">
240 Stops "mouseover," "mouseout," and "mousemove" event handlers
241 from executing.
242 </div>
243 </div>
244
245
246 <div class="default">
247 Default Value: false
248 </div>
249
250
251 <hr />
252 <h4><a name="_nBodyScrollId">_nBodyScrollId</a>
253 <code>- private Number</code>
254 </h4>
255 <div class="detail">
256 <div class="description">
257 Number representing the time-out setting used to cancel the
258 scrolling of the menu's body element.
259 </div>
260 </div>
261
262
263 <div class="default">
264 Default Value: null
265 </div>
266
267
268 <hr />
269 <h4><a name="_nCurrentMouseX">_nCurrentMouseX</a>
270 <code>- private Number</code>
271 </h4>
272 <div class="detail">
273 <div class="description">
274 The current x coordinate of the mouse inside the area of
275 the menu.
276 </div>
277 </div>
278
279
280 <div class="default">
281 Default Value: 0
282 </div>
283
284
285 <hr />
286 <h4><a name="_nHideDelayId">_nHideDelayId</a>
287 <code>- private Number</code>
288 </h4>
289 <div class="detail">
290 <div class="description">
291 Number representing the time-out setting used to cancel the
292 hiding of a menu.
293 </div>
294 </div>
295
296
297 <div class="default">
298 Default Value: null
299 </div>
300
301
302 <hr />
303 <h4><a name="_nMaxHeight">_nMaxHeight</a>
304 <code>- private Number</code>
305 </h4>
306 <div class="detail">
307 <div class="description">
308 The original value of the "maxheight" configuration property
309 as set by the user.
310 </div>
311 </div>
312
313
314 <div class="default">
315 Default Value: -1
316 </div>
317
318
319 <hr />
320 <h4><a name="_nShowDelayId">_nShowDelayId</a>
321 <code>- private Number</code>
322 </h4>
323 <div class="detail">
324 <div class="description">
325 Number representing the time-out setting used to cancel the
326 showing of a menu.
327 </div>
328 </div>
329
330
331 <div class="default">
332 Default Value: null
333 </div>
334
335
336 <hr />
337 <h4><a name="_nSubmenuHideDelayId">_nSubmenuHideDelayId</a>
338 <code>- private Number</code>
339 </h4>
340 <div class="detail">
341 <div class="description">
342 Number representing the time-out setting used to cancel the
343 hiding of a submenu.
344 </div>
345 </div>
346
347
348 <div class="default">
349 Default Value: null
350 </div>
351
352
353 <hr />
354 <h4><a name="_sClassName">_sClassName</a>
355 <code>- private String</code>
356 </h4>
357 <div class="detail">
358 <div class="description">
359 The current value of the "classname" configuration attribute.
360 </div>
361 </div>
362
363
364 <div class="default">
365 Default Value: null
366 </div>
367
368
369 <hr />
370 <h4><a name="activeItem">activeItem</a>
371 <code>- YAHOO.widget.MenuItem</code>
372 </h4>
373 <div class="detail">
374 <div class="description">
375 Object reference to the item in the menu that has focus.
376 </div>
377 </div>
378
379
380 <div class="default">
381 Default Value: null
382 </div>
383
384
385 <hr />
386 <h4><a name="CSS_CLASS_NAME">CSS_CLASS_NAME</a>
387 <code>- final String</code>
388 </h4>
389 <div class="detail">
390 <div class="description">
391 String representing the CSS class(es) to be applied to the
392 menu's <code>&#60;div&#62;</code> element.
393 </div>
394 </div>
395
396
397 <div class="default">
398 Default Value: "yuimenu"
399 </div>
400
401
402 <hr />
403 <h4><a name="GROUP_TITLE_TAG_NAME">GROUP_TITLE_TAG_NAME</a>
404 <code>- final String</code>
405 </h4>
406 <div class="detail">
407 <div class="description">
408 String representing the tagname of the HTML element used to
409 title the menu's item groups.
410 </div>
411 </div>
412
413
414 <div class="default">
415 Default Value: H6
416 </div>
417
418
419 <hr />
420 <h4><a name="ITEM_TYPE">ITEM_TYPE</a>
421 <code>- final YAHOO.widget.MenuItem</code>
422 </h4>
423 <div class="detail">
424 <div class="description">
425 Object representing the type of menu item to instantiate and
426 add when parsing the child nodes (either <code>&#60;li&#62;</code> element,
427 <code>&#60;optgroup&#62;</code> element or <code>&#60;option&#62;</code>)
428 of the menu's source HTML element.
429 </div>
430 </div>
431
432
433 <div class="default">
434 Default Value: YAHOO.widget.MenuItem
435 </div>
436
437
438 <hr />
439 <h4><a name="itemData">itemData</a>
440 <code>- Array</code>
441 </h4>
442 <div class="detail">
443 <div class="description">
444 Array of items to be added to the menu. The array can contain
445 strings representing the text for each item to be created, object literals
446 representing the menu item configuration properties, or MenuItem instances.
447 This property should be set via the constructor using the configuration
448 object literal.
449 </div>
450 </div>
451
452
453 <div class="default">
454 Default Value: null
455 </div>
456
457
458 <hr />
459 <h4><a name="lazyLoad">lazyLoad</a>
460 <code>- Boolean</code>
461 </h4>
462 <div class="detail">
463 <div class="description">
464 Boolean indicating if the menu's "lazy load" feature is
465 enabled. If set to "true," initialization and rendering of the menu's
466 items will be deferred until the first time it is made visible. This
467 property should be set via the constructor using the configuration
468 object literal.
469 </div>
470 </div>
471
472
473 <div class="default">
474 Default Value: false
475 </div>
476
477
478 <hr />
479 <h4><a name="parent">parent</a>
480 <code>- YAHOO.widget.MenuItem</code>
481 </h4>
482 <div class="detail">
483 <div class="description">
484 Object reference to the menu's parent menu or menu item.
485 This property can be set via the constructor using the configuration
486 object literal.
487 </div>
488 </div>
489
490
491 <div class="default">
492 Default Value: null
493 </div>
494
495
496 <hr />
497 <h4><a name="srcElement">srcElement</a>
498 <code>- <a href="http://www.w3.org/TR/2000/WD-DOM-Level-1-20000929/
499 level-one-html.html#ID-94282980">HTMLSelectElement</a>|<a
500 href="http://www.w3.org/TR/2000/WD-DOM-Level-1-20000929/level-one-html.
501 html#ID-22445964">HTMLDivElement</a></code>
502 </h4>
503 <div class="detail">
504 <div class="description">
505 Object reference to the HTML element (either
506 <code>&#60;select&#62;</code> or <code>&#60;div&#62;</code>) used to
507 create the menu.
508 </div>
509 </div>
510
511
512 <div class="default">
513 Default Value: null
514 </div>
515
516
517 <hr />
518
519
520 </div>
521 </div>
522
523 <div class="section field inheritance">
524 <h4>Properties inherited from <a href="YAHOO.widget.Module.html">YAHOO.widget.Module</a>:</h4>
525 <div class="content">
526 <code>
527
528 <a href="YAHOO.widget.Module.html#body">body</a>,
529 <a href="YAHOO.widget.Module.html#browser">browser</a>,
530 <a href="YAHOO.widget.Module.html#cfg">cfg</a>,
531 <a href="YAHOO.widget.Module.html#contructor">contructor</a>,
532 <a href="YAHOO.widget.Module.html#element">element</a>,
533 <a href="YAHOO.widget.Module.html#footer">footer</a>,
534 <a href="YAHOO.widget.Module.html#header">header</a>,
535 <a href="YAHOO.widget.Module.html#id">id</a>,
536 <a href="YAHOO.widget.Module.html#imageRoot">imageRoot</a>,
537 <a href="YAHOO.widget.Module.html#isSecure">isSecure</a>,
538 <a href="YAHOO.widget.Module.html#platform">platform</a>
539 </code>
540 </div>
541 </div>
542 <div class="section field inheritance">
543 <h4>Properties inherited from <a href="YAHOO.widget.Overlay.html">YAHOO.widget.Overlay</a>:</h4>
544 <div class="content">
545 <code>
546
547 <a href="YAHOO.widget.Overlay.html#YAHOO.widget.Overlay._initialized">YAHOO.widget.Overlay._initialized</a>
548 </code>
549 </div>
550 </div>
551
552 <div class="section method details">
553 <h3><a name="methodDetails">Methods</a></h3>
554 <div class="content">
555 <h4>
556 <a name="_addItemToGroup">_addItemToGroup</a></h4>
557 <div class="detail">
558 <code>
559 private
560
561
562 YAHOO.widget.MenuItem
563 <strong>_addItemToGroup</strong>
564 (
565
566
567 p_nGroupIndex
568
569
570 ,
571 p_oItem
572
573
574
575
576
577
578 ,
579 p_nItemIndex
580
581
582 )
583 </code>
584
585 <div class="description">
586 Adds a menu item to a group.
587 </div>
588
589 <div class="description">
590
591 <dl>
592 <dt>Parameters:</dt>
593 <dd>
594 <code>p_nGroupIndex &lt;Number&gt;</code>
595 Number indicating the group to which the
596 item belongs.
597 </dd>
598 <dd>
599 <code>p_oItem &lt;YAHOO.widget.MenuItem&gt;</code>
600 Object reference for the MenuItem
601 instance to be added to the menu.
602 </dd>
603 <dd>
604 <code>p_oItem &lt;String&gt;</code>
605 String specifying the text of the item to be added
606 to the menu.
607 </dd>
608 <dd>
609 <code>p_oItem &lt;Object&gt;</code>
610 Object literal containing a set of menu item
611 configuration properties.
612 </dd>
613 <dd>
614 <code>p_nItemIndex &lt;Number&gt;</code>
615 Optional. Number indicating the index at
616 which the menu item should be added.
617 </dd>
618 </dl>
619
620 <dl>
621 <dt>Returns:
622 <code>
623 YAHOO.widget.MenuItem
624 </code></dt>
625 <dd></dd>
626 </dl>
627
628 </div>
629
630 </div>
631 <hr />
632 <h4>
633 <a name="_cancelHideDelay">_cancelHideDelay</a></h4>
634 <div class="detail">
635 <code>
636 private
637
638
639 void
640 <strong>_cancelHideDelay</strong>
641 (
642 )
643 </code>
644
645 <div class="description">
646 Cancels the call to "hideMenu."
647 </div>
648
649 <div class="description">
650
651
652 <dl>
653 <dt>Returns:
654 <code>
655 void
656 </code></dt>
657 <dd></dd>
658 </dl>
659
660 </div>
661
662 </div>
663 <hr />
664 <h4>
665 <a name="_cancelShowDelay">_cancelShowDelay</a></h4>
666 <div class="detail">
667 <code>
668 private
669
670
671 void
672 <strong>_cancelShowDelay</strong>
673 (
674 )
675 </code>
676
677 <div class="description">
678 Cancels the call to the "showMenu."
679 </div>
680
681 <div class="description">
682
683
684 <dl>
685 <dt>Returns:
686 <code>
687 void
688 </code></dt>
689 <dd></dd>
690 </dl>
691
692 </div>
693
694 </div>
695 <hr />
696 <h4>
697 <a name="_checkPosition">_checkPosition</a></h4>
698 <div class="detail">
699 <code>
700 private
701
702
703 Boolean
704 <strong>_checkPosition</strong>
705 (
706
707
708 p_sPosition
709
710
711 )
712 </code>
713
714 <div class="description">
715 Checks to make sure that the value of the "position" property
716 is one of the supported strings. Returns true if the position is supported.
717 </div>
718
719 <div class="description">
720
721 <dl>
722 <dt>Parameters:</dt>
723 <dd>
724 <code>p_sPosition &lt;Object&gt;</code>
725 String specifying the position of the menu.
726 </dd>
727 </dl>
728
729 <dl>
730 <dt>Returns:
731 <code>
732 Boolean
733 </code></dt>
734 <dd></dd>
735 </dl>
736
737 </div>
738
739 </div>
740 <hr />
741 <h4>
742 <a name="_configureSubmenu">_configureSubmenu</a></h4>
743 <div class="detail">
744 <code>
745 private
746
747
748 void
749 <strong>_configureSubmenu</strong>
750 (
751
752
753 p_oItem
754
755
756 )
757 </code>
758
759 <div class="description">
760 Subscribes the menu item's submenu to its parent menu's events.
761 </div>
762
763 <div class="description">
764
765 <dl>
766 <dt>Parameters:</dt>
767 <dd>
768 <code>p_oItem &lt;YAHOO.widget.MenuItem&gt;</code>
769 Object reference for the MenuItem
770 instance with the submenu to be configured.
771 </dd>
772 </dl>
773
774 <dl>
775 <dt>Returns:
776 <code>
777 void
778 </code></dt>
779 <dd></dd>
780 </dl>
781
782 </div>
783
784 </div>
785 <hr />
786 <h4>
787 <a name="_createItemGroup">_createItemGroup</a></h4>
788 <div class="detail">
789 <code>
790 private
791
792
793 Array
794 <strong>_createItemGroup</strong>
795 (
796
797
798 p_nIndex
799
800
801 )
802 </code>
803
804 <div class="description">
805 Creates a new menu item group (array) and its associated
806 <code>&#60;ul&#62;</code> element. Returns an aray of menu item groups.
807 </div>
808
809 <div class="description">
810
811 <dl>
812 <dt>Parameters:</dt>
813 <dd>
814 <code>p_nIndex &lt;Number&gt;</code>
815 Number indicating the group to create.
816 </dd>
817 </dl>
818
819 <dl>
820 <dt>Returns:
821 <code>
822 Array
823 </code></dt>
824 <dd></dd>
825 </dl>
826
827 </div>
828
829 </div>
830 <hr />
831 <h4>
832 <a name="_disableScrollFooter">_disableScrollFooter</a></h4>
833 <div class="detail">
834 <code>
835 protected
836
837
838 void
839 <strong>_disableScrollFooter</strong>
840 (
841 )
842 </code>
843
844 <div class="description">
845 Disables the footer used for scrolling the body of the menu.
846 </div>
847
848 <div class="description">
849
850
851 <dl>
852 <dt>Returns:
853 <code>
854 void
855 </code></dt>
856 <dd></dd>
857 </dl>
858
859 </div>
860
861 </div>
862 <hr />
863 <h4>
864 <a name="_disableScrollHeader">_disableScrollHeader</a></h4>
865 <div class="detail">
866 <code>
867 protected
868
869
870 void
871 <strong>_disableScrollHeader</strong>
872 (
873 )
874 </code>
875
876 <div class="description">
877 Disables the header used for scrolling the body of the menu.
878 </div>
879
880 <div class="description">
881
882
883 <dl>
884 <dt>Returns:
885 <code>
886 void
887 </code></dt>
888 <dd></dd>
889 </dl>
890
891 </div>
892
893 </div>
894 <hr />
895 <h4>
896 <a name="_enableScrollFooter">_enableScrollFooter</a></h4>
897 <div class="detail">
898 <code>
899 protected
900
901
902 void
903 <strong>_enableScrollFooter</strong>
904 (
905 )
906 </code>
907
908 <div class="description">
909 Enables the footer used for scrolling the body of the menu.
910 </div>
911
912 <div class="description">
913
914
915 <dl>
916 <dt>Returns:
917 <code>
918 void
919 </code></dt>
920 <dd></dd>
921 </dl>
922
923 </div>
924
925 </div>
926 <hr />
927 <h4>
928 <a name="_enableScrollHeader">_enableScrollHeader</a></h4>
929 <div class="detail">
930 <code>
931 protected
932
933
934 void
935 <strong>_enableScrollHeader</strong>
936 (
937 )
938 </code>
939
940 <div class="description">
941 Enables the header used for scrolling the body of the menu.
942 </div>
943
944 <div class="description">
945
946
947 <dl>
948 <dt>Returns:
949 <code>
950 void
951 </code></dt>
952 <dd></dd>
953 </dl>
954
955 </div>
956
957 </div>
958 <hr />
959 <h4>
960 <a name="_execHideDelay">_execHideDelay</a></h4>
961 <div class="detail">
962 <code>
963 private
964
965
966 void
967 <strong>_execHideDelay</strong>
968 (
969 )
970 </code>
971
972 <div class="description">
973 Hides the menu after the number of milliseconds specified by
974 the "hidedelay" configuration property.
975 </div>
976
977 <div class="description">
978
979
980 <dl>
981 <dt>Returns:
982 <code>
983 void
984 </code></dt>
985 <dd></dd>
986 </dl>
987
988 </div>
989
990 </div>
991 <hr />
992 <h4>
993 <a name="_execShowDelay">_execShowDelay</a></h4>
994 <div class="detail">
995 <code>
996 private
997
998
999 void
1000 <strong>_execShowDelay</strong>
1001 (
1002
1003
1004 p_oMenu
1005
1006
1007 )
1008 </code>
1009
1010 <div class="description">
1011 Shows the menu after the number of milliseconds specified by
1012 the "showdelay" configuration property have ellapsed.
1013 </div>
1014
1015 <div class="description">
1016
1017 <dl>
1018 <dt>Parameters:</dt>
1019 <dd>
1020 <code>p_oMenu &lt;YAHOO.widget.Menu&gt;</code>
1021 Object specifying the menu that should
1022 be made visible.
1023 </dd>
1024 </dl>
1025
1026 <dl>
1027 <dt>Returns:
1028 <code>
1029 void
1030 </code></dt>
1031 <dd></dd>
1032 </dl>
1033
1034 </div>
1035
1036 </div>
1037 <hr />
1038 <h4>
1039 <a name="_execSubmenuHideDelay">_execSubmenuHideDelay</a></h4>
1040 <div class="detail">
1041 <code>
1042 private
1043
1044
1045 void
1046 <strong>_execSubmenuHideDelay</strong>
1047 (
1048
1049
1050 p_oSubmenu
1051
1052
1053 ,
1054 p_nMouseX
1055
1056
1057 ,
1058 p_nHideDelay
1059
1060
1061 )
1062 </code>
1063
1064 <div class="description">
1065 Hides a submenu after the number of milliseconds specified by
1066 the "submenuhidedelay" configuration property have ellapsed.
1067 </div>
1068
1069 <div class="description">
1070
1071 <dl>
1072 <dt>Parameters:</dt>
1073 <dd>
1074 <code>p_oSubmenu &lt;YAHOO.widget.Menu&gt;</code>
1075 Object specifying the submenu that
1076 should be hidden.
1077 </dd>
1078 <dd>
1079 <code>p_nMouseX &lt;Number&gt;</code>
1080 The x coordinate of the mouse when it left
1081 the specified submenu's parent menu item.
1082 </dd>
1083 <dd>
1084 <code>p_nHideDelay &lt;Number&gt;</code>
1085 The number of milliseconds that should ellapse
1086 before the submenu is hidden.
1087 </dd>
1088 </dl>
1089
1090 <dl>
1091 <dt>Returns:
1092 <code>
1093 void
1094 </code></dt>
1095 <dd></dd>
1096 </dl>
1097
1098 </div>
1099
1100 </div>
1101 <hr />
1102 <h4>
1103 <a name="_getFirstEnabledItem">_getFirstEnabledItem</a></h4>
1104 <div class="detail">
1105 <code>
1106 private
1107
1108
1109 YAHOO.widget.MenuItem
1110 <strong>_getFirstEnabledItem</strong>
1111 (
1112 )
1113 </code>
1114
1115 <div class="description">
1116 Returns the first enabled item in the menu.
1117 </div>
1118
1119 <div class="description">
1120
1121
1122 <dl>
1123 <dt>Returns:
1124 <code>
1125 YAHOO.widget.MenuItem
1126 </code></dt>
1127 <dd></dd>
1128 </dl>
1129
1130 </div>
1131
1132 </div>
1133 <hr />
1134 <h4>
1135 <a name="_getItemGroup">_getItemGroup</a></h4>
1136 <div class="detail">
1137 <code>
1138 private
1139
1140
1141 Array
1142 <strong>_getItemGroup</strong>
1143 (
1144
1145
1146 p_nIndex
1147
1148
1149 )
1150 </code>
1151
1152 <div class="description">
1153 Returns the menu item group at the specified index.
1154 </div>
1155
1156 <div class="description">
1157
1158 <dl>
1159 <dt>Parameters:</dt>
1160 <dd>
1161 <code>p_nIndex &lt;Number&gt;</code>
1162 Number indicating the index of the menu item group
1163 to be retrieved.
1164 </dd>
1165 </dl>
1166
1167 <dl>
1168 <dt>Returns:
1169 <code>
1170 Array
1171 </code></dt>
1172 <dd></dd>
1173 </dl>
1174
1175 </div>
1176
1177 </div>
1178 <hr />
1179 <h4>
1180 <a name="_getOffsetWidth">_getOffsetWidth</a></h4>
1181 <div class="detail">
1182 <code>
1183 private
1184
1185
1186 void
1187 <strong>_getOffsetWidth</strong>
1188 (
1189 )
1190 </code>
1191
1192 <div class="description">
1193 Returns the offset width of the menu's
1194 <code>&#60;div&#62;</code> element.
1195 </div>
1196
1197 <div class="description">
1198
1199
1200 <dl>
1201 <dt>Returns:
1202 <code>
1203 void
1204 </code></dt>
1205 <dd></dd>
1206 </dl>
1207
1208 </div>
1209
1210 </div>
1211 <hr />
1212 <h4>
1213 <a name="_initSubTree">_initSubTree</a></h4>
1214 <div class="detail">
1215 <code>
1216 private
1217
1218
1219 void
1220 <strong>_initSubTree</strong>
1221 (
1222 )
1223 </code>
1224
1225 <div class="description">
1226 Iterates the childNodes of the source element to find nodes
1227 used to instantiate menu and menu items.
1228 </div>
1229
1230 <div class="description">
1231
1232
1233 <dl>
1234 <dt>Returns:
1235 <code>
1236 void
1237 </code></dt>
1238 <dd></dd>
1239 </dl>
1240
1241 </div>
1242
1243 </div>
1244 <hr />
1245 <h4>
1246 <a name="_onBeforeHide">_onBeforeHide</a></h4>
1247 <div class="detail">
1248 <code>
1249 private
1250
1251
1252 void
1253 <strong>_onBeforeHide</strong>
1254 (
1255
1256
1257 p_sType
1258
1259
1260 ,
1261 p_aArgs
1262
1263
1264 ,
1265 p_oMenu
1266
1267
1268 )
1269 </code>
1270
1271 <div class="description">
1272 "beforehide" event handler for the menu.
1273 </div>
1274
1275 <div class="description">
1276
1277 <dl>
1278 <dt>Parameters:</dt>
1279 <dd>
1280 <code>p_sType &lt;String&gt;</code>
1281 String representing the name of the event that
1282 was fired.
1283 </dd>
1284 <dd>
1285 <code>p_aArgs &lt;Array&gt;</code>
1286 Array of arguments sent when the event was fired.
1287 </dd>
1288 <dd>
1289 <code>p_oMenu &lt;YAHOO.widget.Menu&gt;</code>
1290 Object representing the menu that fired
1291 the event.
1292 </dd>
1293 </dl>
1294
1295 <dl>
1296 <dt>Returns:
1297 <code>
1298 void
1299 </code></dt>
1300 <dd></dd>
1301 </dl>
1302
1303 </div>
1304
1305 </div>
1306 <hr />
1307 <h4>
1308 <a name="_onBeforeRender">_onBeforeRender</a></h4>
1309 <div class="detail">
1310 <code>
1311 private
1312
1313
1314 void
1315 <strong>_onBeforeRender</strong>
1316 (
1317
1318
1319 p_sType
1320
1321
1322 ,
1323 p_aArgs
1324
1325
1326 ,
1327 p_oMenu
1328
1329
1330 )
1331 </code>
1332
1333 <div class="description">
1334 "beforerender" event handler for the menu. Appends all of the
1335 <code>&#60;ul&#62;</code>, <code>&#60;li&#62;</code> and their accompanying
1336 title elements to the body element of the menu.
1337 </div>
1338
1339 <div class="description">
1340
1341 <dl>
1342 <dt>Parameters:</dt>
1343 <dd>
1344 <code>p_sType &lt;String&gt;</code>
1345 String representing the name of the event that
1346 was fired.
1347 </dd>
1348 <dd>
1349 <code>p_aArgs &lt;Array&gt;</code>
1350 Array of arguments sent when the event was fired.
1351 </dd>
1352 <dd>
1353 <code>p_oMenu &lt;YAHOO.widget.Menu&gt;</code>
1354 Object representing the menu that
1355 fired the event.
1356 </dd>
1357 </dl>
1358
1359 <dl>
1360 <dt>Returns:
1361 <code>
1362 void
1363 </code></dt>
1364 <dd></dd>
1365 </dl>
1366
1367 </div>
1368
1369 </div>
1370 <hr />
1371 <h4>
1372 <a name="_onBeforeShow">_onBeforeShow</a></h4>
1373 <div class="detail">
1374 <code>
1375 private
1376
1377
1378 void
1379 <strong>_onBeforeShow</strong>
1380 (
1381
1382
1383 p_sType
1384
1385
1386 ,
1387 p_aArgs
1388
1389
1390 ,
1391 p_oMenu
1392
1393
1394 )
1395 </code>
1396
1397 <div class="description">
1398 "beforeshow" event handler for the menu.
1399 </div>
1400
1401 <div class="description">
1402
1403 <dl>
1404 <dt>Parameters:</dt>
1405 <dd>
1406 <code>p_sType &lt;String&gt;</code>
1407 String representing the name of the event that
1408 was fired.
1409 </dd>
1410 <dd>
1411 <code>p_aArgs &lt;Array&gt;</code>
1412 Array of arguments sent when the event was fired.
1413 </dd>
1414 <dd>
1415 <code>p_oMenu &lt;YAHOO.widget.Menu&gt;</code>
1416 Object representing the menu that
1417 fired the event.
1418 </dd>
1419 </dl>
1420
1421 <dl>
1422 <dt>Returns:
1423 <code>
1424 void
1425 </code></dt>
1426 <dd></dd>
1427 </dl>
1428
1429 </div>
1430
1431 </div>
1432 <hr />
1433 <h4>
1434 <a name="_onClick">_onClick</a></h4>
1435 <div class="detail">
1436 <code>
1437 protected
1438
1439
1440 void
1441 <strong>_onClick</strong>
1442 (
1443
1444
1445 p_sType
1446
1447
1448 ,
1449 p_aArgs
1450
1451
1452 ,
1453 p_oMenu
1454
1455
1456 )
1457 </code>
1458
1459 <div class="description">
1460 "click" event handler for the menu.
1461 </div>
1462
1463 <div class="description">
1464
1465 <dl>
1466 <dt>Parameters:</dt>
1467 <dd>
1468 <code>p_sType &lt;String&gt;</code>
1469 String representing the name of the event that
1470 was fired.
1471 </dd>
1472 <dd>
1473 <code>p_aArgs &lt;Array&gt;</code>
1474 Array of arguments sent when the event was fired.
1475 </dd>
1476 <dd>
1477 <code>p_oMenu &lt;YAHOO.widget.Menu&gt;</code>
1478 Object representing the menu that
1479 fired the event.
1480 </dd>
1481 </dl>
1482
1483 <dl>
1484 <dt>Returns:
1485 <code>
1486 void
1487 </code></dt>
1488 <dd></dd>
1489 </dl>
1490
1491 </div>
1492
1493 </div>
1494 <hr />
1495 <h4>
1496 <a name="_onHide">_onHide</a></h4>
1497 <div class="detail">
1498 <code>
1499 private
1500
1501
1502 void
1503 <strong>_onHide</strong>
1504 (
1505
1506
1507 p_sType
1508
1509
1510 ,
1511 p_aArgs
1512
1513
1514 ,
1515 p_oMenu
1516
1517
1518 )
1519 </code>
1520
1521 <div class="description">
1522 "hide" event handler for the menu.
1523 </div>
1524
1525 <div class="description">
1526
1527 <dl>
1528 <dt>Parameters:</dt>
1529 <dd>
1530 <code>p_sType &lt;String&gt;</code>
1531 String representing the name of the event that
1532 was fired.
1533 </dd>
1534 <dd>
1535 <code>p_aArgs &lt;Array&gt;</code>
1536 Array of arguments sent when the event was fired.
1537 </dd>
1538 <dd>
1539 <code>p_oMenu &lt;YAHOO.widget.Menu&gt;</code>
1540 Object representing the menu that fired
1541 the event.
1542 </dd>
1543 </dl>
1544
1545 <dl>
1546 <dt>Returns:
1547 <code>
1548 void
1549 </code></dt>
1550 <dd></dd>
1551 </dl>
1552
1553 </div>
1554
1555 </div>
1556 <hr />
1557 <h4>
1558 <a name="_onInit">_onInit</a></h4>
1559 <div class="detail">
1560 <code>
1561 private
1562
1563
1564 void
1565 <strong>_onInit</strong>
1566 (
1567
1568
1569 p_sType
1570
1571
1572 ,
1573 p_aArgs
1574
1575
1576 ,
1577 p_oMenu
1578
1579
1580 )
1581 </code>
1582
1583 <div class="description">
1584 "init" event handler for the menu.
1585 </div>
1586
1587 <div class="description">
1588
1589 <dl>
1590 <dt>Parameters:</dt>
1591 <dd>
1592 <code>p_sType &lt;String&gt;</code>
1593 String representing the name of the event that
1594 was fired.
1595 </dd>
1596 <dd>
1597 <code>p_aArgs &lt;Array&gt;</code>
1598 Array of arguments sent when the event was fired.
1599 </dd>
1600 <dd>
1601 <code>p_oMenu &lt;YAHOO.widget.Menu&gt;</code>
1602 Object representing the menu that
1603 fired the event.
1604 </dd>
1605 </dl>
1606
1607 <dl>
1608 <dt>Returns:
1609 <code>
1610 void
1611 </code></dt>
1612 <dd></dd>
1613 </dl>
1614
1615 </div>
1616
1617 </div>
1618 <hr />
1619 <h4>
1620 <a name="_onKeyDown">_onKeyDown</a></h4>
1621 <div class="detail">
1622 <code>
1623 protected
1624
1625
1626 void
1627 <strong>_onKeyDown</strong>
1628 (
1629
1630
1631 p_sType
1632
1633
1634 ,
1635 p_aArgs
1636
1637
1638 ,
1639 p_oMenu
1640
1641
1642 )
1643 </code>
1644
1645 <div class="description">
1646 "keydown" event handler for the menu.
1647 </div>
1648
1649 <div class="description">
1650
1651 <dl>
1652 <dt>Parameters:</dt>
1653 <dd>
1654 <code>p_sType &lt;String&gt;</code>
1655 String representing the name of the event that
1656 was fired.
1657 </dd>
1658 <dd>
1659 <code>p_aArgs &lt;Array&gt;</code>
1660 Array of arguments sent when the event was fired.
1661 </dd>
1662 <dd>
1663 <code>p_oMenu &lt;YAHOO.widget.Menu&gt;</code>
1664 Object representing the menu that
1665 fired the event.
1666 </dd>
1667 </dl>
1668
1669 <dl>
1670 <dt>Returns:
1671 <code>
1672 void
1673 </code></dt>
1674 <dd></dd>
1675 </dl>
1676
1677 </div>
1678
1679 </div>
1680 <hr />
1681 <h4>
1682 <a name="_onKeyPress">_onKeyPress</a></h4>
1683 <div class="detail">
1684 <code>
1685 protected
1686
1687
1688 void
1689 <strong>_onKeyPress</strong>
1690 (
1691
1692
1693 p_sType
1694
1695
1696 ,
1697 p_aArgs
1698
1699
1700 ,
1701 p_oMenu
1702
1703
1704 )
1705 </code>
1706
1707 <div class="description">
1708 "keypress" event handler for a Menu instance.
1709 </div>
1710
1711 <div class="description">
1712
1713 <dl>
1714 <dt>Parameters:</dt>
1715 <dd>
1716 <code>p_sType &lt;String&gt;</code>
1717 The name of the event that was fired.
1718 </dd>
1719 <dd>
1720 <code>p_aArgs &lt;Array&gt;</code>
1721 Collection of arguments sent when the event
1722 was fired.
1723 </dd>
1724 <dd>
1725 <code>p_oMenu &lt;YAHOO.widget.Menu&gt;</code>
1726 The Menu instance that fired the event.
1727 </dd>
1728 </dl>
1729
1730 <dl>
1731 <dt>Returns:
1732 <code>
1733 void
1734 </code></dt>
1735 <dd></dd>
1736 </dl>
1737
1738 </div>
1739
1740 </div>
1741 <hr />
1742 <h4>
1743 <a name="_onMenuItemBlur">_onMenuItemBlur</a></h4>
1744 <div class="detail">
1745 <code>
1746 private
1747
1748
1749 void
1750 <strong>_onMenuItemBlur</strong>
1751 (
1752
1753
1754 p_sType
1755
1756
1757 ,
1758 p_aArgs
1759
1760
1761 )
1762 </code>
1763
1764 <div class="description">
1765 "blur" event handler for the menu's items.
1766 </div>
1767
1768 <div class="description">
1769
1770 <dl>
1771 <dt>Parameters:</dt>
1772 <dd>
1773 <code>p_sType &lt;String&gt;</code>
1774 String representing the name of the event
1775 that was fired.
1776 </dd>
1777 <dd>
1778 <code>p_aArgs &lt;Array&gt;</code>
1779 Array of arguments sent when the event was fired.
1780 </dd>
1781 </dl>
1782
1783 <dl>
1784 <dt>Returns:
1785 <code>
1786 void
1787 </code></dt>
1788 <dd></dd>
1789 </dl>
1790
1791 </div>
1792
1793 </div>
1794 <hr />
1795 <h4>
1796 <a name="_onMenuItemConfigChange">_onMenuItemConfigChange</a></h4>
1797 <div class="detail">
1798 <code>
1799 private
1800
1801
1802 void
1803 <strong>_onMenuItemConfigChange</strong>
1804 (
1805
1806
1807 p_sType
1808
1809
1810 ,
1811 p_aArgs
1812
1813
1814 ,
1815 p_oItem
1816
1817
1818 )
1819 </code>
1820
1821 <div class="description">
1822 "configchange" event handler for the menu's items.
1823 </div>
1824
1825 <div class="description">
1826
1827 <dl>
1828 <dt>Parameters:</dt>
1829 <dd>
1830 <code>p_sType &lt;String&gt;</code>
1831 String representing the name of the event that
1832 was fired.
1833 </dd>
1834 <dd>
1835 <code>p_aArgs &lt;Array&gt;</code>
1836 Array of arguments sent when the event was fired.
1837 </dd>
1838 <dd>
1839 <code>p_oItem &lt;YAHOO.widget.MenuItem&gt;</code>
1840 Object representing the menu item
1841 that fired the event.
1842 </dd>
1843 </dl>
1844
1845 <dl>
1846 <dt>Returns:
1847 <code>
1848 void
1849 </code></dt>
1850 <dd></dd>
1851 </dl>
1852
1853 </div>
1854
1855 </div>
1856 <hr />
1857 <h4>
1858 <a name="_onMenuItemFocus">_onMenuItemFocus</a></h4>
1859 <div class="detail">
1860 <code>
1861 private
1862
1863
1864 void
1865 <strong>_onMenuItemFocus</strong>
1866 (
1867
1868
1869 p_sType
1870
1871
1872 ,
1873 p_aArgs
1874
1875
1876 ,
1877 p_oItem
1878
1879
1880 )
1881 </code>
1882
1883 <div class="description">
1884 "focus" event handler for the menu's items.
1885 </div>
1886
1887 <div class="description">
1888
1889 <dl>
1890 <dt>Parameters:</dt>
1891 <dd>
1892 <code>p_sType &lt;String&gt;</code>
1893 String representing the name of the event that
1894 was fired.
1895 </dd>
1896 <dd>
1897 <code>p_aArgs &lt;Array&gt;</code>
1898 Array of arguments sent when the event was fired.
1899 </dd>
1900 <dd>
1901 <code>p_oItem &lt;YAHOO.widget.MenuItem&gt;</code>
1902 Object representing the menu item
1903 that fired the event.
1904 </dd>
1905 </dl>
1906
1907 <dl>
1908 <dt>Returns:
1909 <code>
1910 void
1911 </code></dt>
1912 <dd></dd>
1913 </dl>
1914
1915 </div>
1916
1917 </div>
1918 <hr />
1919 <h4>
1920 <a name="_onMouseMove">_onMouseMove</a></h4>
1921 <div class="detail">
1922 <code>
1923 protected
1924
1925
1926 void
1927 <strong>_onMouseMove</strong>
1928 (
1929
1930
1931 p_oEvent
1932
1933
1934 ,
1935 p_oMenu
1936
1937
1938 )
1939 </code>
1940
1941 <div class="description">
1942 "click" event handler for the menu.
1943 </div>
1944
1945 <div class="description">
1946
1947 <dl>
1948 <dt>Parameters:</dt>
1949 <dd>
1950 <code>p_oEvent &lt;Event&gt;</code>
1951 Object representing the DOM event object passed
1952 back by the event utility (YAHOO.util.Event).
1953 </dd>
1954 <dd>
1955 <code>p_oMenu &lt;YAHOO.widget.Menu&gt;</code>
1956 Object representing the menu that
1957 fired the event.
1958 </dd>
1959 </dl>
1960
1961 <dl>
1962 <dt>Returns:
1963 <code>
1964 void
1965 </code></dt>
1966 <dd></dd>
1967 </dl>
1968
1969 </div>
1970
1971 </div>
1972 <hr />
1973 <h4>
1974 <a name="_onMouseOut">_onMouseOut</a></h4>
1975 <div class="detail">
1976 <code>
1977 protected
1978
1979
1980 void
1981 <strong>_onMouseOut</strong>
1982 (
1983
1984
1985 p_sType
1986
1987
1988 ,
1989 p_aArgs
1990
1991
1992 ,
1993 p_oMenu
1994
1995
1996 )
1997 </code>
1998
1999 <div class="description">
2000 "mouseout" event handler for the menu.
2001 </div>
2002
2003 <div class="description">
2004
2005 <dl>
2006 <dt>Parameters:</dt>
2007 <dd>
2008 <code>p_sType &lt;String&gt;</code>
2009 String representing the name of the event that
2010 was fired.
2011 </dd>
2012 <dd>
2013 <code>p_aArgs &lt;Array&gt;</code>
2014 Array of arguments sent when the event was fired.
2015 </dd>
2016 <dd>
2017 <code>p_oMenu &lt;YAHOO.widget.Menu&gt;</code>
2018 Object representing the menu that
2019 fired the event.
2020 </dd>
2021 </dl>
2022
2023 <dl>
2024 <dt>Returns:
2025 <code>
2026 void
2027 </code></dt>
2028 <dd></dd>
2029 </dl>
2030
2031 </div>
2032
2033 </div>
2034 <hr />
2035 <h4>
2036 <a name="_onMouseOver">_onMouseOver</a></h4>
2037 <div class="detail">
2038 <code>
2039 protected
2040
2041
2042 void
2043 <strong>_onMouseOver</strong>
2044 (
2045
2046
2047 p_sType
2048
2049
2050 ,
2051 p_aArgs
2052
2053
2054 ,
2055 p_oMenu
2056
2057
2058 )
2059 </code>
2060
2061 <div class="description">
2062 "mouseover" event handler for the menu.
2063 </div>
2064
2065 <div class="description">
2066
2067 <dl>
2068 <dt>Parameters:</dt>
2069 <dd>
2070 <code>p_sType &lt;String&gt;</code>
2071 String representing the name of the event that
2072 was fired.
2073 </dd>
2074 <dd>
2075 <code>p_aArgs &lt;Array&gt;</code>
2076 Array of arguments sent when the event was fired.
2077 </dd>
2078 <dd>
2079 <code>p_oMenu &lt;YAHOO.widget.Menu&gt;</code>
2080 Object representing the menu that
2081 fired the event.
2082 </dd>
2083 </dl>
2084
2085 <dl>
2086 <dt>Returns:
2087 <code>
2088 void
2089 </code></dt>
2090 <dd></dd>
2091 </dl>
2092
2093 </div>
2094
2095 </div>
2096 <hr />
2097 <h4>
2098 <a name="_onParentMenuConfigChange">_onParentMenuConfigChange</a></h4>
2099 <div class="detail">
2100 <code>
2101 private
2102
2103
2104 void
2105 <strong>_onParentMenuConfigChange</strong>
2106 (
2107
2108
2109 p_sType
2110
2111
2112 ,
2113 p_aArgs
2114
2115
2116 ,
2117 p_oSubmenu
2118
2119
2120 )
2121 </code>
2122
2123 <div class="description">
2124 "configchange" event handler for a submenu.
2125 </div>
2126
2127 <div class="description">
2128
2129 <dl>
2130 <dt>Parameters:</dt>
2131 <dd>
2132 <code>p_sType &lt;String&gt;</code>
2133 String representing the name of the event that
2134 was fired.
2135 </dd>
2136 <dd>
2137 <code>p_aArgs &lt;Array&gt;</code>
2138 Array of arguments sent when the event was fired.
2139 </dd>
2140 <dd>
2141 <code>p_oSubmenu &lt;YAHOO.widget.Menu&gt;</code>
2142 Object representing the submenu that
2143 subscribed to the event.
2144 </dd>
2145 </dl>
2146
2147 <dl>
2148 <dt>Returns:
2149 <code>
2150 void
2151 </code></dt>
2152 <dd></dd>
2153 </dl>
2154
2155 </div>
2156
2157 </div>
2158 <hr />
2159 <h4>
2160 <a name="_onParentMenuRender">_onParentMenuRender</a></h4>
2161 <div class="detail">
2162 <code>
2163 private
2164
2165
2166 void
2167 <strong>_onParentMenuRender</strong>
2168 (
2169
2170
2171 p_sType
2172
2173
2174 ,
2175 p_aArgs
2176
2177
2178 ,
2179 p_oSubmenu
2180
2181
2182 )
2183 </code>
2184
2185 <div class="description">
2186 "render" event handler for a submenu. Renders a
2187 submenu in response to the firing of its parent's "render" event.
2188 </div>
2189
2190 <div class="description">
2191
2192 <dl>
2193 <dt>Parameters:</dt>
2194 <dd>
2195 <code>p_sType &lt;String&gt;</code>
2196 String representing the name of the event that
2197 was fired.
2198 </dd>
2199 <dd>
2200 <code>p_aArgs &lt;Array&gt;</code>
2201 Array of arguments sent when the event was fired.
2202 </dd>
2203 <dd>
2204 <code>p_oSubmenu &lt;YAHOO.widget.Menu&gt;</code>
2205 Object representing the submenu that
2206 subscribed to the event.
2207 </dd>
2208 </dl>
2209
2210 <dl>
2211 <dt>Returns:
2212 <code>
2213 void
2214 </code></dt>
2215 <dd></dd>
2216 </dl>
2217
2218 </div>
2219
2220 </div>
2221 <hr />
2222 <h4>
2223 <a name="_onScrollTargetMouseOut">_onScrollTargetMouseOut</a></h4>
2224 <div class="detail">
2225 <code>
2226 protected
2227
2228
2229 void
2230 <strong>_onScrollTargetMouseOut</strong>
2231 (
2232
2233
2234 p_oEvent
2235
2236
2237 ,
2238 p_oMenu
2239
2240
2241 )
2242 </code>
2243
2244 <div class="description">
2245 "mouseout" event handler for the menu's "header" and "footer"
2246 elements. Used to stop scrolling the body of the menu up and down when the
2247 menu's "maxheight" configuration property is set to a value greater than 0.
2248 </div>
2249
2250 <div class="description">
2251
2252 <dl>
2253 <dt>Parameters:</dt>
2254 <dd>
2255 <code>p_oEvent &lt;Event&gt;</code>
2256 Object representing the DOM event object passed
2257 back by the event utility (YAHOO.util.Event).
2258 </dd>
2259 <dd>
2260 <code>p_oMenu &lt;YAHOO.widget.Menu&gt;</code>
2261 Object representing the menu that
2262 fired the event.
2263 </dd>
2264 </dl>
2265
2266 <dl>
2267 <dt>Returns:
2268 <code>
2269 void
2270 </code></dt>
2271 <dd></dd>
2272 </dl>
2273
2274 </div>
2275
2276 </div>
2277 <hr />
2278 <h4>
2279 <a name="_onScrollTargetMouseOver">_onScrollTargetMouseOver</a></h4>
2280 <div class="detail">
2281 <code>
2282 protected
2283
2284
2285 void
2286 <strong>_onScrollTargetMouseOver</strong>
2287 (
2288
2289
2290 p_oEvent
2291
2292
2293 ,
2294 p_oMenu
2295
2296
2297 )
2298 </code>
2299
2300 <div class="description">
2301 "mouseover" event handler for the menu's "header" and "footer"
2302 elements. Used to scroll the body of the menu up and down when the
2303 menu's "maxheight" configuration property is set to a value greater than 0.
2304 </div>
2305
2306 <div class="description">
2307
2308 <dl>
2309 <dt>Parameters:</dt>
2310 <dd>
2311 <code>p_oEvent &lt;Event&gt;</code>
2312 Object representing the DOM event object passed
2313 back by the event utility (YAHOO.util.Event).
2314 </dd>
2315 <dd>
2316 <code>p_oMenu &lt;YAHOO.widget.Menu&gt;</code>
2317 Object representing the menu that
2318 fired the event.
2319 </dd>
2320 </dl>
2321
2322 <dl>
2323 <dt>Returns:
2324 <code>
2325 void
2326 </code></dt>
2327 <dd></dd>
2328 </dl>
2329
2330 </div>
2331
2332 </div>
2333 <hr />
2334 <h4>
2335 <a name="_onShow">_onShow</a></h4>
2336 <div class="detail">
2337 <code>
2338 private
2339
2340
2341 void
2342 <strong>_onShow</strong>
2343 (
2344
2345
2346 p_sType
2347
2348
2349 ,
2350 p_aArgs
2351
2352
2353 ,
2354 p_oMenu
2355
2356
2357 )
2358 </code>
2359
2360 <div class="description">
2361 "show" event handler for the menu.
2362 </div>
2363
2364 <div class="description">
2365
2366 <dl>
2367 <dt>Parameters:</dt>
2368 <dd>
2369 <code>p_sType &lt;String&gt;</code>
2370 String representing the name of the event that
2371 was fired.
2372 </dd>
2373 <dd>
2374 <code>p_aArgs &lt;Array&gt;</code>
2375 Array of arguments sent when the event was fired.
2376 </dd>
2377 <dd>
2378 <code>p_oMenu &lt;YAHOO.widget.Menu&gt;</code>
2379 Object representing the menu that fired
2380 the event.
2381 </dd>
2382 </dl>
2383
2384 <dl>
2385 <dt>Returns:
2386 <code>
2387 void
2388 </code></dt>
2389 <dd></dd>
2390 </dl>
2391
2392 </div>
2393
2394 </div>
2395 <hr />
2396 <h4>
2397 <a name="_onSubmenuBeforeShow">_onSubmenuBeforeShow</a></h4>
2398 <div class="detail">
2399 <code>
2400 private
2401
2402
2403 void
2404 <strong>_onSubmenuBeforeShow</strong>
2405 (
2406
2407
2408 p_sType
2409
2410
2411 ,
2412 p_aArgs
2413
2414
2415 ,
2416 p_oSubmenu
2417
2418
2419 )
2420 </code>
2421
2422 <div class="description">
2423 "beforeshow" event handler for a submenu.
2424 </div>
2425
2426 <div class="description">
2427
2428 <dl>
2429 <dt>Parameters:</dt>
2430 <dd>
2431 <code>p_sType &lt;String&gt;</code>
2432 String representing the name of the event that
2433 was fired.
2434 </dd>
2435 <dd>
2436 <code>p_aArgs &lt;Array&gt;</code>
2437 Array of arguments sent when the event was fired.
2438 </dd>
2439 <dd>
2440 <code>p_oSubmenu &lt;YAHOO.widget.Menu&gt;</code>
2441 Object representing the submenu that
2442 subscribed to the event.
2443 </dd>
2444 </dl>
2445
2446 <dl>
2447 <dt>Returns:
2448 <code>
2449 void
2450 </code></dt>
2451 <dd></dd>
2452 </dl>
2453
2454 </div>
2455
2456 </div>
2457 <hr />
2458 <h4>
2459 <a name="_onSubmenuHide">_onSubmenuHide</a></h4>
2460 <div class="detail">
2461 <code>
2462 private
2463
2464
2465 void
2466 <strong>_onSubmenuHide</strong>
2467 (
2468
2469
2470 p_sType
2471
2472
2473 ,
2474 p_aArgs
2475
2476
2477 ,
2478 p_oSubmenu
2479
2480
2481 )
2482 </code>
2483
2484 <div class="description">
2485 "hide" Custom Event handler for a submenu.
2486 </div>
2487
2488 <div class="description">
2489
2490 <dl>
2491 <dt>Parameters:</dt>
2492 <dd>
2493 <code>p_sType &lt;String&gt;</code>
2494 String representing the name of the event that
2495 was fired.
2496 </dd>
2497 <dd>
2498 <code>p_aArgs &lt;Array&gt;</code>
2499 Array of arguments sent when the event was fired.
2500 </dd>
2501 <dd>
2502 <code>p_oSubmenu &lt;YAHOO.widget.Menu&gt;</code>
2503 Object representing the submenu that
2504 subscribed to the event.
2505 </dd>
2506 </dl>
2507
2508 <dl>
2509 <dt>Returns:
2510 <code>
2511 void
2512 </code></dt>
2513 <dd></dd>
2514 </dl>
2515
2516 </div>
2517
2518 </div>
2519 <hr />
2520 <h4>
2521 <a name="_onSubmenuShow">_onSubmenuShow</a></h4>
2522 <div class="detail">
2523 <code>
2524 private
2525
2526
2527 void
2528 <strong>_onSubmenuShow</strong>
2529 (
2530
2531
2532 p_sType
2533
2534
2535 ,
2536 p_aArgs
2537
2538
2539 ,
2540 p_oSubmenu
2541
2542
2543 )
2544 </code>
2545
2546 <div class="description">
2547 "show" event handler for a submenu.
2548 </div>
2549
2550 <div class="description">
2551
2552 <dl>
2553 <dt>Parameters:</dt>
2554 <dd>
2555 <code>p_sType &lt;String&gt;</code>
2556 String representing the name of the event that
2557 was fired.
2558 </dd>
2559 <dd>
2560 <code>p_aArgs &lt;Array&gt;</code>
2561 Array of arguments sent when the event was fired.
2562 </dd>
2563 <dd>
2564 <code>p_oSubmenu &lt;YAHOO.widget.Menu&gt;</code>
2565 Object representing the submenu that
2566 subscribed to the event.
2567 </dd>
2568 </dl>
2569
2570 <dl>
2571 <dt>Returns:
2572 <code>
2573 void
2574 </code></dt>
2575 <dd></dd>
2576 </dl>
2577
2578 </div>
2579
2580 </div>
2581 <hr />
2582 <h4>
2583 <a name="_onTextResize">_onTextResize</a></h4>
2584 <div class="detail">
2585 <code>
2586 protected
2587
2588
2589 void
2590 <strong>_onTextResize</strong>
2591 (
2592
2593
2594 p_sType
2595
2596
2597 ,
2598 p_aArgs
2599
2600
2601 ,
2602 p_oMenu
2603
2604
2605 )
2606 </code>
2607
2608 <div class="description">
2609 "textresize" event handler for the menu.
2610 </div>
2611
2612 <div class="description">
2613
2614 <dl>
2615 <dt>Parameters:</dt>
2616 <dd>
2617 <code>p_sType &lt;String&gt;</code>
2618 String representing the name of the event that
2619 was fired.
2620 </dd>
2621 <dd>
2622 <code>p_aArgs &lt;Array&gt;</code>
2623 Array of arguments sent when the event was fired.
2624 </dd>
2625 <dd>
2626 <code>p_oMenu &lt;YAHOO.widget.Menu&gt;</code>
2627 Object representing the menu that
2628 fired the event.
2629 </dd>
2630 </dl>
2631
2632 <dl>
2633 <dt>Returns:
2634 <code>
2635 void
2636 </code></dt>
2637 <dd></dd>
2638 </dl>
2639
2640 </div>
2641
2642 </div>
2643 <hr />
2644 <h4>
2645 <a name="_removeItemFromGroupByIndex">_removeItemFromGroupByIndex</a></h4>
2646 <div class="detail">
2647 <code>
2648 private
2649
2650
2651 YAHOO.widget.MenuItem
2652 <strong>_removeItemFromGroupByIndex</strong>
2653 (
2654
2655
2656 p_nGroupIndex
2657
2658
2659 ,
2660 p_nItemIndex
2661
2662
2663 )
2664 </code>
2665
2666 <div class="description">
2667 Removes a menu item from a group by index. Returns the menu
2668 item that was removed.
2669 </div>
2670
2671 <div class="description">
2672
2673 <dl>
2674 <dt>Parameters:</dt>
2675 <dd>
2676 <code>p_nGroupIndex &lt;Number&gt;</code>
2677 Number indicating the group to which the menu
2678 item belongs.
2679 </dd>
2680 <dd>
2681 <code>p_nItemIndex &lt;Number&gt;</code>
2682 Number indicating the index of the menu item
2683 to be removed.
2684 </dd>
2685 </dl>
2686
2687 <dl>
2688 <dt>Returns:
2689 <code>
2690 YAHOO.widget.MenuItem
2691 </code></dt>
2692 <dd></dd>
2693 </dl>
2694
2695 </div>
2696
2697 </div>
2698 <hr />
2699 <h4>
2700 <a name="_removeItemFromGroupByValue">_removeItemFromGroupByValue</a></h4>
2701 <div class="detail">
2702 <code>
2703 private
2704
2705
2706 YAHOO.widget.MenuItem
2707 <strong>_removeItemFromGroupByValue</strong>
2708 (
2709
2710
2711 p_nGroupIndex
2712
2713
2714 ,
2715 p_oItem
2716
2717
2718 )
2719 </code>
2720
2721 <div class="description">
2722 Removes a menu item from a group by reference. Returns the
2723 menu item that was removed.
2724 </div>
2725
2726 <div class="description">
2727
2728 <dl>
2729 <dt>Parameters:</dt>
2730 <dd>
2731 <code>p_nGroupIndex &lt;Number&gt;</code>
2732 Number indicating the group to which the
2733 menu item belongs.
2734 </dd>
2735 <dd>
2736 <code>p_oItem &lt;YAHOO.widget.MenuItem&gt;</code>
2737 Object reference for the MenuItem
2738 instance to be removed.
2739 </dd>
2740 </dl>
2741
2742 <dl>
2743 <dt>Returns:
2744 <code>
2745 YAHOO.widget.MenuItem
2746 </code></dt>
2747 <dd></dd>
2748 </dl>
2749
2750 </div>
2751
2752 </div>
2753 <hr />
2754 <h4>
2755 <a name="_setWidth">_setWidth</a></h4>
2756 <div class="detail">
2757 <code>
2758 private
2759
2760
2761 void
2762 <strong>_setWidth</strong>
2763 (
2764 )
2765 </code>
2766
2767 <div class="description">
2768 Sets the width of the menu's root <code>&#60;div&#62;</code>
2769 element to its offsetWidth.
2770 </div>
2771
2772 <div class="description">
2773
2774
2775 <dl>
2776 <dt>Returns:
2777 <code>
2778 void
2779 </code></dt>
2780 <dd></dd>
2781 </dl>
2782
2783 </div>
2784
2785 </div>
2786 <hr />
2787 <h4>
2788 <a name="_subscribeToItemEvents">_subscribeToItemEvents</a></h4>
2789 <div class="detail">
2790 <code>
2791 private
2792
2793
2794 void
2795 <strong>_subscribeToItemEvents</strong>
2796 (
2797
2798
2799 p_oItem
2800
2801
2802 )
2803 </code>
2804
2805 <div class="description">
2806 Subscribes a menu to a menu item's event.
2807 </div>
2808
2809 <div class="description">
2810
2811 <dl>
2812 <dt>Parameters:</dt>
2813 <dd>
2814 <code>p_oItem &lt;YAHOO.widget.MenuItem&gt;</code>
2815 Object reference for the MenuItem
2816 instance whose events should be subscribed to.
2817 </dd>
2818 </dl>
2819
2820 <dl>
2821 <dt>Returns:
2822 <code>
2823 void
2824 </code></dt>
2825 <dd></dd>
2826 </dl>
2827
2828 </div>
2829
2830 </div>
2831 <hr />
2832 <h4>
2833 <a name="_updateItemProperties">_updateItemProperties</a></h4>
2834 <div class="detail">
2835 <code>
2836 private
2837
2838
2839 void
2840 <strong>_updateItemProperties</strong>
2841 (
2842
2843
2844 p_nGroupIndex
2845
2846
2847 )
2848 </code>
2849
2850 <div class="description">
2851 Updates the "index," "groupindex," and "className" properties
2852 of the menu items in the specified group.
2853 </div>
2854
2855 <div class="description">
2856
2857 <dl>
2858 <dt>Parameters:</dt>
2859 <dd>
2860 <code>p_nGroupIndex &lt;Number&gt;</code>
2861 Number indicating the group of items to update.
2862 </dd>
2863 </dl>
2864
2865 <dl>
2866 <dt>Returns:
2867 <code>
2868 void
2869 </code></dt>
2870 <dd></dd>
2871 </dl>
2872
2873 </div>
2874
2875 </div>
2876 <hr />
2877 <h4>
2878 <a name="addItem">addItem</a></h4>
2879 <div class="detail">
2880 <code>
2881
2882
2883
2884 YAHOO.widget.MenuItem
2885 <strong>addItem</strong>
2886 (
2887
2888
2889 p_oItem
2890
2891
2892
2893
2894
2895
2896 ,
2897 p_nGroupIndex
2898
2899
2900 )
2901 </code>
2902
2903 <div class="description">
2904 Appends an item to the menu.
2905 </div>
2906
2907 <div class="description">
2908
2909 <dl>
2910 <dt>Parameters:</dt>
2911 <dd>
2912 <code>p_oItem &lt;YAHOO.widget.MenuItem&gt;</code>
2913 Object reference for the MenuItem
2914 instance to be added to the menu.
2915 </dd>
2916 <dd>
2917 <code>p_oItem &lt;String&gt;</code>
2918 String specifying the text of the item to be added
2919 to the menu.
2920 </dd>
2921 <dd>
2922 <code>p_oItem &lt;Object&gt;</code>
2923 Object literal containing a set of menu item
2924 configuration properties.
2925 </dd>
2926 <dd>
2927 <code>p_nGroupIndex &lt;Number&gt;</code>
2928 Optional. Number indicating the group to
2929 which the item belongs.
2930 </dd>
2931 </dl>
2932
2933 <dl>
2934 <dt>Returns:
2935 <code>
2936 YAHOO.widget.MenuItem
2937 </code></dt>
2938 <dd></dd>
2939 </dl>
2940
2941 </div>
2942
2943 </div>
2944 <hr />
2945 <h4>
2946 <a name="addItems">addItems</a></h4>
2947 <div class="detail">
2948 <code>
2949
2950
2951
2952 Array
2953 <strong>addItems</strong>
2954 (
2955
2956
2957 p_aItems
2958
2959
2960 ,
2961 p_nGroupIndex
2962
2963
2964 )
2965 </code>
2966
2967 <div class="description">
2968 Adds an array of items to the menu.
2969 </div>
2970
2971 <div class="description">
2972
2973 <dl>
2974 <dt>Parameters:</dt>
2975 <dd>
2976 <code>p_aItems &lt;Array&gt;</code>
2977 Array of items to be added to the menu. The array
2978 can contain strings specifying the text for each item to be created, object
2979 literals specifying each of the menu item configuration properties,
2980 or MenuItem instances.
2981 </dd>
2982 <dd>
2983 <code>p_nGroupIndex &lt;Number&gt;</code>
2984 Optional. Number specifying the group to
2985 which the items belongs.
2986 </dd>
2987 </dl>
2988
2989 <dl>
2990 <dt>Returns:
2991 <code>
2992 Array
2993 </code></dt>
2994 <dd></dd>
2995 </dl>
2996
2997 </div>
2998
2999 </div>
3000 <hr />
3001 <h4>
3002 <a name="clearActiveItem">clearActiveItem</a></h4>
3003 <div class="detail">
3004 <code>
3005
3006
3007
3008 void
3009 <strong>clearActiveItem</strong>
3010 (
3011
3012
3013 p_bBlur
3014
3015
3016 )
3017 </code>
3018
3019 <div class="description">
3020 Sets the "selected" configuration property of the menu's active
3021 item to "false" and hides the item's submenu.
3022 </div>
3023
3024 <div class="description">
3025
3026 <dl>
3027 <dt>Parameters:</dt>
3028 <dd>
3029 <code>p_bBlur &lt;Boolean&gt;</code>
3030 Boolean indicating if the menu's active item
3031 should be blurred.
3032 </dd>
3033 </dl>
3034
3035 <dl>
3036 <dt>Returns:
3037 <code>
3038 void
3039 </code></dt>
3040 <dd></dd>
3041 </dl>
3042
3043 </div>
3044
3045 </div>
3046 <hr />
3047 <h4>
3048 <a name="clearContent">clearContent</a></h4>
3049 <div class="detail">
3050 <code>
3051
3052
3053
3054 void
3055 <strong>clearContent</strong>
3056 (
3057 )
3058 </code>
3059
3060 <div class="description">
3061 Removes all of the content from the menu, including the menu
3062 items, group titles, header and footer.
3063 </div>
3064
3065 <div class="description">
3066
3067
3068 <dl>
3069 <dt>Returns:
3070 <code>
3071 void
3072 </code></dt>
3073 <dd></dd>
3074 </dl>
3075
3076 </div>
3077
3078 </div>
3079 <hr />
3080 <h4>
3081 <a name="configClassName">configClassName</a></h4>
3082 <div class="detail">
3083 <code>
3084
3085
3086
3087 void
3088 <strong>configClassName</strong>
3089 (
3090
3091
3092 p_sType
3093
3094
3095 ,
3096 p_aArgs
3097
3098
3099 ,
3100 p_oMenu
3101
3102
3103 )
3104 </code>
3105
3106 <div class="description">
3107 Event handler for when the "classname" configuration property of
3108 a menu changes.
3109 </div>
3110
3111 <div class="description">
3112
3113 <dl>
3114 <dt>Parameters:</dt>
3115 <dd>
3116 <code>p_sType &lt;String&gt;</code>
3117 The name of the event that was fired.
3118 </dd>
3119 <dd>
3120 <code>p_aArgs &lt;Array&gt;</code>
3121 Collection of arguments sent when the event was fired.
3122 </dd>
3123 <dd>
3124 <code>p_oMenu &lt;YAHOO.widget.Menu&gt;</code>
3125 The Menu instance fired the event.
3126 </dd>
3127 </dl>
3128
3129 <dl>
3130 <dt>Returns:
3131 <code>
3132 void
3133 </code></dt>
3134 <dd></dd>
3135 </dl>
3136
3137 </div>
3138
3139 </div>
3140 <hr />
3141 <h4>
3142 <a name="configContainer">configContainer</a></h4>
3143 <div class="detail">
3144 <code>
3145
3146
3147
3148 void
3149 <strong>configContainer</strong>
3150 (
3151
3152
3153 p_sType
3154
3155
3156 ,
3157 p_aArgs
3158
3159
3160 ,
3161 p_oMenu
3162
3163
3164 )
3165 </code>
3166
3167 <div class="description">
3168 Event handler for when the "container" configuration property
3169 of the menu changes.
3170 </div>
3171
3172 <div class="description">
3173
3174 <dl>
3175 <dt>Parameters:</dt>
3176 <dd>
3177 <code>p_sType &lt;String&gt;</code>
3178 String representing the name of the event that
3179 was fired.
3180 </dd>
3181 <dd>
3182 <code>p_aArgs &lt;Array&gt;</code>
3183 Array of arguments sent when the event was fired.
3184 </dd>
3185 <dd>
3186 <code>p_oMenu &lt;YAHOO.widget.Menu&gt;</code>
3187 Object representing the menu that
3188 fired the event.
3189 </dd>
3190 </dl>
3191
3192 <dl>
3193 <dt>Returns:
3194 <code>
3195 void
3196 </code></dt>
3197 <dd></dd>
3198 </dl>
3199
3200 </div>
3201
3202 </div>
3203 <hr />
3204 <h4>
3205 <a name="configHideDelay">configHideDelay</a></h4>
3206 <div class="detail">
3207 <code>
3208
3209
3210
3211 void
3212 <strong>configHideDelay</strong>
3213 (
3214
3215
3216 p_sType
3217
3218
3219 ,
3220 p_aArgs
3221
3222
3223 ,
3224 p_oMenu
3225
3226
3227 )
3228 </code>
3229
3230 <div class="description">
3231 Event handler for when the "hidedelay" configuration property
3232 of the menu changes.
3233 </div>
3234
3235 <div class="description">
3236
3237 <dl>
3238 <dt>Parameters:</dt>
3239 <dd>
3240 <code>p_sType &lt;String&gt;</code>
3241 String representing the name of the event that
3242 was fired.
3243 </dd>
3244 <dd>
3245 <code>p_aArgs &lt;Array&gt;</code>
3246 Array of arguments sent when the event was fired.
3247 </dd>
3248 <dd>
3249 <code>p_oMenu &lt;YAHOO.widget.Menu&gt;</code>
3250 Object representing the menu that
3251 fired the event.
3252 </dd>
3253 </dl>
3254
3255 <dl>
3256 <dt>Returns:
3257 <code>
3258 void
3259 </code></dt>
3260 <dd></dd>
3261 </dl>
3262
3263 </div>
3264
3265 </div>
3266 <hr />
3267 <h4>
3268 <a name="configIframe">configIframe</a></h4>
3269 <div class="detail">
3270 <code>
3271
3272
3273
3274 void
3275 <strong>configIframe</strong>
3276 (
3277
3278
3279 p_sType
3280
3281
3282 ,
3283 p_aArgs
3284
3285
3286 ,
3287 p_oMenu
3288
3289
3290 )
3291 </code>
3292
3293 <div class="description">
3294 Event handler for when the "iframe" configuration property of
3295 the menu changes.
3296 </div>
3297
3298 <div class="description">
3299
3300 <dl>
3301 <dt>Parameters:</dt>
3302 <dd>
3303 <code>p_sType &lt;String&gt;</code>
3304 String representing the name of the event that
3305 was fired.
3306 </dd>
3307 <dd>
3308 <code>p_aArgs &lt;Array&gt;</code>
3309 Array of arguments sent when the event was fired.
3310 </dd>
3311 <dd>
3312 <code>p_oMenu &lt;YAHOO.widget.Menu&gt;</code>
3313 Object representing the menu that
3314 fired the event.
3315 </dd>
3316 </dl>
3317
3318 <dl>
3319 <dt>Returns:
3320 <code>
3321 void
3322 </code></dt>
3323 <dd></dd>
3324 </dl>
3325
3326 </div>
3327
3328 </div>
3329 <hr />
3330 <h4>
3331 <a name="configMaxHeight">configMaxHeight</a></h4>
3332 <div class="detail">
3333 <code>
3334
3335
3336
3337 void
3338 <strong>configMaxHeight</strong>
3339 (
3340
3341
3342 p_sType
3343
3344
3345 ,
3346 p_aArgs
3347
3348
3349 ,
3350 p_oMenu
3351
3352
3353 )
3354 </code>
3355
3356 <div class="description">
3357 Event handler for when the "maxheight" configuration property of
3358 a Menu changes.
3359 </div>
3360
3361 <div class="description">
3362
3363 <dl>
3364 <dt>Parameters:</dt>
3365 <dd>
3366 <code>p_sType &lt;String&gt;</code>
3367 The name of the event that was fired.
3368 </dd>
3369 <dd>
3370 <code>p_aArgs &lt;Array&gt;</code>
3371 Collection of arguments sent when the event
3372 was fired.
3373 </dd>
3374 <dd>
3375 <code>p_oMenu &lt;YAHOO.widget.Menu&gt;</code>
3376 The Menu instance fired
3377 the event.
3378 </dd>
3379 </dl>
3380
3381 <dl>
3382 <dt>Returns:
3383 <code>
3384 void
3385 </code></dt>
3386 <dd></dd>
3387 </dl>
3388
3389 </div>
3390
3391 </div>
3392 <hr />
3393 <h4>
3394 <a name="configPosition">configPosition</a></h4>
3395 <div class="detail">
3396 <code>
3397
3398
3399
3400 void
3401 <strong>configPosition</strong>
3402 (
3403
3404
3405 p_sType
3406
3407
3408 ,
3409 p_aArgs
3410
3411
3412 ,
3413 p_oMenu
3414
3415
3416 )
3417 </code>
3418
3419 <div class="description">
3420 Event handler for when the "position" configuration property
3421 of the menu changes.
3422 </div>
3423
3424 <div class="description">
3425
3426 <dl>
3427 <dt>Parameters:</dt>
3428 <dd>
3429 <code>p_sType &lt;String&gt;</code>
3430 String representing the name of the event that
3431 was fired.
3432 </dd>
3433 <dd>
3434 <code>p_aArgs &lt;Array&gt;</code>
3435 Array of arguments sent when the event was fired.
3436 </dd>
3437 <dd>
3438 <code>p_oMenu &lt;YAHOO.widget.Menu&gt;</code>
3439 Object representing the menu that
3440 fired the event.
3441 </dd>
3442 </dl>
3443
3444 <dl>
3445 <dt>Returns:
3446 <code>
3447 void
3448 </code></dt>
3449 <dd></dd>
3450 </dl>
3451
3452 </div>
3453
3454 </div>
3455 <hr />
3456 <h4>
3457 <a name="configVisible">configVisible</a></h4>
3458 <div class="detail">
3459 <code>
3460
3461
3462
3463 void
3464 <strong>configVisible</strong>
3465 (
3466
3467
3468 p_sType
3469
3470
3471 ,
3472 p_aArgs
3473
3474
3475 ,
3476 p_oMenu
3477
3478
3479 )
3480 </code>
3481
3482 <div class="description">
3483 Event handler for when the "visible" configuration property
3484 the menu changes.
3485 </div>
3486
3487 <div class="description">
3488
3489 <dl>
3490 <dt>Parameters:</dt>
3491 <dd>
3492 <code>p_sType &lt;String&gt;</code>
3493 String representing the name of the event that
3494 was fired.
3495 </dd>
3496 <dd>
3497 <code>p_aArgs &lt;Array&gt;</code>
3498 Array of arguments sent when the event was fired.
3499 </dd>
3500 <dd>
3501 <code>p_oMenu &lt;YAHOO.widget.Menu&gt;</code>
3502 Object representing the menu that
3503 fired the event.
3504 </dd>
3505 </dl>
3506
3507 <dl>
3508 <dt>Returns:
3509 <code>
3510 void
3511 </code></dt>
3512 <dd></dd>
3513 </dl>
3514
3515 </div>
3516
3517 </div>
3518 <hr />
3519 <h4>
3520 <a name="destroy">destroy</a></h4>
3521 <div class="detail">
3522 <code>
3523
3524
3525
3526 void
3527 <strong>destroy</strong>
3528 (
3529 )
3530 </code>
3531
3532 <div class="description">
3533 Removes the menu's <code>&#60;div&#62;</code> element
3534 (and accompanying child nodes) from the document.
3535 </div>
3536
3537 <div class="description">
3538
3539
3540 <dl>
3541 <dt>Returns:
3542 <code>
3543 void
3544 </code></dt>
3545 <dd></dd>
3546 </dl>
3547
3548 </div>
3549
3550 </div>
3551 <hr />
3552 <h4>
3553 <a name="enforceConstraints">enforceConstraints</a></h4>
3554 <div class="detail">
3555 <code>
3556
3557
3558
3559 void
3560 <strong>enforceConstraints</strong>
3561 (
3562
3563
3564 type
3565
3566
3567 ,
3568 args
3569
3570
3571 ,
3572 obj
3573
3574
3575 )
3576 </code>
3577
3578 <div class="description">
3579 The default event handler executed when the moveEvent is fired,
3580 if the "constraintoviewport" configuration property is set to true.
3581 </div>
3582
3583 <div class="description">
3584
3585 <dl>
3586 <dt>Parameters:</dt>
3587 <dd>
3588 <code>type &lt;String&gt;</code>
3589 The name of the event that was fired.
3590 </dd>
3591 <dd>
3592 <code>args &lt;Array&gt;</code>
3593 Collection of arguments sent when the
3594 event was fired.
3595 </dd>
3596 <dd>
3597 <code>obj &lt;Array&gt;</code>
3598 Array containing the current Menu instance
3599 and the item that fired the event.
3600 </dd>
3601 </dl>
3602
3603 <dl>
3604 <dt>Returns:
3605 <code>
3606 void
3607 </code></dt>
3608 <dd></dd>
3609 </dl>
3610
3611 </div>
3612
3613 </div>
3614 <hr />
3615 <h4>
3616 <a name="getItem">getItem</a></h4>
3617 <div class="detail">
3618 <code>
3619
3620
3621
3622 YAHOO.widget.MenuItem
3623 <strong>getItem</strong>
3624 (
3625
3626
3627 p_nItemIndex
3628
3629
3630 ,
3631 p_nGroupIndex
3632
3633
3634 )
3635 </code>
3636
3637 <div class="description">
3638 Returns the item at the specified index.
3639 </div>
3640
3641 <div class="description">
3642
3643 <dl>
3644 <dt>Parameters:</dt>
3645 <dd>
3646 <code>p_nItemIndex &lt;Number&gt;</code>
3647 Number indicating the ordinal position of the
3648 item to be retrieved.
3649 </dd>
3650 <dd>
3651 <code>p_nGroupIndex &lt;Number&gt;</code>
3652 Optional. Number indicating the group to which
3653 the item belongs.
3654 </dd>
3655 </dl>
3656
3657 <dl>
3658 <dt>Returns:
3659 <code>
3660 YAHOO.widget.MenuItem
3661 </code></dt>
3662 <dd></dd>
3663 </dl>
3664
3665 </div>
3666
3667 </div>
3668 <hr />
3669 <h4>
3670 <a name="getItemGroups">getItemGroups</a></h4>
3671 <div class="detail">
3672 <code>
3673
3674
3675
3676 Array
3677 <strong>getItemGroups</strong>
3678 (
3679 )
3680 </code>
3681
3682 <div class="description">
3683 Multi-dimensional Array representing the menu items as they
3684 are grouped in the menu.
3685 </div>
3686
3687 <div class="description">
3688
3689
3690 <dl>
3691 <dt>Returns:
3692 <code>
3693 Array
3694 </code></dt>
3695 <dd></dd>
3696 </dl>
3697
3698 </div>
3699
3700 </div>
3701 <hr />
3702 <h4>
3703 <a name="getItems">getItems</a></h4>
3704 <div class="detail">
3705 <code>
3706
3707
3708
3709 Array
3710 <strong>getItems</strong>
3711 (
3712 )
3713 </code>
3714
3715 <div class="description">
3716 Returns an array of all of the items in the menu.
3717 </div>
3718
3719 <div class="description">
3720
3721
3722 <dl>
3723 <dt>Returns:
3724 <code>
3725 Array
3726 </code></dt>
3727 <dd></dd>
3728 </dl>
3729
3730 </div>
3731
3732 </div>
3733 <hr />
3734 <h4>
3735 <a name="getRoot">getRoot</a></h4>
3736 <div class="detail">
3737 <code>
3738
3739
3740
3741 void
3742 <strong>getRoot</strong>
3743 (
3744 )
3745 </code>
3746
3747 <div class="description">
3748 Finds the menu's root menu.
3749 </div>
3750
3751 <div class="description">
3752
3753
3754 <dl>
3755 <dt>Returns:
3756 <code>
3757 void
3758 </code></dt>
3759 <dd></dd>
3760 </dl>
3761
3762 </div>
3763
3764 </div>
3765 <hr />
3766 <h4>
3767 <a name="init">init</a></h4>
3768 <div class="detail">
3769 <code>
3770
3771
3772
3773 void
3774 <strong>init</strong>
3775 (
3776
3777
3778 p_oElement
3779
3780
3781
3782
3783
3784
3785
3786
3787 ,
3788 p_oConfig
3789
3790
3791 )
3792 </code>
3793
3794 <div class="description">
3795 The Menu class's initialization method. This method is
3796 automatically called by the constructor, and sets up all DOM references
3797 for pre-existing markup, and creates required markup if it is not
3798 already present.
3799 </div>
3800
3801 <div class="description">
3802
3803 <dl>
3804 <dt>Parameters:</dt>
3805 <dd>
3806 <code>p_oElement &lt;String&gt;</code>
3807 String specifying the id attribute of the
3808 <code>&#60;div&#62;</code> element of the menu.
3809 </dd>
3810 <dd>
3811 <code>p_oElement &lt;String&gt;</code>
3812 String specifying the id attribute of the
3813 <code>&#60;select&#62;</code> element to be used as the data source
3814 for the menu.
3815 </dd>
3816 <dd>
3817 <code>p_oElement &lt;<a href="http://www.w3.org/TR/2000/WD-DOM-Level-1-20000929/
3818 level-one-html.html#ID-22445964">HTMLDivElement</a>&gt;</code>
3819 Object
3820 specifying the <code>&#60;div&#62;</code> element of the menu.
3821 </dd>
3822 <dd>
3823 <code>p_oElement &lt;<a href="http://www.w3.org/TR/2000/WD-DOM-Level-1-20000929/
3824 level-one-html.html#ID-94282980">HTMLSelectElement</a>&gt;</code>
3825
3826 Object specifying the <code>&#60;select&#62;</code> element to be used as
3827 the data source for the menu.
3828 </dd>
3829 <dd>
3830 <code>p_oConfig &lt;Object&gt;</code>
3831 Optional. Object literal specifying the
3832 configuration for the menu. See configuration class documentation for
3833 more details.
3834 </dd>
3835 </dl>
3836
3837 <dl>
3838 <dt>Returns:
3839 <code>
3840 void
3841 </code></dt>
3842 <dd></dd>
3843 </dl>
3844
3845 </div>
3846
3847 </div>
3848 <hr />
3849 <h4>
3850 <a name="initDefaultConfig">initDefaultConfig</a></h4>
3851 <div class="detail">
3852 <code>
3853
3854
3855
3856 void
3857 <strong>initDefaultConfig</strong>
3858 (
3859 )
3860 </code>
3861
3862 <div class="description">
3863 Initializes the class's configurable properties which can be
3864 changed using the menu's Config object ("cfg").
3865 </div>
3866
3867 <div class="description">
3868
3869
3870 <dl>
3871 <dt>Returns:
3872 <code>
3873 void
3874 </code></dt>
3875 <dd></dd>
3876 </dl>
3877
3878 </div>
3879
3880 </div>
3881 <hr />
3882 <h4>
3883 <a name="initEvents">initEvents</a></h4>
3884 <div class="detail">
3885 <code>
3886
3887
3888
3889 void
3890 <strong>initEvents</strong>
3891 (
3892 )
3893 </code>
3894
3895 <div class="description">
3896 Initializes the custom events for the menu.
3897 </div>
3898
3899 <div class="description">
3900
3901
3902 <dl>
3903 <dt>Returns:
3904 <code>
3905 void
3906 </code></dt>
3907 <dd></dd>
3908 </dl>
3909
3910 </div>
3911
3912 </div>
3913 <hr />
3914 <h4>
3915 <a name="insertItem">insertItem</a></h4>
3916 <div class="detail">
3917 <code>
3918
3919
3920
3921 YAHOO.widget.MenuItem
3922 <strong>insertItem</strong>
3923 (
3924
3925
3926 p_oItem
3927
3928
3929
3930
3931
3932
3933 ,
3934 p_nItemIndex
3935
3936
3937 ,
3938 p_nGroupIndex
3939
3940
3941 )
3942 </code>
3943
3944 <div class="description">
3945 Inserts an item into the menu at the specified index.
3946 </div>
3947
3948 <div class="description">
3949
3950 <dl>
3951 <dt>Parameters:</dt>
3952 <dd>
3953 <code>p_oItem &lt;YAHOO.widget.MenuItem&gt;</code>
3954 Object reference for the MenuItem
3955 instance to be added to the menu.
3956 </dd>
3957 <dd>
3958 <code>p_oItem &lt;String&gt;</code>
3959 String specifying the text of the item to be added
3960 to the menu.
3961 </dd>
3962 <dd>
3963 <code>p_oItem &lt;Object&gt;</code>
3964 Object literal containing a set of menu item
3965 configuration properties.
3966 </dd>
3967 <dd>
3968 <code>p_nItemIndex &lt;Number&gt;</code>
3969 Number indicating the ordinal position at which
3970 the item should be added.
3971 </dd>
3972 <dd>
3973 <code>p_nGroupIndex &lt;Number&gt;</code>
3974 Optional. Number indicating the group to which
3975 the item belongs.
3976 </dd>
3977 </dl>
3978
3979 <dl>
3980 <dt>Returns:
3981 <code>
3982 YAHOO.widget.MenuItem
3983 </code></dt>
3984 <dd></dd>
3985 </dl>
3986
3987 </div>
3988
3989 </div>
3990 <hr />
3991 <h4>
3992 <a name="removeItem">removeItem</a></h4>
3993 <div class="detail">
3994 <code>
3995
3996
3997
3998 YAHOO.widget.MenuItem
3999 <strong>removeItem</strong>
4000 (
4001
4002
4003 p_oObject
4004
4005
4006
4007
4008 ,
4009 p_nGroupIndex
4010
4011
4012 )
4013 </code>
4014
4015 <div class="description">
4016 Removes the specified item from the menu.
4017 </div>
4018
4019 <div class="description">
4020
4021 <dl>
4022 <dt>Parameters:</dt>
4023 <dd>
4024 <code>p_oObject &lt;YAHOO.widget.MenuItem&gt;</code>
4025 Object reference for the MenuItem
4026 instance to be removed from the menu.
4027 </dd>
4028 <dd>
4029 <code>p_oObject &lt;Number&gt;</code>
4030 Number specifying the index of the item
4031 to be removed.
4032 </dd>
4033 <dd>
4034 <code>p_nGroupIndex &lt;Number&gt;</code>
4035 Optional. Number specifying the group to
4036 which the item belongs.
4037 </dd>
4038 </dl>
4039
4040 <dl>
4041 <dt>Returns:
4042 <code>
4043 YAHOO.widget.MenuItem
4044 </code></dt>
4045 <dd></dd>
4046 </dl>
4047
4048 </div>
4049
4050 </div>
4051 <hr />
4052 <h4>
4053 <a name="setInitialFocus">setInitialFocus</a></h4>
4054 <div class="detail">
4055 <code>
4056
4057
4058
4059 void
4060 <strong>setInitialFocus</strong>
4061 (
4062 )
4063 </code>
4064
4065 <div class="description">
4066 Sets focus to the menu's first enabled item.
4067 </div>
4068
4069 <div class="description">
4070
4071
4072 <dl>
4073 <dt>Returns:
4074 <code>
4075 void
4076 </code></dt>
4077 <dd></dd>
4078 </dl>
4079
4080 </div>
4081
4082 </div>
4083 <hr />
4084 <h4>
4085 <a name="setInitialSelection">setInitialSelection</a></h4>
4086 <div class="detail">
4087 <code>
4088
4089
4090
4091 void
4092 <strong>setInitialSelection</strong>
4093 (
4094 )
4095 </code>
4096
4097 <div class="description">
4098 Sets the "selected" configuration property of the menu's first
4099 enabled item to "true."
4100 </div>
4101
4102 <div class="description">
4103
4104
4105 <dl>
4106 <dt>Returns:
4107 <code>
4108 void
4109 </code></dt>
4110 <dd></dd>
4111 </dl>
4112
4113 </div>
4114
4115 </div>
4116 <hr />
4117 <h4>
4118 <a name="setItemGroupTitle">setItemGroupTitle</a></h4>
4119 <div class="detail">
4120 <code>
4121
4122
4123
4124 void
4125 <strong>setItemGroupTitle</strong>
4126 (
4127
4128
4129 p_sGroupTitle
4130
4131
4132 ,
4133 p_nGroupIndex
4134
4135
4136 )
4137 </code>
4138
4139 <div class="description">
4140 Sets the title of a group of menu items.
4141 </div>
4142
4143 <div class="description">
4144
4145 <dl>
4146 <dt>Parameters:</dt>
4147 <dd>
4148 <code>p_sGroupTitle &lt;String&gt;</code>
4149 String specifying the title of the group.
4150 </dd>
4151 <dd>
4152 <code>p_nGroupIndex &lt;Number&gt;</code>
4153 Optional. Number specifying the group to which
4154 the title belongs.
4155 </dd>
4156 </dl>
4157
4158 <dl>
4159 <dt>Returns:
4160 <code>
4161 void
4162 </code></dt>
4163 <dd></dd>
4164 </dl>
4165
4166 </div>
4167
4168 </div>
4169 <hr />
4170 <h4>
4171 <a name="toString">toString</a></h4>
4172 <div class="detail">
4173 <code>
4174
4175
4176
4177 String
4178 <strong>toString</strong>
4179 (
4180 )
4181 </code>
4182
4183 <div class="description">
4184 Returns a string representing the menu.
4185 </div>
4186
4187 <div class="description">
4188
4189
4190 <dl>
4191 <dt>Returns:
4192 <code>
4193 String
4194 </code></dt>
4195 <dd></dd>
4196 </dl>
4197
4198 </div>
4199
4200 </div>
4201 <hr />
4202 </div>
4203 </div>
4204
4205 <div class="section field inheritance">
4206 <h4>Methods inherited from <a href="YAHOO.widget.Module.html">YAHOO.widget.Module</a>:</h4>
4207 <div class="content">
4208 <code>
4209
4210 <a href="YAHOO.widget.Module.html#appendToBody">appendToBody</a>,
4211 <a href="YAHOO.widget.Module.html#appendToFooter">appendToFooter</a>,
4212 <a href="YAHOO.widget.Module.html#appendToHeader">appendToHeader</a>,
4213 <a href="YAHOO.widget.Module.html#configMonitorResize">configMonitorResize</a>,
4214 <a href="YAHOO.widget.Module.html#configVisible">configVisible</a>,
4215 <a href="YAHOO.widget.Module.html#destroy">destroy</a>,
4216 <a href="YAHOO.widget.Module.html#hide">hide</a>,
4217 <a href="YAHOO.widget.Module.html#init">init</a>,
4218 <a href="YAHOO.widget.Module.html#initDefaultConfig">initDefaultConfig</a>,
4219 <a href="YAHOO.widget.Module.html#initEvents">initEvents</a>,
4220 <a href="YAHOO.widget.Module.html#initResizeMonitor">initResizeMonitor</a>,
4221 <a href="YAHOO.widget.Module.html#onDomResize">onDomResize</a>,
4222 <a href="YAHOO.widget.Module.html#render">render</a>,
4223 <a href="YAHOO.widget.Module.html#setBody">setBody</a>,
4224 <a href="YAHOO.widget.Module.html#setFooter">setFooter</a>,
4225 <a href="YAHOO.widget.Module.html#setHeader">setHeader</a>,
4226 <a href="YAHOO.widget.Module.html#show">show</a>,
4227 <a href="YAHOO.widget.Module.html#toString">toString</a>
4228 </code>
4229 </div>
4230 </div>
4231 <div class="section field inheritance">
4232 <h4>Methods inherited from <a href="YAHOO.widget.Overlay.html">YAHOO.widget.Overlay</a>:</h4>
4233 <div class="content">
4234 <code>
4235
4236 <a href="YAHOO.widget.Overlay.html#align">align</a>,
4237 <a href="YAHOO.widget.Overlay.html#center">center</a>,
4238 <a href="YAHOO.widget.Overlay.html#configConstrainToViewport">configConstrainToViewport</a>,
4239 <a href="YAHOO.widget.Overlay.html#configContext">configContext</a>,
4240 <a href="YAHOO.widget.Overlay.html#configFixedCenter">configFixedCenter</a>,
4241 <a href="YAHOO.widget.Overlay.html#configHeight">configHeight</a>,
4242 <a href="YAHOO.widget.Overlay.html#configIframe">configIframe</a>,
4243 <a href="YAHOO.widget.Overlay.html#configVisible">configVisible</a>,
4244 <a href="YAHOO.widget.Overlay.html#configWidth">configWidth</a>,
4245 <a href="YAHOO.widget.Overlay.html#configX">configX</a>,
4246 <a href="YAHOO.widget.Overlay.html#configXY">configXY</a>,
4247 <a href="YAHOO.widget.Overlay.html#configY">configY</a>,
4248 <a href="YAHOO.widget.Overlay.html#configzIndex">configzIndex</a>,
4249 <a href="YAHOO.widget.Overlay.html#destroy">destroy</a>,
4250 <a href="YAHOO.widget.Overlay.html#doCenterOnDOMEvent">doCenterOnDOMEvent</a>,
4251 <a href="YAHOO.widget.Overlay.html#enforceConstraints">enforceConstraints</a>,
4252 <a href="YAHOO.widget.Overlay.html#hideIframe">hideIframe</a>,
4253 <a href="YAHOO.widget.Overlay.html#hideMacGeckoScrollbars">hideMacGeckoScrollbars</a>,
4254 <a href="YAHOO.widget.Overlay.html#init">init</a>,
4255 <a href="YAHOO.widget.Overlay.html#initDefaultConfig">initDefaultConfig</a>,
4256 <a href="YAHOO.widget.Overlay.html#initEvents">initEvents</a>,
4257 <a href="YAHOO.widget.Overlay.html#moveTo">moveTo</a>,
4258 <a href="YAHOO.widget.Overlay.html#onDomResize">onDomResize</a>,
4259 <a href="YAHOO.widget.Overlay.html#showIframe">showIframe</a>,
4260 <a href="YAHOO.widget.Overlay.html#showMacGeckoScrollbars">showMacGeckoScrollbars</a>,
4261 <a href="YAHOO.widget.Overlay.html#syncPosition">syncPosition</a>,
4262 <a href="YAHOO.widget.Overlay.html#toString">toString</a>
4263 </code>
4264 </div>
4265 </div>
4266
4267 <div class="section method details">
4268 <h3><a name="methodDetails">Events</a></h3>
4269 <div class="content">
4270 <h4>
4271 <a name="clickEvent">clickEvent</a></h4>
4272 <div class="detail">
4273 <code>
4274
4275
4276
4277 <strong>clickEvent</strong>
4278
4279 (
4280 )
4281
4282 </code>
4283
4284 <div class="description">
4285 Fires when the user clicks the on the menu. Passes back the
4286 DOM Event object as an argument.
4287 </div>
4288
4289 <div class="description">
4290
4291
4292
4293
4294 </div>
4295
4296 </div>
4297 <hr />
4298 <h4>
4299 <a name="itemAddedEvent">itemAddedEvent</a></h4>
4300 <div class="detail">
4301 <code>
4302
4303
4304
4305 <strong>itemAddedEvent</strong>
4306
4307 (
4308 )
4309
4310 </code>
4311
4312 <div class="description">
4313 Fires when an item is added to the menu.
4314 </div>
4315
4316 <div class="description">
4317
4318
4319
4320
4321 </div>
4322
4323 </div>
4324 <hr />
4325 <h4>
4326 <a name="itemRemovedEvent">itemRemovedEvent</a></h4>
4327 <div class="detail">
4328 <code>
4329
4330
4331
4332 <strong>itemRemovedEvent</strong>
4333
4334 (
4335 )
4336
4337 </code>
4338
4339 <div class="description">
4340 Fires when an item is removed to the menu.
4341 </div>
4342
4343 <div class="description">
4344
4345
4346
4347
4348 </div>
4349
4350 </div>
4351 <hr />
4352 <h4>
4353 <a name="keyDownEvent">keyDownEvent</a></h4>
4354 <div class="detail">
4355 <code>
4356
4357
4358
4359 <strong>keyDownEvent</strong>
4360
4361 (
4362 )
4363
4364 </code>
4365
4366 <div class="description">
4367 Fires when the user presses a key when one of the menu's items
4368 has focus. Passes back the DOM Event object as an argument.
4369 </div>
4370
4371 <div class="description">
4372
4373
4374
4375
4376 </div>
4377
4378 </div>
4379 <hr />
4380 <h4>
4381 <a name="keyPressEvent">keyPressEvent</a></h4>
4382 <div class="detail">
4383 <code>
4384
4385
4386
4387 <strong>keyPressEvent</strong>
4388
4389 (
4390 )
4391
4392 </code>
4393
4394 <div class="description">
4395 Fires when the user presses an alphanumeric key when one of the
4396 menu's items has focus. Passes back the DOM Event object as an argument.
4397 </div>
4398
4399 <div class="description">
4400
4401
4402
4403
4404 </div>
4405
4406 </div>
4407 <hr />
4408 <h4>
4409 <a name="keyUpEvent">keyUpEvent</a></h4>
4410 <div class="detail">
4411 <code>
4412
4413
4414
4415 <strong>keyUpEvent</strong>
4416
4417 (
4418 )
4419
4420 </code>
4421
4422 <div class="description">
4423 Fires when the user releases a key when one of the menu's items
4424 has focus. Passes back the DOM Event object as an argument.
4425 </div>
4426
4427 <div class="description">
4428
4429
4430
4431
4432 </div>
4433
4434 </div>
4435 <hr />
4436 <h4>
4437 <a name="mouseDownEvent">mouseDownEvent</a></h4>
4438 <div class="detail">
4439 <code>
4440
4441
4442
4443 <strong>mouseDownEvent</strong>
4444
4445 (
4446 )
4447
4448 </code>
4449
4450 <div class="description">
4451 Fires when the user mouses down on the menu. Passes back the
4452 DOM Event object as an argument.
4453 </div>
4454
4455 <div class="description">
4456
4457
4458
4459
4460 </div>
4461
4462 </div>
4463 <hr />
4464 <h4>
4465 <a name="mouseOutEvent">mouseOutEvent</a></h4>
4466 <div class="detail">
4467 <code>
4468
4469
4470
4471 <strong>mouseOutEvent</strong>
4472
4473 (
4474 )
4475
4476 </code>
4477
4478 <div class="description">
4479 Fires when the mouse has left the menu. Passes back the DOM
4480 Event object as an argument.
4481 </div>
4482
4483 <div class="description">
4484
4485
4486
4487
4488 </div>
4489
4490 </div>
4491 <hr />
4492 <h4>
4493 <a name="mouseOverEvent">mouseOverEvent</a></h4>
4494 <div class="detail">
4495 <code>
4496
4497
4498
4499 <strong>mouseOverEvent</strong>
4500
4501 (
4502 )
4503
4504 </code>
4505
4506 <div class="description">
4507 Fires when the mouse has entered the menu. Passes back
4508 the DOM Event object as an argument.
4509 </div>
4510
4511 <div class="description">
4512
4513
4514
4515
4516 </div>
4517
4518 </div>
4519 <hr />
4520 <h4>
4521 <a name="mouseUpEvent">mouseUpEvent</a></h4>
4522 <div class="detail">
4523 <code>
4524
4525
4526
4527 <strong>mouseUpEvent</strong>
4528
4529 (
4530 )
4531
4532 </code>
4533
4534 <div class="description">
4535 Fires when the user releases a mouse button while the mouse is
4536 over the menu. Passes back the DOM Event object as an argument.
4537 </div>
4538
4539 <div class="description">
4540
4541
4542
4543
4544 </div>
4545
4546 </div>
4547 <hr />
4548 </div>
4549 </div>
4550
4551
4552 <div class="section field inheritance">
4553 <h4>Events inherited from <a href="YAHOO.widget.Module.html">YAHOO.widget.Module</a>:</h4>
4554 <div class="content">
4555 <code>
4556
4557 <a href="YAHOO.widget.Module.html#appendEvent">appendEvent</a>,
4558 <a href="YAHOO.widget.Module.html#beforeHideEvent">beforeHideEvent</a>,
4559 <a href="YAHOO.widget.Module.html#beforeInitEvent">beforeInitEvent</a>,
4560 <a href="YAHOO.widget.Module.html#beforeRenderEvent">beforeRenderEvent</a>,
4561 <a href="YAHOO.widget.Module.html#beforeShowEvent">beforeShowEvent</a>,
4562 <a href="YAHOO.widget.Module.html#changeBodyEvent">changeBodyEvent</a>,
4563 <a href="YAHOO.widget.Module.html#changeContentEvent">changeContentEvent</a>,
4564 <a href="YAHOO.widget.Module.html#changeFooterEvent">changeFooterEvent</a>,
4565 <a href="YAHOO.widget.Module.html#changeHeaderEvent">changeHeaderEvent</a>,
4566 <a href="YAHOO.widget.Module.html#destroyEvent">destroyEvent</a>,
4567 <a href="YAHOO.widget.Module.html#hideEvent">hideEvent</a>,
4568 <a href="YAHOO.widget.Module.html#initEvent">initEvent</a>,
4569 <a href="YAHOO.widget.Module.html#renderEvent">renderEvent</a>,
4570 <a href="YAHOO.widget.Module.html#showEvent">showEvent</a>,
4571 <a href="YAHOO.widget.Module.html#YAHOO.widget.Module.textResizeEvent">YAHOO.widget.Module.textResizeEvent</a>
4572 </code>
4573 </div>
4574 </div>
4575 <div class="section field inheritance">
4576 <h4>Events inherited from <a href="YAHOO.widget.Overlay.html">YAHOO.widget.Overlay</a>:</h4>
4577 <div class="content">
4578 <code>
4579
4580 <a href="YAHOO.widget.Overlay.html#beforeMoveEvent">beforeMoveEvent</a>,
4581 <a href="YAHOO.widget.Overlay.html#moveEvent">moveEvent</a>,
4582 <a href="YAHOO.widget.Overlay.html#YAHOO.widget.Overlay.windowResizeEvent">YAHOO.widget.Overlay.windowResizeEvent</a>,
4583 <a href="YAHOO.widget.Overlay.html#YAHOO.widget.Overlay.windowScrollEvent">YAHOO.widget.Overlay.windowScrollEvent</a>
4584 </code>
4585 </div>
4586 </div>
4587
4588 <div class="section field details">
4589 <h3><a name="field_detail">Configuration Attributes</a></h3>
4590 <div class="content">
4591 <h4><a name="autosubmenudisplay">autosubmenudisplay</a>
4592 <code>- Boolean</code>
4593 </h4>
4594 <div class="detail">
4595 <div class="description">
4596 Boolean indicating if submenus are automatically made
4597 visible when the user mouses over the menu's items.
4598 </div>
4599 </div>
4600
4601
4602 <div class="default">
4603 Default Value: true
4604 </div>
4605
4606 <hr />
4607 <h4><a name="classname">classname</a>
4608 <code>- String</code>
4609 </h4>
4610 <div class="detail">
4611 <div class="description">
4612 CSS class to be applied to the menu's root
4613 <code>&#60;div&#62;</code> element. The specified class(es) are
4614 appended in addition to the default class as specified by the menu's
4615 CSS_CLASS_NAME constant.
4616 </div>
4617 </div>
4618
4619
4620 <div class="default">
4621 Default Value: null
4622 </div>
4623
4624 <hr />
4625 <h4><a name="clicktohide">clicktohide</a>
4626 <code>- Boolean</code>
4627 </h4>
4628 <div class="detail">
4629 <div class="description">
4630 Boolean indicating if the menu will automatically be
4631 hidden if the user clicks outside of it.
4632 </div>
4633 </div>
4634
4635
4636 <div class="default">
4637 Default Value: true
4638 </div>
4639
4640 <hr />
4641 <h4><a name="constraintoviewport">constraintoviewport</a>
4642 <code>- Boolean</code>
4643 </h4>
4644 <div class="detail">
4645 <div class="description">
4646 Boolean indicating if the menu will try to remain inside
4647 the boundaries of the size of viewport.
4648 </div>
4649 </div>
4650
4651
4652 <div class="default">
4653 Default Value: true
4654 </div>
4655
4656 <hr />
4657 <h4><a name="container">container</a>
4658 <code>- <a href="http://www.w3.org/TR/2000/WD-DOM-Level-1-20000929/
4659 level-one-html.html#ID-58190037">HTMLElement</a>|String</code>
4660 </h4>
4661 <div class="detail">
4662 <div class="description">
4663 HTML element reference or string specifying the id
4664 attribute of the HTML element that the menu's markup should be
4665 rendered into.
4666 </div>
4667 </div>
4668
4669
4670 <div class="default">
4671 Default Value: document.body
4672 </div>
4673
4674 <hr />
4675 <h4><a name="hidedelay">hidedelay</a>
4676 <code>- Number</code>
4677 </h4>
4678 <div class="detail">
4679 <div class="description">
4680 Number indicating the time (in milliseconds) that should
4681 expire before the menu is hidden.
4682 </div>
4683 </div>
4684
4685
4686 <div class="default">
4687 Default Value: 0
4688 </div>
4689
4690 <hr />
4691 <h4><a name="maxheight">maxheight</a>
4692 <code>- Number</code>
4693 </h4>
4694 <div class="detail">
4695 <div class="description">
4696 Defines the maximum height (in pixels) for a menu before the
4697 contents of the body are scrolled.
4698 </div>
4699 </div>
4700
4701
4702 <div class="default">
4703 Default Value: 0
4704 </div>
4705
4706 <hr />
4707 <h4><a name="position">position</a>
4708 <code>- String</code>
4709 </h4>
4710 <div class="detail">
4711 <div class="description">
4712 String indicating how a menu should be positioned on the
4713 screen. Possible values are "static" and "dynamic." Static menus are
4714 visible by default and reside in the normal flow of the document
4715 (CSS position: static). Dynamic menus are hidden by default, reside
4716 out of the normal flow of the document (CSS position: absolute), and
4717 can overlay other elements on the screen.
4718 </div>
4719 </div>
4720
4721
4722 <div class="default">
4723 Default Value: dynamic
4724 </div>
4725
4726 <hr />
4727 <h4><a name="showdelay">showdelay</a>
4728 <code>- Number</code>
4729 </h4>
4730 <div class="detail">
4731 <div class="description">
4732 Number indicating the time (in milliseconds) that should
4733 expire before a submenu is made visible when the user mouses over
4734 the menu's items.
4735 </div>
4736 </div>
4737
4738
4739 <div class="default">
4740 Default Value: 250
4741 </div>
4742
4743 <hr />
4744 <h4><a name="submenualignment">submenualignment</a>
4745 <code>- Array</code>
4746 </h4>
4747 <div class="detail">
4748 <div class="description">
4749 Array defining how submenus should be aligned to their
4750 parent menu item. The format is: [itemCorner, submenuCorner]. By default
4751 a submenu's top left corner is aligned to its parent menu item's top
4752 right corner.
4753 </div>
4754 </div>
4755
4756
4757 <div class="default">
4758 Default Value: ["tl","tr"]
4759 </div>
4760
4761 <hr />
4762 <h4><a name="submenuhidedelay">submenuhidedelay</a>
4763 <code>- Number</code>
4764 </h4>
4765 <div class="detail">
4766 <div class="description">
4767 Number indicating the time (in milliseconds) that should
4768 expire before a submenu is hidden when the user mouses out of a menu item
4769 heading in the direction of a submenu. The value must be greater than or
4770 equal to the value specified for the "showdelay" configuration property.
4771 </div>
4772 </div>
4773
4774
4775 <div class="default">
4776 Default Value: 250
4777 </div>
4778
4779 <hr />
4780 <h4><a name="visible">visible</a>
4781 <code>- Boolean</code>
4782 </h4>
4783 <div class="detail">
4784 <div class="description">
4785 Boolean indicating whether or not the menu is visible. If
4786 the menu's "position" configuration property is set to "dynamic" (the
4787 default), this property toggles the menu's <code>&#60;div&#62;</code>
4788 element's "visibility" style property between "visible" (true) or
4789 "hidden" (false). If the menu's "position" configuration property is
4790 set to "static" this property toggles the menu's
4791 <code>&#60;div&#62;</code> element's "display" style property
4792 between "block" (true) or "none" (false).
4793 </div>
4794 </div>
4795
4796
4797 <div class="default">
4798 Default Value: false
4799 </div>
4800
4801 <hr />
4802
4803 </div>
4804 </div>
4805
4806 <div class="section field inheritance">
4807 <h4>Configuration attributes inherited from <a href="YAHOO.widget.Module.html">YAHOO.widget.Module</a>:</h4>
4808 <div class="content">
4809 <code>
4810
4811 <a href="YAHOO.widget.Module.html#effect">effect</a>,
4812 <a href="YAHOO.widget.Module.html#monitorresize">monitorresize</a>,
4813 <a href="YAHOO.widget.Module.html#visible">visible</a>
4814 </code>
4815 </div>
4816 </div>
4817 <div class="section field inheritance">
4818 <h4>Configuration attributes inherited from <a href="YAHOO.widget.Overlay.html">YAHOO.widget.Overlay</a>:</h4>
4819 <div class="content">
4820 <code>
4821
4822 <a href="YAHOO.widget.Overlay.html#constraintoviewport">constraintoviewport</a>,
4823 <a href="YAHOO.widget.Overlay.html#context">context</a>,
4824 <a href="YAHOO.widget.Overlay.html#fixedcenter">fixedcenter</a>,
4825 <a href="YAHOO.widget.Overlay.html#height">height</a>,
4826 <a href="YAHOO.widget.Overlay.html#iframe">iframe</a>,
4827 <a href="YAHOO.widget.Overlay.html#width">width</a>,
4828 <a href="YAHOO.widget.Overlay.html#x">x</a>,
4829 <a href="YAHOO.widget.Overlay.html#xy">xy</a>,
4830 <a href="YAHOO.widget.Overlay.html#y">y</a>,
4831 <a href="YAHOO.widget.Overlay.html#zIndex">zIndex</a>
4832 </code>
4833 </div>
4834 </div>
4835
4836 </div>
4837 </div>
4838 <div class="yui-b">
4839 <div class="nav">
4840
4841 <div class="module">
4842 <h4>Modules</h4>
4843 <ul class="content">
4844
4845 <li class=""><a href="module_animation.html">animation</a></li>
4846
4847 <li class=""><a href="module_autocomplete.html">autocomplete</a></li>
4848
4849 <li class=""><a href="module_button.html">button</a></li>
4850
4851 <li class=""><a href="module_calendar.html">calendar</a></li>
4852
4853 <li class=""><a href="module_connection.html">connection</a></li>
4854
4855 <li class=""><a href="module_container.html">container</a></li>
4856
4857 <li class=""><a href="module_datasource.html">datasource</a></li>
4858
4859 <li class=""><a href="module_datatable.html">datatable</a></li>
4860
4861 <li class=""><a href="module_dom.html">dom</a></li>
4862
4863 <li class=""><a href="module_dragdrop.html">dragdrop</a></li>
4864
4865 <li class=""><a href="module_element.html">element</a></li>
4866
4867 <li class=""><a href="module_event.html">event</a></li>
4868
4869 <li class=""><a href="module_history.html">history</a></li>
4870
4871 <li class=""><a href="module_logger.html">logger</a></li>
4872
4873 <li class="selected"><a href="module_menu.html">menu</a></li>
4874
4875 <li class=""><a href="module_slider.html">slider</a></li>
4876
4877 <li class=""><a href="module_tabview.html">tabview</a></li>
4878
4879 <li class=""><a href="module_treeview.html">treeview</a></li>
4880
4881 <li class=""><a href="module_yahoo.html">yahoo</a></li>
4882 </ul>
4883 </div>
4884
4885 <div class="module">
4886 <h4>Classes</h4>
4887 <ul class="content">
4888 <li class=""><a href="YAHOO.widget.ContextMenu.html">YAHOO.widget.ContextMenu</a></li>
4889 <li class=""><a href="YAHOO.widget.ContextMenuItem.html">YAHOO.widget.ContextMenuItem</a></li>
4890 <li class="selected"><a href="YAHOO.widget.Menu.html">YAHOO.widget.Menu</a></li>
4891 <li class=""><a href="YAHOO.widget.Menubar.html">YAHOO.widget.Menubar</a></li>
4892 <li class=""><a href="YAHOO.widget.MenuBarItem.html">YAHOO.widget.MenuBarItem</a></li>
4893 <li class=""><a href="YAHOO.widget.MenuItem.html">YAHOO.widget.MenuItem</a></li>
4894 <li class=""><a href="YAHOO.widget.MenuManager.html">YAHOO.widget.MenuManager</a></li>
4895 </ul>
4896 </div>
4897
4898 <div class="module">
4899 <h4>Files</h4>
4900 <ul class="content">
4901 <li class=""><a href="contextmenu.js.html">contextmenu.js</a></li>
4902 <li class=""><a href="contextmenuitem.js.html">contextmenuitem.js</a></li>
4903 <li class=""><a href="menu.js.html">menu.js</a></li>
4904 <li class=""><a href="menubar.js.html">menubar.js</a></li>
4905 <li class=""><a href="menubaritem.js.html">menubaritem.js</a></li>
4906 <li class=""><a href="menuitem.js.html">menuitem.js</a></li>
4907 <li class=""><a href="menumanager.js.html">menumanager.js</a></li>
4908 </ul>
4909 </div>
4910
4911 <div class="module">
4912 <h4>Properties</h4>
4913 <ul class="content">
4914 <li><a href="#_aGroupTitleElements">_aGroupTitleElements</a>
4915 <!--<code>&lt;<a href="http://www.w3.org/TR/2000/WD-DOM-Level-1-20000929/
4916 level-one-html.html#ID-94282980">HTMLSelectElement</a>|<a
4917 href="http://www.w3.org/TR/2000/WD-DOM-Level-1-20000929/level-one-html.
4918 html#ID-22445964">HTMLDivElement</a>&gt;</code>-->
4919 </li>
4920 <li><a href="#_aItemGroups">_aItemGroups</a>
4921 <!--<code>&lt;<a href="http://www.w3.org/TR/2000/WD-DOM-Level-1-20000929/
4922 level-one-html.html#ID-94282980">HTMLSelectElement</a>|<a
4923 href="http://www.w3.org/TR/2000/WD-DOM-Level-1-20000929/level-one-html.
4924 html#ID-22445964">HTMLDivElement</a>&gt;</code>-->
4925 </li>
4926 <li><a href="#_aListElements">_aListElements</a>
4927 <!--<code>&lt;<a href="http://www.w3.org/TR/2000/WD-DOM-Level-1-20000929/
4928 level-one-html.html#ID-94282980">HTMLSelectElement</a>|<a
4929 href="http://www.w3.org/TR/2000/WD-DOM-Level-1-20000929/level-one-html.
4930 html#ID-22445964">HTMLDivElement</a>&gt;</code>-->
4931 </li>
4932 <li><a href="#_bHandledMouseOutEvent">_bHandledMouseOutEvent</a>
4933 <!--<code>&lt;<a href="http://www.w3.org/TR/2000/WD-DOM-Level-1-20000929/
4934 level-one-html.html#ID-94282980">HTMLSelectElement</a>|<a
4935 href="http://www.w3.org/TR/2000/WD-DOM-Level-1-20000929/level-one-html.
4936 html#ID-22445964">HTMLDivElement</a>&gt;</code>-->
4937 </li>
4938 <li><a href="#_bHandledMouseOverEvent">_bHandledMouseOverEvent</a>
4939 <!--<code>&lt;<a href="http://www.w3.org/TR/2000/WD-DOM-Level-1-20000929/
4940 level-one-html.html#ID-94282980">HTMLSelectElement</a>|<a
4941 href="http://www.w3.org/TR/2000/WD-DOM-Level-1-20000929/level-one-html.
4942 html#ID-22445964">HTMLDivElement</a>&gt;</code>-->
4943 </li>
4944 <li><a href="#_bHideDelayEventHandlersAssigned">_bHideDelayEventHandlersAssigned</a>
4945 <!--<code>&lt;<a href="http://www.w3.org/TR/2000/WD-DOM-Level-1-20000929/
4946 level-one-html.html#ID-94282980">HTMLSelectElement</a>|<a
4947 href="http://www.w3.org/TR/2000/WD-DOM-Level-1-20000929/level-one-html.
4948 html#ID-22445964">HTMLDivElement</a>&gt;</code>-->
4949 </li>
4950 <li><a href="#_bStopMouseEventHandlers">_bStopMouseEventHandlers</a>
4951 <!--<code>&lt;<a href="http://www.w3.org/TR/2000/WD-DOM-Level-1-20000929/
4952 level-one-html.html#ID-94282980">HTMLSelectElement</a>|<a
4953 href="http://www.w3.org/TR/2000/WD-DOM-Level-1-20000929/level-one-html.
4954 html#ID-22445964">HTMLDivElement</a>&gt;</code>-->
4955 </li>
4956 <li><a href="#_nBodyScrollId">_nBodyScrollId</a>
4957 <!--<code>&lt;<a href="http://www.w3.org/TR/2000/WD-DOM-Level-1-20000929/
4958 level-one-html.html#ID-94282980">HTMLSelectElement</a>|<a
4959 href="http://www.w3.org/TR/2000/WD-DOM-Level-1-20000929/level-one-html.
4960 html#ID-22445964">HTMLDivElement</a>&gt;</code>-->
4961 </li>
4962 <li><a href="#_nCurrentMouseX">_nCurrentMouseX</a>
4963 <!--<code>&lt;<a href="http://www.w3.org/TR/2000/WD-DOM-Level-1-20000929/
4964 level-one-html.html#ID-94282980">HTMLSelectElement</a>|<a
4965 href="http://www.w3.org/TR/2000/WD-DOM-Level-1-20000929/level-one-html.
4966 html#ID-22445964">HTMLDivElement</a>&gt;</code>-->
4967 </li>
4968 <li><a href="#_nHideDelayId">_nHideDelayId</a>
4969 <!--<code>&lt;<a href="http://www.w3.org/TR/2000/WD-DOM-Level-1-20000929/
4970 level-one-html.html#ID-94282980">HTMLSelectElement</a>|<a
4971 href="http://www.w3.org/TR/2000/WD-DOM-Level-1-20000929/level-one-html.
4972 html#ID-22445964">HTMLDivElement</a>&gt;</code>-->
4973 </li>
4974 <li><a href="#_nMaxHeight">_nMaxHeight</a>
4975 <!--<code>&lt;<a href="http://www.w3.org/TR/2000/WD-DOM-Level-1-20000929/
4976 level-one-html.html#ID-94282980">HTMLSelectElement</a>|<a
4977 href="http://www.w3.org/TR/2000/WD-DOM-Level-1-20000929/level-one-html.
4978 html#ID-22445964">HTMLDivElement</a>&gt;</code>-->
4979 </li>
4980 <li><a href="#_nShowDelayId">_nShowDelayId</a>
4981 <!--<code>&lt;<a href="http://www.w3.org/TR/2000/WD-DOM-Level-1-20000929/
4982 level-one-html.html#ID-94282980">HTMLSelectElement</a>|<a
4983 href="http://www.w3.org/TR/2000/WD-DOM-Level-1-20000929/level-one-html.
4984 html#ID-22445964">HTMLDivElement</a>&gt;</code>-->
4985 </li>
4986 <li><a href="#_nSubmenuHideDelayId">_nSubmenuHideDelayId</a>
4987 <!--<code>&lt;<a href="http://www.w3.org/TR/2000/WD-DOM-Level-1-20000929/
4988 level-one-html.html#ID-94282980">HTMLSelectElement</a>|<a
4989 href="http://www.w3.org/TR/2000/WD-DOM-Level-1-20000929/level-one-html.
4990 html#ID-22445964">HTMLDivElement</a>&gt;</code>-->
4991 </li>
4992 <li><a href="#_sClassName">_sClassName</a>
4993 <!--<code>&lt;<a href="http://www.w3.org/TR/2000/WD-DOM-Level-1-20000929/
4994 level-one-html.html#ID-94282980">HTMLSelectElement</a>|<a
4995 href="http://www.w3.org/TR/2000/WD-DOM-Level-1-20000929/level-one-html.
4996 html#ID-22445964">HTMLDivElement</a>&gt;</code>-->
4997 </li>
4998 <li><a href="#activeItem">activeItem</a>
4999 <!--<code>&lt;<a href="http://www.w3.org/TR/2000/WD-DOM-Level-1-20000929/
5000 level-one-html.html#ID-94282980">HTMLSelectElement</a>|<a
5001 href="http://www.w3.org/TR/2000/WD-DOM-Level-1-20000929/level-one-html.
5002 html#ID-22445964">HTMLDivElement</a>&gt;</code>-->
5003 </li>
5004 <li><a href="#CSS_CLASS_NAME">CSS_CLASS_NAME</a>
5005 <!--<code>&lt;<a href="http://www.w3.org/TR/2000/WD-DOM-Level-1-20000929/
5006 level-one-html.html#ID-94282980">HTMLSelectElement</a>|<a
5007 href="http://www.w3.org/TR/2000/WD-DOM-Level-1-20000929/level-one-html.
5008 html#ID-22445964">HTMLDivElement</a>&gt;</code>-->
5009 </li>
5010 <li><a href="#GROUP_TITLE_TAG_NAME">GROUP_TITLE_TAG_NAME</a>
5011 <!--<code>&lt;<a href="http://www.w3.org/TR/2000/WD-DOM-Level-1-20000929/
5012 level-one-html.html#ID-94282980">HTMLSelectElement</a>|<a
5013 href="http://www.w3.org/TR/2000/WD-DOM-Level-1-20000929/level-one-html.
5014 html#ID-22445964">HTMLDivElement</a>&gt;</code>-->
5015 </li>
5016 <li><a href="#ITEM_TYPE">ITEM_TYPE</a>
5017 <!--<code>&lt;<a href="http://www.w3.org/TR/2000/WD-DOM-Level-1-20000929/
5018 level-one-html.html#ID-94282980">HTMLSelectElement</a>|<a
5019 href="http://www.w3.org/TR/2000/WD-DOM-Level-1-20000929/level-one-html.
5020 html#ID-22445964">HTMLDivElement</a>&gt;</code>-->
5021 </li>
5022 <li><a href="#itemData">itemData</a>
5023 <!--<code>&lt;<a href="http://www.w3.org/TR/2000/WD-DOM-Level-1-20000929/
5024 level-one-html.html#ID-94282980">HTMLSelectElement</a>|<a
5025 href="http://www.w3.org/TR/2000/WD-DOM-Level-1-20000929/level-one-html.
5026 html#ID-22445964">HTMLDivElement</a>&gt;</code>-->
5027 </li>
5028 <li><a href="#lazyLoad">lazyLoad</a>
5029 <!--<code>&lt;<a href="http://www.w3.org/TR/2000/WD-DOM-Level-1-20000929/
5030 level-one-html.html#ID-94282980">HTMLSelectElement</a>|<a
5031 href="http://www.w3.org/TR/2000/WD-DOM-Level-1-20000929/level-one-html.
5032 html#ID-22445964">HTMLDivElement</a>&gt;</code>-->
5033 </li>
5034 <li><a href="#parent">parent</a>
5035 <!--<code>&lt;<a href="http://www.w3.org/TR/2000/WD-DOM-Level-1-20000929/
5036 level-one-html.html#ID-94282980">HTMLSelectElement</a>|<a
5037 href="http://www.w3.org/TR/2000/WD-DOM-Level-1-20000929/level-one-html.
5038 html#ID-22445964">HTMLDivElement</a>&gt;</code>-->
5039 </li>
5040 <li><a href="#srcElement">srcElement</a>
5041 <!--<code>&lt;<a href="http://www.w3.org/TR/2000/WD-DOM-Level-1-20000929/
5042 level-one-html.html#ID-94282980">HTMLSelectElement</a>|<a
5043 href="http://www.w3.org/TR/2000/WD-DOM-Level-1-20000929/level-one-html.
5044 html#ID-22445964">HTMLDivElement</a>&gt;</code>-->
5045 </li>
5046 </ul>
5047 </div>
5048
5049 <div class="module">
5050 <h4>Methods</h4>
5051 <ul class="content">
5052 <li><!--<code>YAHOO.widget.MenuItem</code>-->
5053 <a href="#_addItemToGroup">_addItemToGroup</a>
5054 </li>
5055 <li><!--<code>void</code>-->
5056 <a href="#_cancelHideDelay">_cancelHideDelay</a>
5057 </li>
5058 <li><!--<code>void</code>-->
5059 <a href="#_cancelShowDelay">_cancelShowDelay</a>
5060 </li>
5061 <li><!--<code>Boolean</code>-->
5062 <a href="#_checkPosition">_checkPosition</a>
5063 </li>
5064 <li><!--<code>void</code>-->
5065 <a href="#_configureSubmenu">_configureSubmenu</a>
5066 </li>
5067 <li><!--<code>Array</code>-->
5068 <a href="#_createItemGroup">_createItemGroup</a>
5069 </li>
5070 <li><!--<code>void</code>-->
5071 <a href="#_disableScrollFooter">_disableScrollFooter</a>
5072 </li>
5073 <li><!--<code>void</code>-->
5074 <a href="#_disableScrollHeader">_disableScrollHeader</a>
5075 </li>
5076 <li><!--<code>void</code>-->
5077 <a href="#_enableScrollFooter">_enableScrollFooter</a>
5078 </li>
5079 <li><!--<code>void</code>-->
5080 <a href="#_enableScrollHeader">_enableScrollHeader</a>
5081 </li>
5082 <li><!--<code>void</code>-->
5083 <a href="#_execHideDelay">_execHideDelay</a>
5084 </li>
5085 <li><!--<code>void</code>-->
5086 <a href="#_execShowDelay">_execShowDelay</a>
5087 </li>
5088 <li><!--<code>void</code>-->
5089 <a href="#_execSubmenuHideDelay">_execSubmenuHideDelay</a>
5090 </li>
5091 <li><!--<code>YAHOO.widget.MenuItem</code>-->
5092 <a href="#_getFirstEnabledItem">_getFirstEnabledItem</a>
5093 </li>
5094 <li><!--<code>Array</code>-->
5095 <a href="#_getItemGroup">_getItemGroup</a>
5096 </li>
5097 <li><!--<code>void</code>-->
5098 <a href="#_getOffsetWidth">_getOffsetWidth</a>
5099 </li>
5100 <li><!--<code>void</code>-->
5101 <a href="#_initSubTree">_initSubTree</a>
5102 </li>
5103 <li><!--<code>void</code>-->
5104 <a href="#_onBeforeHide">_onBeforeHide</a>
5105 </li>
5106 <li><!--<code>void</code>-->
5107 <a href="#_onBeforeRender">_onBeforeRender</a>
5108 </li>
5109 <li><!--<code>void</code>-->
5110 <a href="#_onBeforeShow">_onBeforeShow</a>
5111 </li>
5112 <li><!--<code>void</code>-->
5113 <a href="#_onClick">_onClick</a>
5114 </li>
5115 <li><!--<code>void</code>-->
5116 <a href="#_onHide">_onHide</a>
5117 </li>
5118 <li><!--<code>void</code>-->
5119 <a href="#_onInit">_onInit</a>
5120 </li>
5121 <li><!--<code>void</code>-->
5122 <a href="#_onKeyDown">_onKeyDown</a>
5123 </li>
5124 <li><!--<code>void</code>-->
5125 <a href="#_onKeyPress">_onKeyPress</a>
5126 </li>
5127 <li><!--<code>void</code>-->
5128 <a href="#_onMenuItemBlur">_onMenuItemBlur</a>
5129 </li>
5130 <li><!--<code>void</code>-->
5131 <a href="#_onMenuItemConfigChange">_onMenuItemConfigChange</a>
5132 </li>
5133 <li><!--<code>void</code>-->
5134 <a href="#_onMenuItemFocus">_onMenuItemFocus</a>
5135 </li>
5136 <li><!--<code>void</code>-->
5137 <a href="#_onMouseMove">_onMouseMove</a>
5138 </li>
5139 <li><!--<code>void</code>-->
5140 <a href="#_onMouseOut">_onMouseOut</a>
5141 </li>
5142 <li><!--<code>void</code>-->
5143 <a href="#_onMouseOver">_onMouseOver</a>
5144 </li>
5145 <li><!--<code>void</code>-->
5146 <a href="#_onParentMenuConfigChange">_onParentMenuConfigChange</a>
5147 </li>
5148 <li><!--<code>void</code>-->
5149 <a href="#_onParentMenuRender">_onParentMenuRender</a>
5150 </li>
5151 <li><!--<code>void</code>-->
5152 <a href="#_onScrollTargetMouseOut">_onScrollTargetMouseOut</a>
5153 </li>
5154 <li><!--<code>void</code>-->
5155 <a href="#_onScrollTargetMouseOver">_onScrollTargetMouseOver</a>
5156 </li>
5157 <li><!--<code>void</code>-->
5158 <a href="#_onShow">_onShow</a>
5159 </li>
5160 <li><!--<code>void</code>-->
5161 <a href="#_onSubmenuBeforeShow">_onSubmenuBeforeShow</a>
5162 </li>
5163 <li><!--<code>void</code>-->
5164 <a href="#_onSubmenuHide">_onSubmenuHide</a>
5165 </li>
5166 <li><!--<code>void</code>-->
5167 <a href="#_onSubmenuShow">_onSubmenuShow</a>
5168 </li>
5169 <li><!--<code>void</code>-->
5170 <a href="#_onTextResize">_onTextResize</a>
5171 </li>
5172 <li><!--<code>YAHOO.widget.MenuItem</code>-->
5173 <a href="#_removeItemFromGroupByIndex">_removeItemFromGroupByIndex</a>
5174 </li>
5175 <li><!--<code>YAHOO.widget.MenuItem</code>-->
5176 <a href="#_removeItemFromGroupByValue">_removeItemFromGroupByValue</a>
5177 </li>
5178 <li><!--<code>void</code>-->
5179 <a href="#_setWidth">_setWidth</a>
5180 </li>
5181 <li><!--<code>void</code>-->
5182 <a href="#_subscribeToItemEvents">_subscribeToItemEvents</a>
5183 </li>
5184 <li><!--<code>void</code>-->
5185 <a href="#_updateItemProperties">_updateItemProperties</a>
5186 </li>
5187 <li><!--<code>YAHOO.widget.MenuItem</code>-->
5188 <a href="#addItem">addItem</a>
5189 </li>
5190 <li><!--<code>Array</code>-->
5191 <a href="#addItems">addItems</a>
5192 </li>
5193 <li><!--<code>void</code>-->
5194 <a href="#clearActiveItem">clearActiveItem</a>
5195 </li>
5196 <li><!--<code>void</code>-->
5197 <a href="#clearContent">clearContent</a>
5198 </li>
5199 <li><!--<code>void</code>-->
5200 <a href="#configClassName">configClassName</a>
5201 </li>
5202 <li><!--<code>void</code>-->
5203 <a href="#configContainer">configContainer</a>
5204 </li>
5205 <li><!--<code>void</code>-->
5206 <a href="#configHideDelay">configHideDelay</a>
5207 </li>
5208 <li><!--<code>void</code>-->
5209 <a href="#configIframe">configIframe</a>
5210 </li>
5211 <li><!--<code>void</code>-->
5212 <a href="#configMaxHeight">configMaxHeight</a>
5213 </li>
5214 <li><!--<code>void</code>-->
5215 <a href="#configPosition">configPosition</a>
5216 </li>
5217 <li><!--<code>void</code>-->
5218 <a href="#configVisible">configVisible</a>
5219 </li>
5220 <li><!--<code>void</code>-->
5221 <a href="#destroy">destroy</a>
5222 </li>
5223 <li><!--<code>void</code>-->
5224 <a href="#enforceConstraints">enforceConstraints</a>
5225 </li>
5226 <li><!--<code>YAHOO.widget.MenuItem</code>-->
5227 <a href="#getItem">getItem</a>
5228 </li>
5229 <li><!--<code>Array</code>-->
5230 <a href="#getItemGroups">getItemGroups</a>
5231 </li>
5232 <li><!--<code>Array</code>-->
5233 <a href="#getItems">getItems</a>
5234 </li>
5235 <li><!--<code>void</code>-->
5236 <a href="#getRoot">getRoot</a>
5237 </li>
5238 <li><!--<code>void</code>-->
5239 <a href="#init">init</a>
5240 </li>
5241 <li><!--<code>void</code>-->
5242 <a href="#initDefaultConfig">initDefaultConfig</a>
5243 </li>
5244 <li><!--<code>void</code>-->
5245 <a href="#initEvents">initEvents</a>
5246 </li>
5247 <li><!--<code>YAHOO.widget.MenuItem</code>-->
5248 <a href="#insertItem">insertItem</a>
5249 </li>
5250 <li><!--<code>YAHOO.widget.MenuItem</code>-->
5251 <a href="#removeItem">removeItem</a>
5252 </li>
5253 <li><!--<code>void</code>-->
5254 <a href="#setInitialFocus">setInitialFocus</a>
5255 </li>
5256 <li><!--<code>void</code>-->
5257 <a href="#setInitialSelection">setInitialSelection</a>
5258 </li>
5259 <li><!--<code>void</code>-->
5260 <a href="#setItemGroupTitle">setItemGroupTitle</a>
5261 </li>
5262 <li><!--<code>String</code>-->
5263 <a href="#toString">toString</a>
5264 </li>
5265 </ul>
5266 </div>
5267
5268 <div class="module">
5269 <h4>Events</h4>
5270 <ul class="content">
5271 <li>
5272 <a href="#clickEvent">clickEvent</a>
5273 </li>
5274 <li>
5275 <a href="#itemAddedEvent">itemAddedEvent</a>
5276 </li>
5277 <li>
5278 <a href="#itemRemovedEvent">itemRemovedEvent</a>
5279 </li>
5280 <li>
5281 <a href="#keyDownEvent">keyDownEvent</a>
5282 </li>
5283 <li>
5284 <a href="#keyPressEvent">keyPressEvent</a>
5285 </li>
5286 <li>
5287 <a href="#keyUpEvent">keyUpEvent</a>
5288 </li>
5289 <li>
5290 <a href="#mouseDownEvent">mouseDownEvent</a>
5291 </li>
5292 <li>
5293 <a href="#mouseOutEvent">mouseOutEvent</a>
5294 </li>
5295 <li>
5296 <a href="#mouseOverEvent">mouseOverEvent</a>
5297 </li>
5298 <li>
5299 <a href="#mouseUpEvent">mouseUpEvent</a>
5300 </li>
5301 </ul>
5302 </div>
5303
5304 <div class="module">
5305 <h4>Configuration Attributes</h4>
5306 <ul class="content">
5307 <li>
5308 <a href="#autosubmenudisplay">autosubmenudisplay</a>
5309 </li>
5310 <li>
5311 <a href="#classname">classname</a>
5312 </li>
5313 <li>
5314 <a href="#clicktohide">clicktohide</a>
5315 </li>
5316 <li>
5317 <a href="#constraintoviewport">constraintoviewport</a>
5318 </li>
5319 <li>
5320 <a href="#container">container</a>
5321 </li>
5322 <li>
5323 <a href="#hidedelay">hidedelay</a>
5324 </li>
5325 <li>
5326 <a href="#maxheight">maxheight</a>
5327 </li>
5328 <li>
5329 <a href="#position">position</a>
5330 </li>
5331 <li>
5332 <a href="#showdelay">showdelay</a>
5333 </li>
5334 <li>
5335 <a href="#submenualignment">submenualignment</a>
5336 </li>
5337 <li>
5338 <a href="#submenuhidedelay">submenuhidedelay</a>
5339 </li>
5340 <li>
5341 <a href="#visible">visible</a>
5342 </li>
5343 </ul>
5344 </div>
5345
5346 </div>
5347 </div>
5348 </div>
5349 <div id="ft">
5350 <hr />
5351 Copyright &copy; 2007 Yahoo! Inc. All rights reserved.
5352 </div>
5353 </div>
5354 </body>
5355 </html>
Elgg Plugins