3 * Copyright(c) 2006-2010 Ext JS, Inc.
5 * http://www.extjs.com/license
9 * @extends Ext.Container
10 * <p>A menu object. This is the container to which you may add menu items. Menu can also serve as a base class
11 * when you want a specialized menu based off of another component (like {@link Ext.menu.DateMenu} for example).</p>
12 * <p>Menus may contain either {@link Ext.menu.Item menu items}, or general {@link Ext.Component Component}s.</p>
13 * <p>To make a contained general {@link Ext.Component Component} line up with other {@link Ext.menu.Item menu items}
14 * specify <tt>iconCls: 'no-icon'</tt>. This reserves a space for an icon, and indents the Component in line
15 * with the other menu items. See {@link Ext.form.ComboBox}.{@link Ext.form.ComboBox#getListParent getListParent}
17 * <p>By default, Menus are absolutely positioned, floating Components. By configuring a Menu with
18 * <b><tt>{@link #floating}:false</tt></b>, a Menu may be used as child of a Container.</p>
22 Ext.menu.Menu = Ext.extend(Ext.Container, {
24 * @cfg {Object} defaults
25 * A config object that will be applied to all items added to this container either via the {@link #items}
26 * config or via the {@link #add} method. The defaults config can contain any number of
27 * name/value property pairs to be added to each item, and should be valid for the types of items
28 * being added to the menu.
32 * An array of items to be added to this menu. Menus may contain either {@link Ext.menu.Item menu items},
33 * or general {@link Ext.Component Component}s.
36 * @cfg {Number} minWidth The minimum width of the menu in pixels (defaults to 120)
40 * @cfg {Boolean/String} shadow True or 'sides' for the default effect, 'frame' for 4-way shadow, and 'drop'
41 * for bottom-right shadow (defaults to 'sides')
45 * @cfg {String} subMenuAlign The {@link Ext.Element#alignTo} anchor position value to use for submenus of
46 * this menu (defaults to 'tl-tr?')
48 subMenuAlign : 'tl-tr?',
50 * @cfg {String} defaultAlign The default {@link Ext.Element#alignTo} anchor position value for this menu
51 * relative to its element of origin (defaults to 'tl-bl?')
53 defaultAlign : 'tl-bl?',
55 * @cfg {Boolean} allowOtherMenus True to allow multiple menus to be displayed at the same time (defaults to false)
57 allowOtherMenus : false,
59 * @cfg {Boolean} ignoreParentClicks True to ignore clicks on any item in this menu that is a parent item (displays
60 * a submenu) so that the submenu is not dismissed when clicking the parent item (defaults to false).
62 ignoreParentClicks : false,
64 * @cfg {Boolean} enableScrolling True to allow the menu container to have scroller controls if the menu is too long (defaults to true).
66 enableScrolling : true,
68 * @cfg {Number} maxHeight The maximum height of the menu. Only applies when enableScrolling is set to True (defaults to null).
72 * @cfg {Number} scrollIncrement The amount to scroll the menu. Only applies when enableScrolling is set to True (defaults to 24).
76 * @cfg {Boolean} showSeparator True to show the icon separator. (defaults to true).
80 * @cfg {Array} defaultOffsets An array specifying the [x, y] offset in pixels by which to
81 * change the default Menu popup position after aligning according to the {@link #defaultAlign}
82 * configuration. Defaults to <tt>[0, 0]</tt>.
84 defaultOffsets : [0, 0],
87 * @cfg {Boolean} plain
88 * True to remove the incised line down the left side of the menu. Defaults to <tt>false</tt>.
93 * @cfg {Boolean} floating
94 * <p>By default, a Menu configured as <b><code>floating:true</code></b>
95 * will be rendered as an {@link Ext.Layer} (an absolutely positioned,
96 * floating Component with zindex=15000).
97 * If configured as <b><code>floating:false</code></b>, the Menu may be
98 * used as child item of another Container instead of a free-floating
99 * {@link Ext.Layer Layer}.
105 * @cfg {Number} zIndex
106 * zIndex to use when the menu is floating.
114 * @cfg {String/Object} layout
115 * This class assigns a default layout (<code>layout:'<b>menu</b>'</code>).
116 * Developers <i>may</i> override this configuration option if another layout is required.
117 * See {@link Ext.Container#layout} for additional information.
120 hideMode : 'offsets', // Important for laying out Components
122 autoLayout : true, // Provided for backwards compat
123 defaultType : 'menuitem',
124 bufferResize : false,
126 initComponent : function(){
127 if(Ext.isArray(this.initialConfig)){
128 Ext.apply(this, {items:this.initialConfig});
133 * Fires when this menu is clicked (or when the enter key is pressed while it is active)
134 * @param {Ext.menu.Menu} this
135 * @param {Ext.menu.Item} menuItem The menu item that was clicked
136 * @param {Ext.EventObject} e
141 * Fires when the mouse is hovering over this menu
142 * @param {Ext.menu.Menu} this
143 * @param {Ext.EventObject} e
144 * @param {Ext.menu.Item} menuItem The menu item that was clicked
149 * Fires when the mouse exits this menu
150 * @param {Ext.menu.Menu} this
151 * @param {Ext.EventObject} e
152 * @param {Ext.menu.Item} menuItem The menu item that was clicked
157 * Fires when a menu item contained in this menu is clicked
158 * @param {Ext.menu.BaseItem} baseItem The BaseItem that was clicked
159 * @param {Ext.EventObject} e
163 Ext.menu.MenuMgr.register(this);
165 Ext.EventManager.onWindowResize(this.hide, this);
167 if(this.initialConfig.hidden !== false){
170 this.internalDefaults = {hideOnClick: false};
172 Ext.menu.Menu.superclass.initComponent.call(this);
174 var fn = this.doLayout.createDelegate(this, []);
183 getLayoutTarget : function() {
188 onRender : function(ct, position){
195 cls: 'x-menu ' + ((this.floating) ? 'x-menu-floating x-layer ' : '') + (this.cls || '') + (this.plain ? ' x-menu-plain' : '') + (this.showSeparator ? '' : ' x-menu-nosep'),
198 {tag: 'a', cls: 'x-menu-focus', href: '#', onclick: 'return false;', tabIndex: '-1'},
199 {tag: 'ul', cls: 'x-menu-list'}
203 this.el = new Ext.Layer({
211 this.el = ct.createChild(dh);
213 Ext.menu.Menu.superclass.onRender.call(this, ct, position);
216 this.keyNav = new Ext.menu.MenuNav(this);
218 // generic focus element
219 this.focusEl = this.el.child('a.x-menu-focus');
220 this.ul = this.el.child('ul.x-menu-list');
224 mouseover: this.onMouseOver,
225 mouseout: this.onMouseOut
227 if(this.enableScrolling){
230 delegate: '.x-menu-scroller',
231 click: this.onScroll,
232 mouseover: this.deactivateActive
238 findTargetItem : function(e){
239 var t = e.getTarget('.x-menu-list-item', this.ul, true);
240 if(t && t.menuItemId){
241 return this.items.get(t.menuItemId);
246 onClick : function(e){
247 var t = this.findTargetItem(e);
250 this.setActiveItem(t);
251 }else if(t instanceof Ext.menu.BaseItem){
252 if(t.menu && this.ignoreParentClicks){
257 this.fireEvent('click', this, t, e);
264 setActiveItem : function(item, autoExpand){
265 if(item != this.activeItem){
266 this.deactivateActive();
267 if((this.activeItem = item).isFormField){
270 item.activate(autoExpand);
272 }else if(autoExpand){
277 deactivateActive : function(){
278 var a = this.activeItem;
281 //Fields cannot deactivate, but Combos must collapse
288 delete this.activeItem;
293 tryActivate : function(start, step){
294 var items = this.items;
295 for(var i = start, len = items.length; i >= 0 && i < len; i+= step){
296 var item = items.get(i);
297 if(!item.disabled && (item.canActivate || item.isFormField)){
298 this.setActiveItem(item, false);
306 onMouseOver : function(e){
307 var t = this.findTargetItem(e);
309 if(t.canActivate && !t.disabled){
310 this.setActiveItem(t, true);
314 this.fireEvent('mouseover', this, e, t);
318 onMouseOut : function(e){
319 var t = this.findTargetItem(e);
321 if(t == this.activeItem && t.shouldDeactivate && t.shouldDeactivate(e)){
322 this.activeItem.deactivate();
323 delete this.activeItem;
327 this.fireEvent('mouseout', this, e, t);
331 onScroll : function(e, t){
335 var ul = this.ul.dom, top = Ext.fly(t).is('.x-menu-scroller-top');
336 ul.scrollTop += this.scrollIncrement * (top ? -1 : 1);
337 if(top ? ul.scrollTop <= 0 : ul.scrollTop + this.activeMax >= ul.scrollHeight){
338 this.onScrollerOut(null, t);
343 onScrollerIn : function(e, t){
344 var ul = this.ul.dom, top = Ext.fly(t).is('.x-menu-scroller-top');
345 if(top ? ul.scrollTop > 0 : ul.scrollTop + this.activeMax < ul.scrollHeight){
346 Ext.fly(t).addClass(['x-menu-item-active', 'x-menu-scroller-active']);
351 onScrollerOut : function(e, t){
352 Ext.fly(t).removeClass(['x-menu-item-active', 'x-menu-scroller-active']);
356 * If <code>{@link #floating}=true</code>, shows this menu relative to
357 * another element using {@link #showat}, otherwise uses {@link Ext.Component#show}.
358 * @param {Mixed} element The element to align to
359 * @param {String} position (optional) The {@link Ext.Element#alignTo} anchor position to use in aligning to
360 * the element (defaults to this.defaultAlign)
361 * @param {Ext.menu.Menu} parentMenu (optional) This menu's parent menu, if applicable (defaults to undefined)
363 show : function(el, pos, parentMenu){
365 this.parentMenu = parentMenu;
368 this.doLayout(false, true);
370 this.showAt(this.el.getAlignToXY(el, pos || this.defaultAlign, this.defaultOffsets), parentMenu);
372 Ext.menu.Menu.superclass.show.call(this);
377 * Displays this menu at a specific xy position and fires the 'show' event if a
378 * handler for the 'beforeshow' event does not return false cancelling the operation.
379 * @param {Array} xyPosition Contains X & Y [x, y] values for the position at which to show the menu (coordinates are page-based)
380 * @param {Ext.menu.Menu} parentMenu (optional) This menu's parent menu, if applicable (defaults to undefined)
382 showAt : function(xy, parentMenu){
383 if(this.fireEvent('beforeshow', this) !== false){
384 this.parentMenu = parentMenu;
388 if(this.enableScrolling){
389 // set the position so we can figure out the constrain value.
391 //constrain the value, keep the y coordinate the same
392 xy[1] = this.constrainScroll(xy[1]);
393 xy = [this.el.adjustForConstraints(xy)[0], xy[1]];
395 //constrain to the viewport.
396 xy = this.el.adjustForConstraints(xy);
400 Ext.menu.Menu.superclass.onShow.call(this);
402 // internal event, used so we don't couple the layout to the menu
403 this.fireEvent('autosize', this);
410 this.fireEvent('show', this);
414 constrainScroll : function(y){
415 var max, full = this.ul.setHeight('auto').getHeight(),
416 returnY = y, normalY, parentEl, scrollTop, viewHeight;
418 parentEl = Ext.fly(this.el.dom.parentNode);
419 scrollTop = parentEl.getScroll().top;
420 viewHeight = parentEl.getViewSize().height;
421 //Normalize y by the scroll position for the parent element. Need to move it into the coordinate space
423 normalY = y - scrollTop;
424 max = this.maxHeight ? this.maxHeight : viewHeight - normalY;
425 if(full > viewHeight) {
427 //Set returnY equal to (0,0) in view space by reducing y by the value of normalY
428 returnY = y - normalY;
429 } else if(max < full) {
430 returnY = y - (full - max);
434 max = this.getHeight();
436 // Always respect maxHeight
438 max = Math.min(this.maxHeight, max);
440 if(full > max && max > 0){
441 this.activeMax = max - this.scrollerHeight * 2 - this.el.getFrameWidth('tb') - Ext.num(this.el.shadowOffset, 0);
442 this.ul.setHeight(this.activeMax);
443 this.createScrollers();
444 this.el.select('.x-menu-scroller').setDisplayed('');
446 this.ul.setHeight(full);
447 this.el.select('.x-menu-scroller').setDisplayed('none');
449 this.ul.dom.scrollTop = 0;
453 createScrollers : function(){
457 top: this.el.insertFirst({
459 cls: 'x-menu-scroller x-menu-scroller-top',
462 bottom: this.el.createChild({
464 cls: 'x-menu-scroller x-menu-scroller-bottom',
468 this.scroller.top.hover(this.onScrollerIn, this.onScrollerOut, this);
469 this.scroller.topRepeater = new Ext.util.ClickRepeater(this.scroller.top, {
471 click: this.onScroll.createDelegate(this, [null, this.scroller.top], false)
474 this.scroller.bottom.hover(this.onScrollerIn, this.onScrollerOut, this);
475 this.scroller.bottomRepeater = new Ext.util.ClickRepeater(this.scroller.bottom, {
477 click: this.onScroll.createDelegate(this, [null, this.scroller.bottom], false)
483 onLayout : function(){
484 if(this.isVisible()){
485 if(this.enableScrolling){
486 this.constrainScroll(this.el.getTop());
496 this.doFocus.defer(50, this);
500 doFocus : function(){
502 this.focusEl.focus();
507 * Hides this menu and optionally all parent menus
508 * @param {Boolean} deep (optional) True to hide all parent menus recursively, if any (defaults to false)
510 hide : function(deep){
511 if (!this.isDestroyed) {
512 this.deepHide = deep;
513 Ext.menu.Menu.superclass.hide.call(this);
514 delete this.deepHide;
520 Ext.menu.Menu.superclass.onHide.call(this);
521 this.deactivateActive();
522 if(this.el && this.floating){
525 var pm = this.parentMenu;
526 if(this.deepHide === true && pm){
530 pm.deactivateActive();
536 lookupComponent : function(c){
538 c = (c == 'separator' || c == '-') ? new Ext.menu.Separator() : new Ext.menu.TextItem(c);
539 this.applyDefaults(c);
542 c = this.getMenuItem(c);
543 }else if(c.tagName || c.el){ // element. Wrap it.
544 c = new Ext.BoxComponent({
552 applyDefaults : function(c){
553 if(!Ext.isString(c)){
554 c = Ext.menu.Menu.superclass.applyDefaults.call(this, c);
555 var d = this.internalDefaults;
558 Ext.applyIf(c.initialConfig, d);
569 getMenuItem : function(config){
571 if(!config.xtype && Ext.isBoolean(config.checked)){
572 return new Ext.menu.CheckItem(config)
574 return Ext.create(config, this.defaultType);
580 * Adds a separator bar to the menu
581 * @return {Ext.menu.Item} The menu item that was added
583 addSeparator : function(){
584 return this.add(new Ext.menu.Separator());
588 * Adds an {@link Ext.Element} object to the menu
589 * @param {Mixed} el The element or DOM node to add, or its id
590 * @return {Ext.menu.Item} The menu item that was added
592 addElement : function(el){
593 return this.add(new Ext.menu.BaseItem({
599 * Adds an existing object based on {@link Ext.menu.BaseItem} to the menu
600 * @param {Ext.menu.Item} item The menu item to add
601 * @return {Ext.menu.Item} The menu item that was added
603 addItem : function(item){
604 return this.add(item);
608 * Creates a new {@link Ext.menu.Item} based an the supplied config object and adds it to the menu
609 * @param {Object} config A MenuItem config object
610 * @return {Ext.menu.Item} The menu item that was added
612 addMenuItem : function(config){
613 return this.add(this.getMenuItem(config));
617 * Creates a new {@link Ext.menu.TextItem} with the supplied text and adds it to the menu
618 * @param {String} text The text to display in the menu item
619 * @return {Ext.menu.Item} The menu item that was added
621 addText : function(text){
622 return this.add(new Ext.menu.TextItem(text));
626 onDestroy : function(){
627 Ext.EventManager.removeResizeListener(this.hide, this);
628 var pm = this.parentMenu;
629 if(pm && pm.activeChild == this){
630 delete pm.activeChild;
632 delete this.parentMenu;
633 Ext.menu.Menu.superclass.onDestroy.call(this);
634 Ext.menu.MenuMgr.unregister(this);
636 this.keyNav.disable();
638 var s = this.scroller;
640 Ext.destroy(s.topRepeater, s.bottomRepeater, s.top, s.bottom);
650 Ext.reg('menu', Ext.menu.Menu);
652 // MenuNav is a private utility class used internally by the Menu
653 Ext.menu.MenuNav = Ext.extend(Ext.KeyNav, function(){
655 if(!m.tryActivate(m.items.indexOf(m.activeItem)-1, -1)){
656 m.tryActivate(m.items.length-1, -1);
660 if(!m.tryActivate(m.items.indexOf(m.activeItem)+1, 1)){
665 constructor : function(menu){
666 Ext.menu.MenuNav.superclass.constructor.call(this, menu.el);
667 this.scope = this.menu = menu;
670 doRelay : function(e, h){
672 // Keystrokes within a form Field (e.g.: down in a Combo) do not navigate. Allow only TAB
673 if (this.menu.activeItem && this.menu.activeItem.isFormField && k != e.TAB) {
676 if(!this.menu.activeItem && e.isNavKeyPress() && k != e.SPACE && k != e.RETURN){
677 this.menu.tryActivate(0, 1);
680 return h.call(this.scope || this, e, this.menu);
683 tab: function(e, m) {
696 right : function(e, m){
698 m.activeItem.expandMenu(true);
702 left : function(e, m){
704 if(m.parentMenu && m.parentMenu.activeItem){
705 m.parentMenu.activeItem.activate();
709 enter : function(e, m){
712 m.activeItem.onClick(e);
713 m.fireEvent('click', this, m.activeItem);