3 * Copyright(c) 2006-2010 Ext JS, LLC
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 if(full > max && max > 0){
437 this.activeMax = max - this.scrollerHeight * 2 - this.el.getFrameWidth('tb') - Ext.num(this.el.shadowOffset, 0);
438 this.ul.setHeight(this.activeMax);
439 this.createScrollers();
440 this.el.select('.x-menu-scroller').setDisplayed('');
442 this.ul.setHeight(full);
443 this.el.select('.x-menu-scroller').setDisplayed('none');
445 this.ul.dom.scrollTop = 0;
449 createScrollers : function(){
453 top: this.el.insertFirst({
455 cls: 'x-menu-scroller x-menu-scroller-top',
458 bottom: this.el.createChild({
460 cls: 'x-menu-scroller x-menu-scroller-bottom',
464 this.scroller.top.hover(this.onScrollerIn, this.onScrollerOut, this);
465 this.scroller.topRepeater = new Ext.util.ClickRepeater(this.scroller.top, {
467 click: this.onScroll.createDelegate(this, [null, this.scroller.top], false)
470 this.scroller.bottom.hover(this.onScrollerIn, this.onScrollerOut, this);
471 this.scroller.bottomRepeater = new Ext.util.ClickRepeater(this.scroller.bottom, {
473 click: this.onScroll.createDelegate(this, [null, this.scroller.bottom], false)
479 onLayout : function(){
480 if(this.isVisible()){
481 if(this.enableScrolling){
482 this.constrainScroll(this.el.getTop());
492 this.doFocus.defer(50, this);
496 doFocus : function(){
498 this.focusEl.focus();
503 * Hides this menu and optionally all parent menus
504 * @param {Boolean} deep (optional) True to hide all parent menus recursively, if any (defaults to false)
506 hide : function(deep){
507 if (!this.isDestroyed) {
508 this.deepHide = deep;
509 Ext.menu.Menu.superclass.hide.call(this);
510 delete this.deepHide;
516 Ext.menu.Menu.superclass.onHide.call(this);
517 this.deactivateActive();
518 if(this.el && this.floating){
521 var pm = this.parentMenu;
522 if(this.deepHide === true && pm){
526 pm.deactivateActive();
532 lookupComponent : function(c){
534 c = (c == 'separator' || c == '-') ? new Ext.menu.Separator() : new Ext.menu.TextItem(c);
535 this.applyDefaults(c);
538 c = this.getMenuItem(c);
539 }else if(c.tagName || c.el){ // element. Wrap it.
540 c = new Ext.BoxComponent({
548 applyDefaults : function(c){
549 if(!Ext.isString(c)){
550 c = Ext.menu.Menu.superclass.applyDefaults.call(this, c);
551 var d = this.internalDefaults;
554 Ext.applyIf(c.initialConfig, d);
565 getMenuItem : function(config){
567 if(!config.xtype && Ext.isBoolean(config.checked)){
568 return new Ext.menu.CheckItem(config)
570 return Ext.create(config, this.defaultType);
576 * Adds a separator bar to the menu
577 * @return {Ext.menu.Item} The menu item that was added
579 addSeparator : function(){
580 return this.add(new Ext.menu.Separator());
584 * Adds an {@link Ext.Element} object to the menu
585 * @param {Mixed} el The element or DOM node to add, or its id
586 * @return {Ext.menu.Item} The menu item that was added
588 addElement : function(el){
589 return this.add(new Ext.menu.BaseItem({
595 * Adds an existing object based on {@link Ext.menu.BaseItem} to the menu
596 * @param {Ext.menu.Item} item The menu item to add
597 * @return {Ext.menu.Item} The menu item that was added
599 addItem : function(item){
600 return this.add(item);
604 * Creates a new {@link Ext.menu.Item} based an the supplied config object and adds it to the menu
605 * @param {Object} config A MenuItem config object
606 * @return {Ext.menu.Item} The menu item that was added
608 addMenuItem : function(config){
609 return this.add(this.getMenuItem(config));
613 * Creates a new {@link Ext.menu.TextItem} with the supplied text and adds it to the menu
614 * @param {String} text The text to display in the menu item
615 * @return {Ext.menu.Item} The menu item that was added
617 addText : function(text){
618 return this.add(new Ext.menu.TextItem(text));
622 onDestroy : function(){
623 Ext.EventManager.removeResizeListener(this.hide, this);
624 var pm = this.parentMenu;
625 if(pm && pm.activeChild == this){
626 delete pm.activeChild;
628 delete this.parentMenu;
629 Ext.menu.Menu.superclass.onDestroy.call(this);
630 Ext.menu.MenuMgr.unregister(this);
632 this.keyNav.disable();
634 var s = this.scroller;
636 Ext.destroy(s.topRepeater, s.bottomRepeater, s.top, s.bottom);
646 Ext.reg('menu', Ext.menu.Menu);
648 // MenuNav is a private utility class used internally by the Menu
649 Ext.menu.MenuNav = Ext.extend(Ext.KeyNav, function(){
651 if(!m.tryActivate(m.items.indexOf(m.activeItem)-1, -1)){
652 m.tryActivate(m.items.length-1, -1);
656 if(!m.tryActivate(m.items.indexOf(m.activeItem)+1, 1)){
661 constructor : function(menu){
662 Ext.menu.MenuNav.superclass.constructor.call(this, menu.el);
663 this.scope = this.menu = menu;
666 doRelay : function(e, h){
668 // Keystrokes within a form Field (e.g.: down in a Combo) do not navigate. Allow only TAB
669 if (this.menu.activeItem && this.menu.activeItem.isFormField && k != e.TAB) {
672 if(!this.menu.activeItem && e.isNavKeyPress() && k != e.SPACE && k != e.RETURN){
673 this.menu.tryActivate(0, 1);
676 return h.call(this.scope || this, e, this.menu);
679 tab: function(e, m) {
692 right : function(e, m){
694 m.activeItem.expandMenu(true);
698 left : function(e, m){
700 if(m.parentMenu && m.parentMenu.activeItem){
701 m.parentMenu.activeItem.activate();
705 enter : function(e, m){
708 m.activeItem.onClick(e);
709 m.fireEvent('click', this, m.activeItem);
716 * @class Ext.menu.MenuMgr
717 * Provides a common registry of all menu items on a page so that they can be easily accessed by id.
720 Ext.menu.MenuMgr = function(){
721 var menus, active, groups = {}, attached = false, lastShow = new Date();
723 // private - called when first menu is created
726 active = new Ext.util.MixedCollection();
727 Ext.getDoc().addKeyListener(27, function(){
728 if(active.length > 0){
736 if(active && active.length > 0){
737 var c = active.clone();
749 if(active.length < 1){
750 Ext.getDoc().un("mousedown", onMouseDown);
757 var last = active.last();
758 lastShow = new Date();
761 Ext.getDoc().on("mousedown", onMouseDown);
765 m.getEl().setZIndex(parseInt(m.parentMenu.getEl().getStyle("z-index"), 10) + 3);
766 m.parentMenu.activeChild = m;
767 }else if(last && !last.isDestroyed && last.isVisible()){
768 m.getEl().setZIndex(parseInt(last.getEl().getStyle("z-index"), 10) + 3);
773 function onBeforeHide(m){
775 m.activeChild.hide();
778 clearTimeout(m.autoHideTimer);
779 delete m.autoHideTimer;
784 function onBeforeShow(m){
785 var pm = m.parentMenu;
786 if(!pm && !m.allowOtherMenus){
788 }else if(pm && pm.activeChild){
789 pm.activeChild.hide();
794 function onMouseDown(e){
795 if(lastShow.getElapsed() > 50 && active.length > 0 && !e.getTarget(".x-menu")){
801 function onBeforeCheck(mi, state){
803 var g = groups[mi.group];
804 for(var i = 0, l = g.length; i < l; i++){
806 g[i].setChecked(false);
815 * Hides all menus that are currently visible
816 * @return {Boolean} success True if any active menus were hidden.
818 hideAll : function(){
823 register : function(menu){
827 menus[menu.id] = menu;
829 beforehide: onBeforeHide,
831 beforeshow: onBeforeShow,
837 * Returns a {@link Ext.menu.Menu} object
838 * @param {String/Object} menu The string menu id, an existing menu object reference, or a Menu config that will
839 * be used to generate and return a new Menu instance.
840 * @return {Ext.menu.Menu} The specified menu, or null if none are found
842 get : function(menu){
843 if(typeof menu == "string"){ // menu id
844 if(!menus){ // not initialized, no menus to return
848 }else if(menu.events){ // menu instance
850 }else if(typeof menu.length == 'number'){ // array of menu items?
851 return new Ext.menu.Menu({items:menu});
852 }else{ // otherwise, must be a config
853 return Ext.create(menu, 'menu');
858 unregister : function(menu){
859 delete menus[menu.id];
860 menu.un("beforehide", onBeforeHide);
861 menu.un("hide", onHide);
862 menu.un("beforeshow", onBeforeShow);
863 menu.un("show", onShow);
867 registerCheckable : function(menuItem){
868 var g = menuItem.group;
873 groups[g].push(menuItem);
874 menuItem.on("beforecheckchange", onBeforeCheck);
879 unregisterCheckable : function(menuItem){
880 var g = menuItem.group;
882 groups[g].remove(menuItem);
883 menuItem.un("beforecheckchange", onBeforeCheck);
887 getCheckedItem : function(groupId){
888 var g = groups[groupId];
890 for(var i = 0, l = g.length; i < l; i++){
899 setCheckedItem : function(groupId, itemId){
900 var g = groups[groupId];
902 for(var i = 0, l = g.length; i < l; i++){
903 if(g[i].id == itemId){
904 g[i].setChecked(true);
913 * @class Ext.menu.BaseItem
914 * @extends Ext.Component
915 * The base class for all items that render into menus. BaseItem provides default rendering, activated state
916 * management and base configuration options shared by all menu components.
918 * Creates a new BaseItem
919 * @param {Object} config Configuration options
920 * @xtype menubaseitem
922 Ext.menu.BaseItem = Ext.extend(Ext.Component, {
924 * @property parentMenu
925 * @type Ext.menu.Menu
926 * The parent Menu of this Item.
929 * @cfg {Function} handler
930 * A function that will handle the click event of this menu item (optional).
931 * The handler is passed the following parameters:<div class="mdetail-params"><ul>
932 * <li><code>b</code> : Item<div class="sub-desc">This menu Item.</div></li>
933 * <li><code>e</code> : EventObject<div class="sub-desc">The click event.</div></li>
937 * @cfg {Object} scope
938 * The scope (<tt><b>this</b></tt> reference) in which the handler function will be called.
941 * @cfg {Boolean} canActivate True if this item can be visually activated (defaults to false)
945 * @cfg {String} activeClass The CSS class to use when the item becomes activated (defaults to "x-menu-item-active")
947 activeClass : "x-menu-item-active",
949 * @cfg {Boolean} hideOnClick True to hide the containing menu after this item is clicked (defaults to true)
953 * @cfg {Number} clickHideDelay Length of time in milliseconds to wait before hiding after a click (defaults to 100)
958 ctype : "Ext.menu.BaseItem",
961 actionMode : "container",
963 initComponent : function(){
964 Ext.menu.BaseItem.superclass.initComponent.call(this);
968 * Fires when this item is clicked
969 * @param {Ext.menu.BaseItem} this
970 * @param {Ext.EventObject} e
975 * Fires when this item is activated
976 * @param {Ext.menu.BaseItem} this
981 * Fires when this item is deactivated
982 * @param {Ext.menu.BaseItem} this
987 this.on("click", this.handler, this.scope);
992 onRender : function(container, position){
993 Ext.menu.BaseItem.superclass.onRender.apply(this, arguments);
994 if(this.ownerCt && this.ownerCt instanceof Ext.menu.Menu){
995 this.parentMenu = this.ownerCt;
997 this.container.addClass('x-menu-list-item');
1000 click: this.onClick,
1001 mouseenter: this.activate,
1002 mouseleave: this.deactivate
1008 * Sets the function that will handle click events for this item (equivalent to passing in the {@link #handler}
1009 * config property). If an existing handler is already registered, it will be unregistered for you.
1010 * @param {Function} handler The function that should be called on click
1011 * @param {Object} scope The scope (<code>this</code> reference) in which the handler function is executed. Defaults to this menu item.
1013 setHandler : function(handler, scope){
1015 this.un("click", this.handler, this.scope);
1017 this.on("click", this.handler = handler, this.scope = scope);
1021 onClick : function(e){
1022 if(!this.disabled && this.fireEvent("click", this, e) !== false
1023 && (this.parentMenu && this.parentMenu.fireEvent("itemclick", this, e) !== false)){
1024 this.handleClick(e);
1031 activate : function(){
1035 var li = this.container;
1036 li.addClass(this.activeClass);
1037 this.region = li.getRegion().adjust(2, 2, -2, -2);
1038 this.fireEvent("activate", this);
1043 deactivate : function(){
1044 this.container.removeClass(this.activeClass);
1045 this.fireEvent("deactivate", this);
1049 shouldDeactivate : function(e){
1050 return !this.region || !this.region.contains(e.getPoint());
1054 handleClick : function(e){
1055 var pm = this.parentMenu;
1056 if(this.hideOnClick){
1058 pm.hide.defer(this.clickHideDelay, pm, [true]);
1060 pm.deactivateActive();
1065 // private. Do nothing
1066 expandMenu : Ext.emptyFn,
1068 // private. Do nothing
1069 hideMenu : Ext.emptyFn
1071 Ext.reg('menubaseitem', Ext.menu.BaseItem);/**
1072 * @class Ext.menu.TextItem
1073 * @extends Ext.menu.BaseItem
1074 * Adds a static text string to a menu, usually used as either a heading or group separator.
1076 * Creates a new TextItem
1077 * @param {Object/String} config If config is a string, it is used as the text to display, otherwise it
1078 * is applied as a config object (and should contain a <tt>text</tt> property).
1079 * @xtype menutextitem
1081 Ext.menu.TextItem = Ext.extend(Ext.menu.BaseItem, {
1083 * @cfg {String} text The text to display for this item (defaults to '')
1086 * @cfg {Boolean} hideOnClick True to hide the containing menu after this item is clicked (defaults to false)
1088 hideOnClick : false,
1090 * @cfg {String} itemCls The default CSS class to use for text items (defaults to "x-menu-text")
1092 itemCls : "x-menu-text",
1094 constructor : function(config){
1095 if(typeof config == 'string'){
1096 config = {text: config}
1098 Ext.menu.TextItem.superclass.constructor.call(this, config);
1102 onRender : function(){
1103 var s = document.createElement("span");
1104 s.className = this.itemCls;
1105 s.innerHTML = this.text;
1107 Ext.menu.TextItem.superclass.onRender.apply(this, arguments);
1110 Ext.reg('menutextitem', Ext.menu.TextItem);/**
1111 * @class Ext.menu.Separator
1112 * @extends Ext.menu.BaseItem
1113 * Adds a separator bar to a menu, used to divide logical groups of menu items. Generally you will
1114 * add one of these by using "-" in you call to add() or in your items config rather than creating one directly.
1116 * @param {Object} config Configuration options
1117 * @xtype menuseparator
1119 Ext.menu.Separator = Ext.extend(Ext.menu.BaseItem, {
1121 * @cfg {String} itemCls The default CSS class to use for separators (defaults to "x-menu-sep")
1123 itemCls : "x-menu-sep",
1125 * @cfg {Boolean} hideOnClick True to hide the containing menu after this item is clicked (defaults to false)
1127 hideOnClick : false,
1130 * @cfg {String} activeClass
1136 onRender : function(li){
1137 var s = document.createElement("span");
1138 s.className = this.itemCls;
1139 s.innerHTML = " ";
1141 li.addClass("x-menu-sep-li");
1142 Ext.menu.Separator.superclass.onRender.apply(this, arguments);
1145 Ext.reg('menuseparator', Ext.menu.Separator);/**
\r
1146 * @class Ext.menu.Item
\r
1147 * @extends Ext.menu.BaseItem
\r
1148 * A base class for all menu items that require menu-related functionality (like sub-menus) and are not static
\r
1149 * display items. Item extends the base functionality of {@link Ext.menu.BaseItem} by adding menu-specific
\r
1150 * activation and click handling.
\r
1152 * Creates a new Item
\r
1153 * @param {Object} config Configuration options
\r
1156 Ext.menu.Item = Ext.extend(Ext.menu.BaseItem, {
\r
1159 * @type Ext.menu.Menu
\r
1160 * The submenu associated with this Item if one was configured.
\r
1163 * @cfg {Mixed} menu (optional) Either an instance of {@link Ext.menu.Menu} or the config object for an
\r
1164 * {@link Ext.menu.Menu} which acts as the submenu when this item is activated.
\r
1167 * @cfg {String} icon The path to an icon to display in this item (defaults to Ext.BLANK_IMAGE_URL). If
\r
1168 * icon is specified {@link #iconCls} should not be.
\r
1171 * @cfg {String} iconCls A CSS class that specifies a background image that will be used as the icon for
\r
1172 * this item (defaults to ''). If iconCls is specified {@link #icon} should not be.
\r
1175 * @cfg {String} text The text to display in this item (defaults to '').
\r
1178 * @cfg {String} href The href attribute to use for the underlying anchor link (defaults to '#').
\r
1181 * @cfg {String} hrefTarget The target attribute to use for the underlying anchor link (defaults to '').
\r
1184 * @cfg {String} itemCls The default CSS class to use for menu items (defaults to 'x-menu-item')
\r
1186 itemCls : 'x-menu-item',
\r
1188 * @cfg {Boolean} canActivate True if this item can be visually activated (defaults to true)
\r
1190 canActivate : true,
\r
1192 * @cfg {Number} showDelay Length of time in milliseconds to wait before showing this item (defaults to 200)
\r
1195 // doc'd in BaseItem
\r
1199 ctype: 'Ext.menu.Item',
\r
1201 initComponent : function(){
\r
1202 Ext.menu.Item.superclass.initComponent.call(this);
\r
1204 this.menu = Ext.menu.MenuMgr.get(this.menu);
\r
1205 this.menu.ownerCt = this;
\r
1210 onRender : function(container, position){
\r
1211 if (!this.itemTpl) {
\r
1212 this.itemTpl = Ext.menu.Item.prototype.itemTpl = new Ext.XTemplate(
\r
1213 '<a id="{id}" class="{cls}" hidefocus="true" unselectable="on" href="{href}"',
\r
1214 '<tpl if="hrefTarget">',
\r
1215 ' target="{hrefTarget}"',
\r
1218 '<img src="{icon}" class="x-menu-item-icon {iconCls}"/>',
\r
1219 '<span class="x-menu-item-text">{text}</span>',
\r
1223 var a = this.getTemplateArgs();
\r
1224 this.el = position ? this.itemTpl.insertBefore(position, a, true) : this.itemTpl.append(container, a, true);
\r
1225 this.iconEl = this.el.child('img.x-menu-item-icon');
\r
1226 this.textEl = this.el.child('.x-menu-item-text');
\r
1227 if(!this.href) { // if no link defined, prevent the default anchor event
\r
1228 this.mon(this.el, 'click', Ext.emptyFn, null, { preventDefault: true });
\r
1230 Ext.menu.Item.superclass.onRender.call(this, container, position);
\r
1233 getTemplateArgs: function() {
\r
1236 cls: this.itemCls + (this.menu ? ' x-menu-item-arrow' : '') + (this.cls ? ' ' + this.cls : ''),
\r
1237 href: this.href || '#',
\r
1238 hrefTarget: this.hrefTarget,
\r
1239 icon: this.icon || Ext.BLANK_IMAGE_URL,
\r
1240 iconCls: this.iconCls || '',
\r
1241 text: this.itemText||this.text||' '
\r
1246 * Sets the text to display in this menu item
\r
1247 * @param {String} text The text to display
\r
1249 setText : function(text){
\r
1250 this.text = text||' ';
\r
1251 if(this.rendered){
\r
1252 this.textEl.update(this.text);
\r
1253 this.parentMenu.layout.doAutoSize();
\r
1258 * Sets the CSS class to apply to the item's icon element
\r
1259 * @param {String} cls The CSS class to apply
\r
1261 setIconClass : function(cls){
\r
1262 var oldCls = this.iconCls;
\r
1263 this.iconCls = cls;
\r
1264 if(this.rendered){
\r
1265 this.iconEl.replaceClass(oldCls, this.iconCls);
\r
1270 beforeDestroy: function(){
\r
1272 delete this.menu.ownerCt;
\r
1273 this.menu.destroy();
\r
1275 Ext.menu.Item.superclass.beforeDestroy.call(this);
\r
1279 handleClick : function(e){
\r
1280 if(!this.href){ // if no link defined, stop the event automatically
\r
1283 Ext.menu.Item.superclass.handleClick.apply(this, arguments);
\r
1287 activate : function(autoExpand){
\r
1288 if(Ext.menu.Item.superclass.activate.apply(this, arguments)){
\r
1291 this.expandMenu();
\r
1298 shouldDeactivate : function(e){
\r
1299 if(Ext.menu.Item.superclass.shouldDeactivate.call(this, e)){
\r
1300 if(this.menu && this.menu.isVisible()){
\r
1301 return !this.menu.getEl().getRegion().contains(e.getPoint());
\r
1309 deactivate : function(){
\r
1310 Ext.menu.Item.superclass.deactivate.apply(this, arguments);
\r
1315 expandMenu : function(autoActivate){
\r
1316 if(!this.disabled && this.menu){
\r
1317 clearTimeout(this.hideTimer);
\r
1318 delete this.hideTimer;
\r
1319 if(!this.menu.isVisible() && !this.showTimer){
\r
1320 this.showTimer = this.deferExpand.defer(this.showDelay, this, [autoActivate]);
\r
1321 }else if (this.menu.isVisible() && autoActivate){
\r
1322 this.menu.tryActivate(0, 1);
\r
1328 deferExpand : function(autoActivate){
\r
1329 delete this.showTimer;
\r
1330 this.menu.show(this.container, this.parentMenu.subMenuAlign || 'tl-tr?', this.parentMenu);
\r
1332 this.menu.tryActivate(0, 1);
\r
1337 hideMenu : function(){
\r
1338 clearTimeout(this.showTimer);
\r
1339 delete this.showTimer;
\r
1340 if(!this.hideTimer && this.menu && this.menu.isVisible()){
\r
1341 this.hideTimer = this.deferHide.defer(this.hideDelay, this);
\r
1346 deferHide : function(){
\r
1347 delete this.hideTimer;
\r
1348 if(this.menu.over){
\r
1349 this.parentMenu.setActiveItem(this, false);
\r
1355 Ext.reg('menuitem', Ext.menu.Item);/**
1356 * @class Ext.menu.CheckItem
1357 * @extends Ext.menu.Item
1358 * Adds a menu item that contains a checkbox by default, but can also be part of a radio group.
1360 * Creates a new CheckItem
1361 * @param {Object} config Configuration options
1362 * @xtype menucheckitem
1364 Ext.menu.CheckItem = Ext.extend(Ext.menu.Item, {
1366 * @cfg {String} group
1367 * All check items with the same group name will automatically be grouped into a single-select
1368 * radio button group (defaults to '')
1371 * @cfg {String} itemCls The default CSS class to use for check items (defaults to "x-menu-item x-menu-check-item")
1373 itemCls : "x-menu-item x-menu-check-item",
1375 * @cfg {String} groupClass The default CSS class to use for radio group check items (defaults to "x-menu-group-item")
1377 groupClass : "x-menu-group-item",
1380 * @cfg {Boolean} checked True to initialize this checkbox as checked (defaults to false). Note that
1381 * if this checkbox is part of a radio group (group = true) only the last item in the group that is
1382 * initialized with checked = true will be rendered as checked.
1387 ctype: "Ext.menu.CheckItem",
1389 initComponent : function(){
1390 Ext.menu.CheckItem.superclass.initComponent.call(this);
1393 * @event beforecheckchange
1394 * Fires before the checked value is set, providing an opportunity to cancel if needed
1395 * @param {Ext.menu.CheckItem} this
1396 * @param {Boolean} checked The new checked value that will be set
1398 "beforecheckchange" ,
1400 * @event checkchange
1401 * Fires after the checked value has been set
1402 * @param {Ext.menu.CheckItem} this
1403 * @param {Boolean} checked The checked value that was set
1408 * A function that handles the checkchange event. The function is undefined by default, but if an implementation
1409 * is provided, it will be called automatically when the checkchange event fires.
1410 * @param {Ext.menu.CheckItem} this
1411 * @param {Boolean} checked The checked value that was set
1412 * @method checkHandler
1414 if(this.checkHandler){
1415 this.on('checkchange', this.checkHandler, this.scope);
1417 Ext.menu.MenuMgr.registerCheckable(this);
1421 onRender : function(c){
1422 Ext.menu.CheckItem.superclass.onRender.apply(this, arguments);
1424 this.el.addClass(this.groupClass);
1427 this.checked = false;
1428 this.setChecked(true, true);
1433 destroy : function(){
1434 Ext.menu.MenuMgr.unregisterCheckable(this);
1435 Ext.menu.CheckItem.superclass.destroy.apply(this, arguments);
1439 * Set the checked state of this item
1440 * @param {Boolean} checked The new checked value
1441 * @param {Boolean} suppressEvent (optional) True to prevent the checkchange event from firing (defaults to false)
1443 setChecked : function(state, suppressEvent){
1444 var suppress = suppressEvent === true;
1445 if(this.checked != state && (suppress || this.fireEvent("beforecheckchange", this, state) !== false)){
1447 this.container[state ? "addClass" : "removeClass"]("x-menu-item-checked");
1449 this.checked = state;
1451 this.fireEvent("checkchange", this, state);
1457 handleClick : function(e){
1458 if(!this.disabled && !(this.checked && this.group)){// disable unselect on radio item
1459 this.setChecked(!this.checked);
1461 Ext.menu.CheckItem.superclass.handleClick.apply(this, arguments);
1464 Ext.reg('menucheckitem', Ext.menu.CheckItem);/**
\r
1465 * @class Ext.menu.DateMenu
\r
1466 * @extends Ext.menu.Menu
\r
1467 * <p>A menu containing an {@link Ext.DatePicker} Component.</p>
\r
1468 * <p>Notes:</p><div class="mdetail-params"><ul>
\r
1469 * <li>Although not listed here, the <b>constructor</b> for this class
\r
1470 * accepts all of the configuration options of <b>{@link Ext.DatePicker}</b>.</li>
\r
1471 * <li>If subclassing DateMenu, any configuration options for the DatePicker must be
\r
1472 * applied to the <tt><b>initialConfig</b></tt> property of the DateMenu.
\r
1473 * Applying {@link Ext.DatePicker DatePicker} configuration settings to
\r
1474 * <b><tt>this</tt></b> will <b>not</b> affect the DatePicker's configuration.</li>
\r
1478 Ext.menu.DateMenu = Ext.extend(Ext.menu.Menu, {
\r
1480 * @cfg {Boolean} enableScrolling
\r
1483 enableScrolling : false,
\r
1485 * @cfg {Function} handler
\r
1486 * Optional. A function that will handle the select event of this menu.
\r
1487 * The handler is passed the following parameters:<div class="mdetail-params"><ul>
\r
1488 * <li><code>picker</code> : DatePicker<div class="sub-desc">The Ext.DatePicker.</div></li>
\r
1489 * <li><code>date</code> : Date<div class="sub-desc">The selected date.</div></li>
\r
1493 * @cfg {Object} scope
\r
1494 * The scope (<tt><b>this</b></tt> reference) in which the <code>{@link #handler}</code>
\r
1495 * function will be called. Defaults to this DateMenu instance.
\r
1498 * @cfg {Boolean} hideOnClick
\r
1499 * False to continue showing the menu after a date is selected, defaults to true.
\r
1501 hideOnClick : true,
\r
1504 * @cfg {String} pickerId
\r
1505 * An id to assign to the underlying date picker. Defaults to <tt>null</tt>.
\r
1510 * @cfg {Number} maxHeight
\r
1514 * @cfg {Number} scrollIncrement
\r
1518 * The {@link Ext.DatePicker} instance for this DateMenu
\r
1519 * @property picker
\r
1520 * @type DatePicker
\r
1522 cls : 'x-date-menu',
\r
1530 * @event itemclick
\r
1534 initComponent : function(){
\r
1535 this.on('beforeshow', this.onBeforeShow, this);
\r
1536 if(this.strict = (Ext.isIE7 && Ext.isStrict)){
\r
1537 this.on('show', this.onShow, this, {single: true, delay: 20});
\r
1541 showSeparator: false,
\r
1542 items: this.picker = new Ext.DatePicker(Ext.applyIf({
\r
1543 internalRender: this.strict || !Ext.isIE,
\r
1544 ctCls: 'x-menu-date-item',
\r
1546 }, this.initialConfig))
\r
1548 this.picker.purgeListeners();
\r
1549 Ext.menu.DateMenu.superclass.initComponent.call(this);
\r
1552 * Fires when a date is selected from the {@link #picker Ext.DatePicker}
\r
1553 * @param {DatePicker} picker The {@link #picker Ext.DatePicker}
\r
1554 * @param {Date} date The selected date
\r
1556 this.relayEvents(this.picker, ['select']);
\r
1557 this.on('show', this.picker.focus, this.picker);
\r
1558 this.on('select', this.menuHide, this);
\r
1560 this.on('select', this.handler, this.scope || this);
\r
1564 menuHide : function() {
\r
1565 if(this.hideOnClick){
\r
1570 onBeforeShow : function(){
\r
1572 this.picker.hideMonthPicker(true);
\r
1576 onShow : function(){
\r
1577 var el = this.picker.getEl();
\r
1578 el.setWidth(el.getWidth()); //nasty hack for IE7 strict mode
\r
1581 Ext.reg('datemenu', Ext.menu.DateMenu);
\r
1583 * @class Ext.menu.ColorMenu
\r
1584 * @extends Ext.menu.Menu
\r
1585 * <p>A menu containing a {@link Ext.ColorPalette} Component.</p>
\r
1586 * <p>Notes:</p><div class="mdetail-params"><ul>
\r
1587 * <li>Although not listed here, the <b>constructor</b> for this class
\r
1588 * accepts all of the configuration options of <b>{@link Ext.ColorPalette}</b>.</li>
\r
1589 * <li>If subclassing ColorMenu, any configuration options for the ColorPalette must be
\r
1590 * applied to the <tt><b>initialConfig</b></tt> property of the ColorMenu.
\r
1591 * Applying {@link Ext.ColorPalette ColorPalette} configuration settings to
\r
1592 * <b><tt>this</tt></b> will <b>not</b> affect the ColorPalette's configuration.</li>
\r
1594 * @xtype colormenu
\r
1596 Ext.menu.ColorMenu = Ext.extend(Ext.menu.Menu, {
\r
1598 * @cfg {Boolean} enableScrolling
\r
1601 enableScrolling : false,
\r
1603 * @cfg {Function} handler
\r
1604 * Optional. A function that will handle the select event of this menu.
\r
1605 * The handler is passed the following parameters:<div class="mdetail-params"><ul>
\r
1606 * <li><code>palette</code> : ColorPalette<div class="sub-desc">The {@link #palette Ext.ColorPalette}.</div></li>
\r
1607 * <li><code>color</code> : String<div class="sub-desc">The 6-digit color hex code (without the # symbol).</div></li>
\r
1611 * @cfg {Object} scope
\r
1612 * The scope (<tt><b>this</b></tt> reference) in which the <code>{@link #handler}</code>
\r
1613 * function will be called. Defaults to this ColorMenu instance.
\r
1617 * @cfg {Boolean} hideOnClick
\r
1618 * False to continue showing the menu after a color is selected, defaults to true.
\r
1620 hideOnClick : true,
\r
1622 cls : 'x-color-menu',
\r
1625 * @cfg {String} paletteId
\r
1626 * An id to assign to the underlying color palette. Defaults to <tt>null</tt>.
\r
1631 * @cfg {Number} maxHeight
\r
1635 * @cfg {Number} scrollIncrement
\r
1639 * @property palette
\r
1640 * @type ColorPalette
\r
1641 * The {@link Ext.ColorPalette} instance for this ColorMenu
\r
1651 * @event itemclick
\r
1655 initComponent : function(){
\r
1658 showSeparator: false,
\r
1659 items: this.palette = new Ext.ColorPalette(Ext.applyIf({
\r
1660 id: this.paletteId
\r
1661 }, this.initialConfig))
\r
1663 this.palette.purgeListeners();
\r
1664 Ext.menu.ColorMenu.superclass.initComponent.call(this);
\r
1667 * Fires when a color is selected from the {@link #palette Ext.ColorPalette}
\r
1668 * @param {Ext.ColorPalette} palette The {@link #palette Ext.ColorPalette}
\r
1669 * @param {String} color The 6-digit color hex code (without the # symbol)
\r
1671 this.relayEvents(this.palette, ['select']);
\r
1672 this.on('select', this.menuHide, this);
\r
1674 this.on('select', this.handler, this.scope || this);
\r
1678 menuHide : function(){
\r
1679 if(this.hideOnClick){
\r
1684 Ext.reg('colormenu', Ext.menu.ColorMenu);
\r