Upgrade to ExtJS 3.1.0 - Released 12/16/2009
[extjs.git] / docs / source / Menu.html
1 <html>\r
2 <head>\r
3   <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />    \r
4   <title>The source code</title>\r
5     <link href="../resources/prettify/prettify.css" type="text/css" rel="stylesheet" />\r
6     <script type="text/javascript" src="../resources/prettify/prettify.js"></script>\r
7 </head>\r
8 <body  onload="prettyPrint();">\r
9     <pre class="prettyprint lang-js"><div id="cls-Ext.layout.MenuLayout"></div>/**
10  * @class Ext.layout.MenuLayout
11  * @extends Ext.layout.ContainerLayout
12  * <p>Layout manager used by {@link Ext.menu.Menu}. Generally this class should not need to be used directly.</p>
13  */
14  Ext.layout.MenuLayout = Ext.extend(Ext.layout.ContainerLayout, {
15     monitorResize : true,
16
17     setContainer : function(ct){
18         this.monitorResize = !ct.floating;
19         // This event is only fired by the menu in IE, used so we don't couple
20         // the menu with the layout.
21         ct.on('autosize', this.doAutoSize, this);
22         Ext.layout.MenuLayout.superclass.setContainer.call(this, ct);
23     },
24
25     renderItem : function(c, position, target){
26         if (!this.itemTpl) {
27             this.itemTpl = Ext.layout.MenuLayout.prototype.itemTpl = new Ext.XTemplate(
28                 '<li id="{itemId}" class="{itemCls}">',
29                     '<tpl if="needsIcon">',
30                         '<img src="{icon}" class="{iconCls}"/>',
31                     '</tpl>',
32                 '</li>'
33             );
34         }
35
36         if(c && !c.rendered){
37             if(Ext.isNumber(position)){
38                 position = target.dom.childNodes[position];
39             }
40             var a = this.getItemArgs(c);
41
42 //          The Component's positionEl is the <li> it is rendered into
43             c.render(c.positionEl = position ?
44                 this.itemTpl.insertBefore(position, a, true) :
45                 this.itemTpl.append(target, a, true));
46
47 //          Link the containing <li> to the item.
48             c.positionEl.menuItemId = c.getItemId();
49
50 //          If rendering a regular Component, and it needs an icon,
51 //          move the Component rightwards.
52             if (!a.isMenuItem && a.needsIcon) {
53                 c.positionEl.addClass('x-menu-list-item-indent');
54             }
55             this.configureItem(c, position);
56         }else if(c && !this.isValidParent(c, target)){
57             if(Ext.isNumber(position)){
58                 position = target.dom.childNodes[position];
59             }
60             target.dom.insertBefore(c.getActionEl().dom, position || null);
61         }
62     },
63
64     getItemArgs : function(c) {
65         var isMenuItem = c instanceof Ext.menu.Item;
66         return {
67             isMenuItem: isMenuItem,
68             needsIcon: !isMenuItem && (c.icon || c.iconCls),
69             icon: c.icon || Ext.BLANK_IMAGE_URL,
70             iconCls: 'x-menu-item-icon ' + (c.iconCls || ''),
71             itemId: 'x-menu-el-' + c.id,
72             itemCls: 'x-menu-list-item '
73         };
74     },
75
76 //  Valid if the Component is in a <li> which is part of our target <ul>
77     isValidParent : function(c, target) {
78         return c.el.up('li.x-menu-list-item', 5).dom.parentNode === (target.dom || target);
79     },
80
81     onLayout : function(ct, target){
82         this.renderAll(ct, target);
83         this.doAutoSize();
84     },
85
86     doAutoSize : function(){
87         var ct = this.container, w = ct.width;
88         if(ct.floating){
89             if(w){
90                 ct.setWidth(w);
91             }else if(Ext.isIE){
92                 ct.setWidth(Ext.isStrict && (Ext.isIE7 || Ext.isIE8) ? 'auto' : ct.minWidth);
93                 var el = ct.getEl(), t = el.dom.offsetWidth; // force recalc
94                 ct.setWidth(ct.getLayoutTarget().getWidth() + el.getFrameWidth('lr'));
95             }
96         }
97     }
98 });
99 Ext.Container.LAYOUTS['menu'] = Ext.layout.MenuLayout;
100
101 <div id="cls-Ext.menu.Menu"></div>/**
102  * @class Ext.menu.Menu
103  * @extends Ext.Container
104  * <p>A menu object.  This is the container to which you may add menu items.  Menu can also serve as a base class
105  * when you want a specialized menu based off of another component (like {@link Ext.menu.DateMenu} for example).</p>
106  * <p>Menus may contain either {@link Ext.menu.Item menu items}, or general {@link Ext.Component Component}s.</p>
107  * <p>To make a contained general {@link Ext.Component Component} line up with other {@link Ext.menu.Item menu items}
108  * specify <tt>iconCls: 'no-icon'</tt>.  This reserves a space for an icon, and indents the Component in line
109  * with the other menu items.  See {@link Ext.form.ComboBox}.{@link Ext.form.ComboBox#getListParent getListParent}
110  * for an example.</p>
111  * <p>By default, Menus are absolutely positioned, floating Components. By configuring a Menu with
112  * <b><tt>{@link #floating}:false</tt></b>, a Menu may be used as child of a Container.</p>
113  *
114  * @xtype menu
115  */
116 Ext.menu.Menu = Ext.extend(Ext.Container, {
117     <div id="cfg-Ext.menu.Menu-defaults"></div>/**
118      * @cfg {Object} defaults
119      * A config object that will be applied to all items added to this container either via the {@link #items}
120      * config or via the {@link #add} method.  The defaults config can contain any number of
121      * name/value property pairs to be added to each item, and should be valid for the types of items
122      * being added to the menu.
123      */
124     <div id="cfg-Ext.menu.Menu-items"></div>/**
125      * @cfg {Mixed} items
126      * An array of items to be added to this menu. Menus may contain either {@link Ext.menu.Item menu items},
127      * or general {@link Ext.Component Component}s.
128      */
129     <div id="cfg-Ext.menu.Menu-minWidth"></div>/**
130      * @cfg {Number} minWidth The minimum width of the menu in pixels (defaults to 120)
131      */
132     minWidth : 120,
133     <div id="cfg-Ext.menu.Menu-shadow"></div>/**
134      * @cfg {Boolean/String} shadow True or 'sides' for the default effect, 'frame' for 4-way shadow, and 'drop'
135      * for bottom-right shadow (defaults to 'sides')
136      */
137     shadow : 'sides',
138     <div id="cfg-Ext.menu.Menu-subMenuAlign"></div>/**
139      * @cfg {String} subMenuAlign The {@link Ext.Element#alignTo} anchor position value to use for submenus of
140      * this menu (defaults to 'tl-tr?')
141      */
142     subMenuAlign : 'tl-tr?',
143     <div id="cfg-Ext.menu.Menu-defaultAlign"></div>/**
144      * @cfg {String} defaultAlign The default {@link Ext.Element#alignTo} anchor position value for this menu
145      * relative to its element of origin (defaults to 'tl-bl?')
146      */
147     defaultAlign : 'tl-bl?',
148     <div id="cfg-Ext.menu.Menu-allowOtherMenus"></div>/**
149      * @cfg {Boolean} allowOtherMenus True to allow multiple menus to be displayed at the same time (defaults to false)
150      */
151     allowOtherMenus : false,
152     <div id="cfg-Ext.menu.Menu-ignoreParentClicks"></div>/**
153      * @cfg {Boolean} ignoreParentClicks True to ignore clicks on any item in this menu that is a parent item (displays
154      * a submenu) so that the submenu is not dismissed when clicking the parent item (defaults to false).
155      */
156     ignoreParentClicks : false,
157     <div id="cfg-Ext.menu.Menu-enableScrolling"></div>/**
158      * @cfg {Boolean} enableScrolling True to allow the menu container to have scroller controls if the menu is too long (defaults to true).
159      */
160     enableScrolling : true,
161     <div id="cfg-Ext.menu.Menu-maxHeight"></div>/**
162      * @cfg {Number} maxHeight The maximum height of the menu. Only applies when enableScrolling is set to True (defaults to null).
163      */
164     maxHeight : null,
165     <div id="cfg-Ext.menu.Menu-scrollIncrement"></div>/**
166      * @cfg {Number} scrollIncrement The amount to scroll the menu. Only applies when enableScrolling is set to True (defaults to 24).
167      */
168     scrollIncrement : 24,
169     <div id="cfg-Ext.menu.Menu-showSeparator"></div>/**
170      * @cfg {Boolean} showSeparator True to show the icon separator. (defaults to true).
171      */
172     showSeparator : true,
173     <div id="cfg-Ext.menu.Menu-defaultOffsets"></div>/**
174      * @cfg {Array} defaultOffsets An array specifying the [x, y] offset in pixels by which to
175      * change the default Menu popup position after aligning according to the {@link #defaultAlign}
176      * configuration. Defaults to <tt>[0, 0]</tt>.
177      */
178     defaultOffsets : [0, 0],
179
180     <div id="cfg-Ext.menu.Menu-plain"></div>/**
181      * @cfg {Boolean} plain
182      * True to remove the incised line down the left side of the menu. Defaults to <tt>false</tt>.
183      */
184     plain : false,
185
186     <div id="cfg-Ext.menu.Menu-floating"></div>/**
187      * @cfg {Boolean} floating
188      * <p>By default, a Menu configured as <b><code>floating:true</code></b>
189      * will be rendered as an {@link Ext.Layer} (an absolutely positioned,
190      * floating Component with zindex=15000).
191      * If configured as <b><code>floating:false</code></b>, the Menu may be
192      * used as child item of another Container instead of a free-floating
193      * {@link Ext.Layer Layer}.
194      */
195     floating : true,
196
197     // private
198     hidden : true,
199
200     <div id="cfg-Ext.menu.Menu-layout"></div>/**
201      * @cfg {String/Object} layout
202      * This class assigns a default layout (<code>layout:'<b>menu</b>'</code>).
203      * Developers <i>may</i> override this configuration option if another layout is required.
204      * See {@link Ext.Container#layout} for additional information.
205      */
206     layout : 'menu',
207     hideMode : 'offsets',    // Important for laying out Components
208     scrollerHeight : 8,
209     autoLayout : true,       // Provided for backwards compat
210     defaultType : 'menuitem',
211     bufferResize : false,
212
213     initComponent : function(){
214         if(Ext.isArray(this.initialConfig)){
215             Ext.apply(this, {items:this.initialConfig});
216         }
217         this.addEvents(
218             <div id="event-Ext.menu.Menu-click"></div>/**
219              * @event click
220              * Fires when this menu is clicked (or when the enter key is pressed while it is active)
221              * @param {Ext.menu.Menu} this
222             * @param {Ext.menu.Item} menuItem The menu item that was clicked
223              * @param {Ext.EventObject} e
224              */
225             'click',
226             <div id="event-Ext.menu.Menu-mouseover"></div>/**
227              * @event mouseover
228              * Fires when the mouse is hovering over this menu
229              * @param {Ext.menu.Menu} this
230              * @param {Ext.EventObject} e
231              * @param {Ext.menu.Item} menuItem The menu item that was clicked
232              */
233             'mouseover',
234             <div id="event-Ext.menu.Menu-mouseout"></div>/**
235              * @event mouseout
236              * Fires when the mouse exits this menu
237              * @param {Ext.menu.Menu} this
238              * @param {Ext.EventObject} e
239              * @param {Ext.menu.Item} menuItem The menu item that was clicked
240              */
241             'mouseout',
242             <div id="event-Ext.menu.Menu-itemclick"></div>/**
243              * @event itemclick
244              * Fires when a menu item contained in this menu is clicked
245              * @param {Ext.menu.BaseItem} baseItem The BaseItem that was clicked
246              * @param {Ext.EventObject} e
247              */
248             'itemclick'
249         );
250         Ext.menu.MenuMgr.register(this);
251         if(this.floating){
252             Ext.EventManager.onWindowResize(this.hide, this);
253         }else{
254             if(this.initialConfig.hidden !== false){
255                 this.hidden = false;
256             }
257             this.internalDefaults = {hideOnClick: false};
258         }
259         Ext.menu.Menu.superclass.initComponent.call(this);
260         if(this.autoLayout){
261             this.on({
262                 add: this.doLayout,
263                 remove: this.doLayout,
264                 scope: this
265             });
266         }
267     },
268
269     //private
270     getLayoutTarget : function() {
271         return this.ul;
272     },
273
274     // private
275     onRender : function(ct, position){
276         if(!ct){
277             ct = Ext.getBody();
278         }
279
280         var dh = {
281             id: this.getId(),
282             cls: 'x-menu ' + ((this.floating) ? 'x-menu-floating x-layer ' : '') + (this.cls || '') + (this.plain ? ' x-menu-plain' : '') + (this.showSeparator ? '' : ' x-menu-nosep'),
283             style: this.style,
284             cn: [
285                 {tag: 'a', cls: 'x-menu-focus', href: '#', onclick: 'return false;', tabIndex: '-1'},
286                 {tag: 'ul', cls: 'x-menu-list'}
287             ]
288         };
289         if(this.floating){
290             this.el = new Ext.Layer({
291                 shadow: this.shadow,
292                 dh: dh,
293                 constrain: false,
294                 parentEl: ct,
295                 zindex:15000
296             });
297         }else{
298             this.el = ct.createChild(dh);
299         }
300         Ext.menu.Menu.superclass.onRender.call(this, ct, position);
301
302         if(!this.keyNav){
303             this.keyNav = new Ext.menu.MenuNav(this);
304         }
305         // generic focus element
306         this.focusEl = this.el.child('a.x-menu-focus');
307         this.ul = this.el.child('ul.x-menu-list');
308         this.mon(this.ul, {
309             scope: this,
310             click: this.onClick,
311             mouseover: this.onMouseOver,
312             mouseout: this.onMouseOut
313         });
314         if(this.enableScrolling){
315             this.mon(this.el, {
316                 scope: this,
317                 delegate: '.x-menu-scroller',
318                 click: this.onScroll,
319                 mouseover: this.deactivateActive
320             });
321         }
322     },
323
324     // private
325     findTargetItem : function(e){
326         var t = e.getTarget('.x-menu-list-item', this.ul, true);
327         if(t && t.menuItemId){
328             return this.items.get(t.menuItemId);
329         }
330     },
331
332     // private
333     onClick : function(e){
334         var t = this.findTargetItem(e);
335         if(t){
336             if(t.isFormField){
337                 this.setActiveItem(t);
338             }else if(t instanceof Ext.menu.BaseItem){
339                 if(t.menu && this.ignoreParentClicks){
340                     t.expandMenu();
341                     e.preventDefault();
342                 }else if(t.onClick){
343                     t.onClick(e);
344                     this.fireEvent('click', this, t, e);
345                 }
346             }
347         }
348     },
349
350     // private
351     setActiveItem : function(item, autoExpand){
352         if(item != this.activeItem){
353             this.deactivateActive();
354             if((this.activeItem = item).isFormField){
355                 item.focus();
356             }else{
357                 item.activate(autoExpand);
358             }
359         }else if(autoExpand){
360             item.expandMenu();
361         }
362     },
363
364     deactivateActive : function(){
365         var a = this.activeItem;
366         if(a){
367             if(a.isFormField){
368                 //Fields cannot deactivate, but Combos must collapse
369                 if(a.collapse){
370                     a.collapse();
371                 }
372             }else{
373                 a.deactivate();
374             }
375             delete this.activeItem;
376         }
377     },
378
379     // private
380     tryActivate : function(start, step){
381         var items = this.items;
382         for(var i = start, len = items.length; i >= 0 && i < len; i+= step){
383             var item = items.get(i);
384             if(!item.disabled && (item.canActivate || item.isFormField)){
385                 this.setActiveItem(item, false);
386                 return item;
387             }
388         }
389         return false;
390     },
391
392     // private
393     onMouseOver : function(e){
394         var t = this.findTargetItem(e);
395         if(t){
396             if(t.canActivate && !t.disabled){
397                 this.setActiveItem(t, true);
398             }
399         }
400         this.over = true;
401         this.fireEvent('mouseover', this, e, t);
402     },
403
404     // private
405     onMouseOut : function(e){
406         var t = this.findTargetItem(e);
407         if(t){
408             if(t == this.activeItem && t.shouldDeactivate && t.shouldDeactivate(e)){
409                 this.activeItem.deactivate();
410                 delete this.activeItem;
411             }
412         }
413         this.over = false;
414         this.fireEvent('mouseout', this, e, t);
415     },
416
417     // private
418     onScroll : function(e, t){
419         if(e){
420             e.stopEvent();
421         }
422         var ul = this.ul.dom, top = Ext.fly(t).is('.x-menu-scroller-top');
423         ul.scrollTop += this.scrollIncrement * (top ? -1 : 1);
424         if(top ? ul.scrollTop <= 0 : ul.scrollTop + this.activeMax >= ul.scrollHeight){
425            this.onScrollerOut(null, t);
426         }
427     },
428
429     // private
430     onScrollerIn : function(e, t){
431         var ul = this.ul.dom, top = Ext.fly(t).is('.x-menu-scroller-top');
432         if(top ? ul.scrollTop > 0 : ul.scrollTop + this.activeMax < ul.scrollHeight){
433             Ext.fly(t).addClass(['x-menu-item-active', 'x-menu-scroller-active']);
434         }
435     },
436
437     // private
438     onScrollerOut : function(e, t){
439         Ext.fly(t).removeClass(['x-menu-item-active', 'x-menu-scroller-active']);
440     },
441
442     <div id="method-Ext.menu.Menu-show"></div>/**
443      * If <code>{@link #floating}=true</code>, shows this menu relative to
444      * another element using {@link #showat}, otherwise uses {@link Ext.Component#show}.
445      * @param {Mixed} element The element to align to
446      * @param {String} position (optional) The {@link Ext.Element#alignTo} anchor position to use in aligning to
447      * the element (defaults to this.defaultAlign)
448      * @param {Ext.menu.Menu} parentMenu (optional) This menu's parent menu, if applicable (defaults to undefined)
449      */
450     show : function(el, pos, parentMenu){
451         if(this.floating){
452             this.parentMenu = parentMenu;
453             if(!this.el){
454                 this.render();
455                 this.doLayout(false, true);
456             }
457             this.showAt(this.el.getAlignToXY(el, pos || this.defaultAlign, this.defaultOffsets), parentMenu);
458         }else{
459             Ext.menu.Menu.superclass.show.call(this);
460         }
461     },
462
463     <div id="method-Ext.menu.Menu-showAt"></div>/**
464      * Displays this menu at a specific xy position and fires the 'show' event if a
465      * handler for the 'beforeshow' event does not return false cancelling the operation.
466      * @param {Array} xyPosition Contains X & Y [x, y] values for the position at which to show the menu (coordinates are page-based)
467      * @param {Ext.menu.Menu} parentMenu (optional) This menu's parent menu, if applicable (defaults to undefined)
468      */
469     showAt : function(xy, parentMenu){
470         if(this.fireEvent('beforeshow', this) !== false){
471             this.parentMenu = parentMenu;
472             if(!this.el){
473                 this.render();
474             }
475             if(this.enableScrolling){
476                 // set the position so we can figure out the constrain value.
477                 this.el.setXY(xy);
478                 //constrain the value, keep the y coordinate the same
479                 this.constrainScroll(xy[1]);
480                 xy = [this.el.adjustForConstraints(xy)[0], xy[1]];
481             }else{
482                 //constrain to the viewport.
483                 xy = this.el.adjustForConstraints(xy);
484             }
485             this.el.setXY(xy);
486             this.el.show();
487             Ext.menu.Menu.superclass.onShow.call(this);
488             if(Ext.isIE){
489                 // internal event, used so we don't couple the layout to the menu
490                 this.fireEvent('autosize', this);
491                 if(!Ext.isIE8){
492                     this.el.repaint();
493                 }
494             }
495             this.hidden = false;
496             this.focus();
497             this.fireEvent('show', this);
498         }
499     },
500
501     constrainScroll : function(y){
502         var max, full = this.ul.setHeight('auto').getHeight();
503         if(this.floating){
504             max = this.maxHeight ? this.maxHeight : Ext.fly(this.el.dom.parentNode).getViewSize(false).height - y;
505         }else{
506             max = this.getHeight();
507         }
508         if(full > max && max > 0){
509             this.activeMax = max - this.scrollerHeight * 2 - this.el.getFrameWidth('tb') - Ext.num(this.el.shadowOffset, 0);
510             this.ul.setHeight(this.activeMax);
511             this.createScrollers();
512             this.el.select('.x-menu-scroller').setDisplayed('');
513         }else{
514             this.ul.setHeight(full);
515             this.el.select('.x-menu-scroller').setDisplayed('none');
516         }
517         this.ul.dom.scrollTop = 0;
518     },
519
520     createScrollers : function(){
521         if(!this.scroller){
522             this.scroller = {
523                 pos: 0,
524                 top: this.el.insertFirst({
525                     tag: 'div',
526                     cls: 'x-menu-scroller x-menu-scroller-top',
527                     html: '&#160;'
528                 }),
529                 bottom: this.el.createChild({
530                     tag: 'div',
531                     cls: 'x-menu-scroller x-menu-scroller-bottom',
532                     html: '&#160;'
533                 })
534             };
535             this.scroller.top.hover(this.onScrollerIn, this.onScrollerOut, this);
536             this.scroller.topRepeater = new Ext.util.ClickRepeater(this.scroller.top, {
537                 listeners: {
538                     click: this.onScroll.createDelegate(this, [null, this.scroller.top], false)
539                 }
540             });
541             this.scroller.bottom.hover(this.onScrollerIn, this.onScrollerOut, this);
542             this.scroller.bottomRepeater = new Ext.util.ClickRepeater(this.scroller.bottom, {
543                 listeners: {
544                     click: this.onScroll.createDelegate(this, [null, this.scroller.bottom], false)
545                 }
546             });
547         }
548     },
549
550     onLayout : function(){
551         if(this.isVisible()){
552             if(this.enableScrolling){
553                 this.constrainScroll(this.el.getTop());
554             }
555             if(this.floating){
556                 this.el.sync();
557             }
558         }
559     },
560
561     focus : function(){
562         if(!this.hidden){
563             this.doFocus.defer(50, this);
564         }
565     },
566
567     doFocus : function(){
568         if(!this.hidden){
569             this.focusEl.focus();
570         }
571     },
572
573     <div id="method-Ext.menu.Menu-hide"></div>/**
574      * Hides this menu and optionally all parent menus
575      * @param {Boolean} deep (optional) True to hide all parent menus recursively, if any (defaults to false)
576      */
577     hide : function(deep){
578         this.deepHide = deep;
579         Ext.menu.Menu.superclass.hide.call(this);
580         delete this.deepHide;
581     },
582
583     // private
584     onHide : function(){
585         Ext.menu.Menu.superclass.onHide.call(this);
586         this.deactivateActive();
587         if(this.el && this.floating){
588             this.el.hide();
589         }
590         var pm = this.parentMenu;
591         if(this.deepHide === true && pm){
592             if(pm.floating){
593                 pm.hide(true);
594             }else{
595                 pm.deactivateActive();
596             }
597         }
598     },
599
600     // private
601     lookupComponent : function(c){
602          if(Ext.isString(c)){
603             c = (c == 'separator' || c == '-') ? new Ext.menu.Separator() : new Ext.menu.TextItem(c);
604              this.applyDefaults(c);
605          }else{
606             if(Ext.isObject(c)){
607                 c = this.getMenuItem(c);
608             }else if(c.tagName || c.el){ // element. Wrap it.
609                 c = new Ext.BoxComponent({
610                     el: c
611                 });
612             }
613          }
614          return c;
615     },
616
617     applyDefaults : function(c){
618         if(!Ext.isString(c)){
619             c = Ext.menu.Menu.superclass.applyDefaults.call(this, c);
620             var d = this.internalDefaults;
621             if(d){
622                 if(c.events){
623                     Ext.applyIf(c.initialConfig, d);
624                     Ext.apply(c, d);
625                 }else{
626                     Ext.applyIf(c, d);
627                 }
628             }
629         }
630         return c;
631     },
632
633     // private
634     getMenuItem : function(config){
635        if(!config.isXType){
636             if(!config.xtype && Ext.isBoolean(config.checked)){
637                 return new Ext.menu.CheckItem(config)
638             }
639             return Ext.create(config, this.defaultType);
640         }
641         return config;
642     },
643
644     <div id="method-Ext.menu.Menu-addSeparator"></div>/**
645      * Adds a separator bar to the menu
646      * @return {Ext.menu.Item} The menu item that was added
647      */
648     addSeparator : function(){
649         return this.add(new Ext.menu.Separator());
650     },
651
652     <div id="method-Ext.menu.Menu-addElement"></div>/**
653      * Adds an {@link Ext.Element} object to the menu
654      * @param {Mixed} el The element or DOM node to add, or its id
655      * @return {Ext.menu.Item} The menu item that was added
656      */
657     addElement : function(el){
658         return this.add(new Ext.menu.BaseItem(el));
659     },
660
661     <div id="method-Ext.menu.Menu-addItem"></div>/**
662      * Adds an existing object based on {@link Ext.menu.BaseItem} to the menu
663      * @param {Ext.menu.Item} item The menu item to add
664      * @return {Ext.menu.Item} The menu item that was added
665      */
666     addItem : function(item){
667         return this.add(item);
668     },
669
670     <div id="method-Ext.menu.Menu-addMenuItem"></div>/**
671      * Creates a new {@link Ext.menu.Item} based an the supplied config object and adds it to the menu
672      * @param {Object} config A MenuItem config object
673      * @return {Ext.menu.Item} The menu item that was added
674      */
675     addMenuItem : function(config){
676         return this.add(this.getMenuItem(config));
677     },
678
679     <div id="method-Ext.menu.Menu-addText"></div>/**
680      * Creates a new {@link Ext.menu.TextItem} with the supplied text and adds it to the menu
681      * @param {String} text The text to display in the menu item
682      * @return {Ext.menu.Item} The menu item that was added
683      */
684     addText : function(text){
685         return this.add(new Ext.menu.TextItem(text));
686     },
687
688     //private
689     onDestroy : function(){
690         var pm = this.parentMenu;
691         if(pm && pm.activeChild == this){
692             delete pm.activeChild;
693         }
694         delete this.parentMenu;
695         Ext.menu.Menu.superclass.onDestroy.call(this);
696         Ext.menu.MenuMgr.unregister(this);
697         Ext.EventManager.removeResizeListener(this.hide, this);
698         if(this.keyNav) {
699             this.keyNav.disable();
700         }
701         var s = this.scroller;
702         if(s){
703             Ext.destroy(s.topRepeater, s.bottomRepeater, s.top, s.bottom);
704         }
705         Ext.destroy(
706             this.el,
707             this.focusEl,
708             this.ul
709         );
710     }
711 });
712
713 Ext.reg('menu', Ext.menu.Menu);
714
715 // MenuNav is a private utility class used internally by the Menu
716 Ext.menu.MenuNav = Ext.extend(Ext.KeyNav, function(){
717     function up(e, m){
718         if(!m.tryActivate(m.items.indexOf(m.activeItem)-1, -1)){
719             m.tryActivate(m.items.length-1, -1);
720         }
721     }
722     function down(e, m){
723         if(!m.tryActivate(m.items.indexOf(m.activeItem)+1, 1)){
724             m.tryActivate(0, 1);
725         }
726     }
727     return {
728         constructor : function(menu){
729             Ext.menu.MenuNav.superclass.constructor.call(this, menu.el);
730             this.scope = this.menu = menu;
731         },
732
733         doRelay : function(e, h){
734             var k = e.getKey();
735 //          Keystrokes within a form Field (e.g.: down in a Combo) do not navigate. Allow only TAB
736             if (this.menu.activeItem && this.menu.activeItem.isFormField && k != e.TAB) {
737                 return false;
738             }
739             if(!this.menu.activeItem && e.isNavKeyPress() && k != e.SPACE && k != e.RETURN){
740                 this.menu.tryActivate(0, 1);
741                 return false;
742             }
743             return h.call(this.scope || this, e, this.menu);
744         },
745
746         tab: function(e, m) {
747             e.stopEvent();
748             if (e.shiftKey) {
749                 up(e, m);
750             } else {
751                 down(e, m);
752             }
753         },
754
755         up : up,
756
757         down : down,
758
759         right : function(e, m){
760             if(m.activeItem){
761                 m.activeItem.expandMenu(true);
762             }
763         },
764
765         left : function(e, m){
766             m.hide();
767             if(m.parentMenu && m.parentMenu.activeItem){
768                 m.parentMenu.activeItem.activate();
769             }
770         },
771
772         enter : function(e, m){
773             if(m.activeItem){
774                 e.stopPropagation();
775                 m.activeItem.onClick(e);
776                 m.fireEvent('click', this, m.activeItem);
777                 return true;
778             }
779         }
780     };
781 }());
782 </pre>    \r
783 </body>\r
784 </html>