Upgrade to ExtJS 3.3.0 - Released 10/06/2010
[extjs.git] / pkgs / pkg-buttons-debug.js
1 /*!
2  * Ext JS Library 3.3.0
3  * Copyright(c) 2006-2010 Ext JS, Inc.
4  * licensing@extjs.com
5  * http://www.extjs.com/license
6  */
7 /**
8  * @class Ext.Button
9  * @extends Ext.BoxComponent
10  * Simple Button class
11  * @cfg {String} text The button text to be used as innerHTML (html tags are accepted)
12  * @cfg {String} icon The path to an image to display in the button (the image will be set as the background-image
13  * CSS property of the button by default, so if you want a mixed icon/text button, set cls:'x-btn-text-icon')
14  * @cfg {Function} handler A function called when the button is clicked (can be used instead of click event).
15  * The handler is passed the following parameters:<div class="mdetail-params"><ul>
16  * <li><code>b</code> : Button<div class="sub-desc">This Button.</div></li>
17  * <li><code>e</code> : EventObject<div class="sub-desc">The click event.</div></li>
18  * </ul></div>
19  * @cfg {Number} minWidth The minimum width for this button (used to give a set of buttons a common width).
20  * See also {@link Ext.Panel}.<tt>{@link Ext.Panel#minButtonWidth minButtonWidth}</tt>.
21  * @cfg {String/Object} tooltip The tooltip for the button - can be a string to be used as innerHTML (html tags are accepted) or QuickTips config object
22  * @cfg {Boolean} hidden True to start hidden (defaults to false)
23  * @cfg {Boolean} disabled True to start disabled (defaults to false)
24  * @cfg {Boolean} pressed True to start pressed (only if enableToggle = true)
25  * @cfg {String} toggleGroup The group this toggle button is a member of (only 1 per group can be pressed)
26  * @cfg {Boolean/Object} repeat True to repeat fire the click event while the mouse is down. This can also be
27  * a {@link Ext.util.ClickRepeater ClickRepeater} config object (defaults to false).
28  * @constructor
29  * Create a new button
30  * @param {Object} config The config object
31  * @xtype button
32  */
33 Ext.Button = Ext.extend(Ext.BoxComponent, {
34     /**
35      * Read-only. True if this button is hidden
36      * @type Boolean
37      */
38     hidden : false,
39     /**
40      * Read-only. True if this button is disabled
41      * @type Boolean
42      */
43     disabled : false,
44     /**
45      * Read-only. True if this button is pressed (only if enableToggle = true)
46      * @type Boolean
47      */
48     pressed : false,
49
50     /**
51      * @cfg {Number} tabIndex Set a DOM tabIndex for this button (defaults to undefined)
52      */
53
54     /**
55      * @cfg {Boolean} allowDepress
56      * False to not allow a pressed Button to be depressed (defaults to undefined). Only valid when {@link #enableToggle} is true.
57      */
58
59     /**
60      * @cfg {Boolean} enableToggle
61      * True to enable pressed/not pressed toggling (defaults to false)
62      */
63     enableToggle : false,
64     /**
65      * @cfg {Function} toggleHandler
66      * Function called when a Button with {@link #enableToggle} set to true is clicked. Two arguments are passed:<ul class="mdetail-params">
67      * <li><b>button</b> : Ext.Button<div class="sub-desc">this Button object</div></li>
68      * <li><b>state</b> : Boolean<div class="sub-desc">The next state of the Button, true means pressed.</div></li>
69      * </ul>
70      */
71     /**
72      * @cfg {Mixed} menu
73      * Standard menu attribute consisting of a reference to a menu object, a menu id or a menu config blob (defaults to undefined).
74      */
75     /**
76      * @cfg {String} menuAlign
77      * The position to align the menu to (see {@link Ext.Element#alignTo} for more details, defaults to 'tl-bl?').
78      */
79     menuAlign : 'tl-bl?',
80
81     /**
82      * @cfg {String} overflowText If used in a {@link Ext.Toolbar Toolbar}, the
83      * text to be used if this item is shown in the overflow menu. See also
84      * {@link Ext.Toolbar.Item}.<code>{@link Ext.Toolbar.Item#overflowText overflowText}</code>.
85      */
86     /**
87      * @cfg {String} iconCls
88      * A css class which sets a background image to be used as the icon for this button
89      */
90     /**
91      * @cfg {String} type
92      * submit, reset or button - defaults to 'button'
93      */
94     type : 'button',
95
96     // private
97     menuClassTarget : 'tr:nth(2)',
98
99     /**
100      * @cfg {String} clickEvent
101      * The DOM event that will fire the handler of the button. This can be any valid event name (dblclick, contextmenu).
102      * Defaults to <tt>'click'</tt>.
103      */
104     clickEvent : 'click',
105
106     /**
107      * @cfg {Boolean} handleMouseEvents
108      * False to disable visual cues on mouseover, mouseout and mousedown (defaults to true)
109      */
110     handleMouseEvents : true,
111
112     /**
113      * @cfg {String} tooltipType
114      * The type of tooltip to use. Either 'qtip' (default) for QuickTips or 'title' for title attribute.
115      */
116     tooltipType : 'qtip',
117
118     /**
119      * @cfg {String} buttonSelector
120      * <p>(Optional) A {@link Ext.DomQuery DomQuery} selector which is used to extract the active, clickable element from the
121      * DOM structure created.</p>
122      * <p>When a custom {@link #template} is used, you  must ensure that this selector results in the selection of
123      * a focussable element.</p>
124      * <p>Defaults to <b><tt>'button:first-child'</tt></b>.</p>
125      */
126     buttonSelector : 'button:first-child',
127
128     /**
129      * @cfg {String} scale
130      * <p>(Optional) The size of the Button. Three values are allowed:</p>
131      * <ul class="mdetail-params">
132      * <li>'small'<div class="sub-desc">Results in the button element being 16px high.</div></li>
133      * <li>'medium'<div class="sub-desc">Results in the button element being 24px high.</div></li>
134      * <li>'large'<div class="sub-desc">Results in the button element being 32px high.</div></li>
135      * </ul>
136      * <p>Defaults to <b><tt>'small'</tt></b>.</p>
137      */
138     scale : 'small',
139
140     /**
141      * @cfg {Object} scope The scope (<tt><b>this</b></tt> reference) in which the
142      * <code>{@link #handler}</code> and <code>{@link #toggleHandler}</code> is
143      * executed. Defaults to this Button.
144      */
145
146     /**
147      * @cfg {String} iconAlign
148      * <p>(Optional) The side of the Button box to render the icon. Four values are allowed:</p>
149      * <ul class="mdetail-params">
150      * <li>'top'<div class="sub-desc"></div></li>
151      * <li>'right'<div class="sub-desc"></div></li>
152      * <li>'bottom'<div class="sub-desc"></div></li>
153      * <li>'left'<div class="sub-desc"></div></li>
154      * </ul>
155      * <p>Defaults to <b><tt>'left'</tt></b>.</p>
156      */
157     iconAlign : 'left',
158
159     /**
160      * @cfg {String} arrowAlign
161      * <p>(Optional) The side of the Button box to render the arrow if the button has an associated {@link #menu}.
162      * Two values are allowed:</p>
163      * <ul class="mdetail-params">
164      * <li>'right'<div class="sub-desc"></div></li>
165      * <li>'bottom'<div class="sub-desc"></div></li>
166      * </ul>
167      * <p>Defaults to <b><tt>'right'</tt></b>.</p>
168      */
169     arrowAlign : 'right',
170
171     /**
172      * @cfg {Ext.Template} template (Optional)
173      * <p>A {@link Ext.Template Template} used to create the Button's DOM structure.</p>
174      * Instances, or subclasses which need a different DOM structure may provide a different
175      * template layout in conjunction with an implementation of {@link #getTemplateArgs}.
176      * @type Ext.Template
177      * @property template
178      */
179     /**
180      * @cfg {String} cls
181      * A CSS class string to apply to the button's main element.
182      */
183     /**
184      * @property menu
185      * @type Menu
186      * The {@link Ext.menu.Menu Menu} object associated with this Button when configured with the {@link #menu} config option.
187      */
188     /**
189      * @cfg {Boolean} autoWidth
190      * By default, if a width is not specified the button will attempt to stretch horizontally to fit its content.
191      * If the button is being managed by a width sizing layout (hbox, fit, anchor), set this to false to prevent
192      * the button from doing this automatic sizing.
193      * Defaults to <tt>undefined</tt>.
194      */
195
196     initComponent : function(){
197         Ext.Button.superclass.initComponent.call(this);
198
199         this.addEvents(
200             /**
201              * @event click
202              * Fires when this button is clicked
203              * @param {Button} this
204              * @param {EventObject} e The click event
205              */
206             'click',
207             /**
208              * @event toggle
209              * Fires when the 'pressed' state of this button changes (only if enableToggle = true)
210              * @param {Button} this
211              * @param {Boolean} pressed
212              */
213             'toggle',
214             /**
215              * @event mouseover
216              * Fires when the mouse hovers over the button
217              * @param {Button} this
218              * @param {Event} e The event object
219              */
220             'mouseover',
221             /**
222              * @event mouseout
223              * Fires when the mouse exits the button
224              * @param {Button} this
225              * @param {Event} e The event object
226              */
227             'mouseout',
228             /**
229              * @event menushow
230              * If this button has a menu, this event fires when it is shown
231              * @param {Button} this
232              * @param {Menu} menu
233              */
234             'menushow',
235             /**
236              * @event menuhide
237              * If this button has a menu, this event fires when it is hidden
238              * @param {Button} this
239              * @param {Menu} menu
240              */
241             'menuhide',
242             /**
243              * @event menutriggerover
244              * If this button has a menu, this event fires when the mouse enters the menu triggering element
245              * @param {Button} this
246              * @param {Menu} menu
247              * @param {EventObject} e
248              */
249             'menutriggerover',
250             /**
251              * @event menutriggerout
252              * If this button has a menu, this event fires when the mouse leaves the menu triggering element
253              * @param {Button} this
254              * @param {Menu} menu
255              * @param {EventObject} e
256              */
257             'menutriggerout'
258         );
259         if(this.menu){
260             this.menu = Ext.menu.MenuMgr.get(this.menu);
261         }
262         if(Ext.isString(this.toggleGroup)){
263             this.enableToggle = true;
264         }
265     },
266
267 /**
268   * <p>This method returns an Array which provides substitution parameters for the {@link #template Template} used
269   * to create this Button's DOM structure.</p>
270   * <p>Instances or subclasses which use a different Template to create a different DOM structure may need to provide their
271   * own implementation of this method.</p>
272   * <p>The default implementation which provides data for the default {@link #template} returns an Array containing the
273   * following items:</p><div class="mdetail-params"><ul>
274   * <li>The &lt;button&gt;'s {@link #type}</li>
275   * <li>A CSS class name applied to the Button's main &lt;tbody&gt; element which determines the button's scale and icon alignment.</li>
276   * <li>A CSS class to determine the presence and position of an arrow icon. (<code>'x-btn-arrow'</code> or <code>'x-btn-arrow-bottom'</code> or <code>''</code>)</li>
277   * <li>The {@link #cls} CSS class name applied to the button's wrapping &lt;table&gt; element.</li>
278   * <li>The Component id which is applied to the button's wrapping &lt;table&gt; element.</li>
279   * </ul></div>
280   * @return {Array} Substitution data for a Template.
281  */
282     getTemplateArgs : function(){
283         return [this.type, 'x-btn-' + this.scale + ' x-btn-icon-' + this.scale + '-' + this.iconAlign, this.getMenuClass(), this.cls, this.id];
284     },
285
286     // private
287     setButtonClass : function(){
288         if(this.useSetClass){
289             if(!Ext.isEmpty(this.oldCls)){
290                 this.el.removeClass([this.oldCls, 'x-btn-pressed']);
291             }
292             this.oldCls = (this.iconCls || this.icon) ? (this.text ? 'x-btn-text-icon' : 'x-btn-icon') : 'x-btn-noicon';
293             this.el.addClass([this.oldCls, this.pressed ? 'x-btn-pressed' : null]);
294         }
295     },
296
297     // protected
298     getMenuClass : function(){
299         return this.menu ? (this.arrowAlign != 'bottom' ? 'x-btn-arrow' : 'x-btn-arrow-bottom') : '';
300     },
301
302     // private
303     onRender : function(ct, position){
304         if(!this.template){
305             if(!Ext.Button.buttonTemplate){
306                 // hideous table template
307                 Ext.Button.buttonTemplate = new Ext.Template(
308                     '<table id="{4}" cellspacing="0" class="x-btn {3}"><tbody class="{1}">',
309                     '<tr><td class="x-btn-tl"><i>&#160;</i></td><td class="x-btn-tc"></td><td class="x-btn-tr"><i>&#160;</i></td></tr>',
310                     '<tr><td class="x-btn-ml"><i>&#160;</i></td><td class="x-btn-mc"><em class="{2}" unselectable="on"><button type="{0}"></button></em></td><td class="x-btn-mr"><i>&#160;</i></td></tr>',
311                     '<tr><td class="x-btn-bl"><i>&#160;</i></td><td class="x-btn-bc"></td><td class="x-btn-br"><i>&#160;</i></td></tr>',
312                     '</tbody></table>');
313                 Ext.Button.buttonTemplate.compile();
314             }
315             this.template = Ext.Button.buttonTemplate;
316         }
317
318         var btn, targs = this.getTemplateArgs();
319
320         if(position){
321             btn = this.template.insertBefore(position, targs, true);
322         }else{
323             btn = this.template.append(ct, targs, true);
324         }
325         /**
326          * An {@link Ext.Element Element} encapsulating the Button's clickable element. By default,
327          * this references a <tt>&lt;button&gt;</tt> element. Read only.
328          * @type Ext.Element
329          * @property btnEl
330          */
331         this.btnEl = btn.child(this.buttonSelector);
332         this.mon(this.btnEl, {
333             scope: this,
334             focus: this.onFocus,
335             blur: this.onBlur
336         });
337
338         this.initButtonEl(btn, this.btnEl);
339
340         Ext.ButtonToggleMgr.register(this);
341     },
342
343     // private
344     initButtonEl : function(btn, btnEl){
345         this.el = btn;
346         this.setIcon(this.icon);
347         this.setText(this.text);
348         this.setIconClass(this.iconCls);
349         if(Ext.isDefined(this.tabIndex)){
350             btnEl.dom.tabIndex = this.tabIndex;
351         }
352         if(this.tooltip){
353             this.setTooltip(this.tooltip, true);
354         }
355
356         if(this.handleMouseEvents){
357             this.mon(btn, {
358                 scope: this,
359                 mouseover: this.onMouseOver,
360                 mousedown: this.onMouseDown
361             });
362
363             // new functionality for monitoring on the document level
364             //this.mon(btn, 'mouseout', this.onMouseOut, this);
365         }
366
367         if(this.menu){
368             this.mon(this.menu, {
369                 scope: this,
370                 show: this.onMenuShow,
371                 hide: this.onMenuHide
372             });
373         }
374
375         if(this.repeat){
376             var repeater = new Ext.util.ClickRepeater(btn, Ext.isObject(this.repeat) ? this.repeat : {});
377             this.mon(repeater, 'click', this.onRepeatClick, this);
378         }else{
379             this.mon(btn, this.clickEvent, this.onClick, this);
380         }
381     },
382
383     // private
384     afterRender : function(){
385         Ext.Button.superclass.afterRender.call(this);
386         this.useSetClass = true;
387         this.setButtonClass();
388         this.doc = Ext.getDoc();
389         this.doAutoWidth();
390     },
391
392     /**
393      * Sets the CSS class that provides a background image to use as the button's icon.  This method also changes
394      * the value of the {@link iconCls} config internally.
395      * @param {String} cls The CSS class providing the icon image
396      * @return {Ext.Button} this
397      */
398     setIconClass : function(cls){
399         this.iconCls = cls;
400         if(this.el){
401             this.btnEl.dom.className = '';
402             this.btnEl.addClass(['x-btn-text', cls || '']);
403             this.setButtonClass();
404         }
405         return this;
406     },
407
408     /**
409      * Sets the tooltip for this Button.
410      * @param {String/Object} tooltip. This may be:<div class="mdesc-details"><ul>
411      * <li><b>String</b> : A string to be used as innerHTML (html tags are accepted) to show in a tooltip</li>
412      * <li><b>Object</b> : A configuration object for {@link Ext.QuickTips#register}.</li>
413      * </ul></div>
414      * @return {Ext.Button} this
415      */
416     setTooltip : function(tooltip, /* private */ initial){
417         if(this.rendered){
418             if(!initial){
419                 this.clearTip();
420             }
421             if(Ext.isObject(tooltip)){
422                 Ext.QuickTips.register(Ext.apply({
423                       target: this.btnEl.id
424                 }, tooltip));
425                 this.tooltip = tooltip;
426             }else{
427                 this.btnEl.dom[this.tooltipType] = tooltip;
428             }
429         }else{
430             this.tooltip = tooltip;
431         }
432         return this;
433     },
434
435     // private
436     clearTip : function(){
437         if(Ext.isObject(this.tooltip)){
438             Ext.QuickTips.unregister(this.btnEl);
439         }
440     },
441
442     // private
443     beforeDestroy : function(){
444         if(this.rendered){
445             this.clearTip();
446         }
447         if(this.menu && this.destroyMenu !== false) {
448             Ext.destroy(this.btnEl, this.menu);
449         }
450         Ext.destroy(this.repeater);
451     },
452
453     // private
454     onDestroy : function(){
455         if(this.rendered){
456             this.doc.un('mouseover', this.monitorMouseOver, this);
457             this.doc.un('mouseup', this.onMouseUp, this);
458             delete this.doc;
459             delete this.btnEl;
460             Ext.ButtonToggleMgr.unregister(this);
461         }
462         Ext.Button.superclass.onDestroy.call(this);
463     },
464
465     // private
466     doAutoWidth : function(){
467         if(this.autoWidth !== false && this.el && this.text && this.width === undefined){
468             this.el.setWidth('auto');
469             if(Ext.isIE7 && Ext.isStrict){
470                 var ib = this.btnEl;
471                 if(ib && ib.getWidth() > 20){
472                     ib.clip();
473                     ib.setWidth(Ext.util.TextMetrics.measure(ib, this.text).width+ib.getFrameWidth('lr'));
474                 }
475             }
476             if(this.minWidth){
477                 if(this.el.getWidth() < this.minWidth){
478                     this.el.setWidth(this.minWidth);
479                 }
480             }
481         }
482     },
483
484     /**
485      * Assigns this Button's click handler
486      * @param {Function} handler The function to call when the button is clicked
487      * @param {Object} scope (optional) The scope (<code>this</code> reference) in which the handler function is executed.
488      * Defaults to this Button.
489      * @return {Ext.Button} this
490      */
491     setHandler : function(handler, scope){
492         this.handler = handler;
493         this.scope = scope;
494         return this;
495     },
496
497     /**
498      * Sets this Button's text
499      * @param {String} text The button text
500      * @return {Ext.Button} this
501      */
502     setText : function(text){
503         this.text = text;
504         if(this.el){
505             this.btnEl.update(text || '&#160;');
506             this.setButtonClass();
507         }
508         this.doAutoWidth();
509         return this;
510     },
511
512     /**
513      * Sets the background image (inline style) of the button.  This method also changes
514      * the value of the {@link icon} config internally.
515      * @param {String} icon The path to an image to display in the button
516      * @return {Ext.Button} this
517      */
518     setIcon : function(icon){
519         this.icon = icon;
520         if(this.el){
521             this.btnEl.setStyle('background-image', icon ? 'url(' + icon + ')' : '');
522             this.setButtonClass();
523         }
524         return this;
525     },
526
527     /**
528      * Gets the text for this Button
529      * @return {String} The button text
530      */
531     getText : function(){
532         return this.text;
533     },
534
535     /**
536      * If a state it passed, it becomes the pressed state otherwise the current state is toggled.
537      * @param {Boolean} state (optional) Force a particular state
538      * @param {Boolean} supressEvent (optional) True to stop events being fired when calling this method.
539      * @return {Ext.Button} this
540      */
541     toggle : function(state, suppressEvent){
542         state = state === undefined ? !this.pressed : !!state;
543         if(state != this.pressed){
544             if(this.rendered){
545                 this.el[state ? 'addClass' : 'removeClass']('x-btn-pressed');
546             }
547             this.pressed = state;
548             if(!suppressEvent){
549                 this.fireEvent('toggle', this, state);
550                 if(this.toggleHandler){
551                     this.toggleHandler.call(this.scope || this, this, state);
552                 }
553             }
554         }
555         return this;
556     },
557
558     // private
559     onDisable : function(){
560         this.onDisableChange(true);
561     },
562
563     // private
564     onEnable : function(){
565         this.onDisableChange(false);
566     },
567
568     onDisableChange : function(disabled){
569         if(this.el){
570             if(!Ext.isIE6 || !this.text){
571                 this.el[disabled ? 'addClass' : 'removeClass'](this.disabledClass);
572             }
573             this.el.dom.disabled = disabled;
574         }
575         this.disabled = disabled;
576     },
577
578     /**
579      * Show this button's menu (if it has one)
580      */
581     showMenu : function(){
582         if(this.rendered && this.menu){
583             if(this.tooltip){
584                 Ext.QuickTips.getQuickTip().cancelShow(this.btnEl);
585             }
586             if(this.menu.isVisible()){
587                 this.menu.hide();
588             }
589             this.menu.ownerCt = this;
590             this.menu.show(this.el, this.menuAlign);
591         }
592         return this;
593     },
594
595     /**
596      * Hide this button's menu (if it has one)
597      */
598     hideMenu : function(){
599         if(this.hasVisibleMenu()){
600             this.menu.hide();
601         }
602         return this;
603     },
604
605     /**
606      * Returns true if the button has a menu and it is visible
607      * @return {Boolean}
608      */
609     hasVisibleMenu : function(){
610         return this.menu && this.menu.ownerCt == this && this.menu.isVisible();
611     },
612     
613     // private
614     onRepeatClick : function(repeat, e){
615         this.onClick(e);
616     },
617
618     // private
619     onClick : function(e){
620         if(e){
621             e.preventDefault();
622         }
623         if(e.button !== 0){
624             return;
625         }
626         if(!this.disabled){
627             this.doToggle();
628             if(this.menu && !this.hasVisibleMenu() && !this.ignoreNextClick){
629                 this.showMenu();
630             }
631             this.fireEvent('click', this, e);
632             if(this.handler){
633                 //this.el.removeClass('x-btn-over');
634                 this.handler.call(this.scope || this, this, e);
635             }
636         }
637     },
638     
639     // private
640     doToggle: function(){
641         if (this.enableToggle && (this.allowDepress !== false || !this.pressed)) {
642             this.toggle();
643         }
644     },
645
646     // private
647     isMenuTriggerOver : function(e, internal){
648         return this.menu && !internal;
649     },
650
651     // private
652     isMenuTriggerOut : function(e, internal){
653         return this.menu && !internal;
654     },
655
656     // private
657     onMouseOver : function(e){
658         if(!this.disabled){
659             var internal = e.within(this.el,  true);
660             if(!internal){
661                 this.el.addClass('x-btn-over');
662                 if(!this.monitoringMouseOver){
663                     this.doc.on('mouseover', this.monitorMouseOver, this);
664                     this.monitoringMouseOver = true;
665                 }
666                 this.fireEvent('mouseover', this, e);
667             }
668             if(this.isMenuTriggerOver(e, internal)){
669                 this.fireEvent('menutriggerover', this, this.menu, e);
670             }
671         }
672     },
673
674     // private
675     monitorMouseOver : function(e){
676         if(e.target != this.el.dom && !e.within(this.el)){
677             if(this.monitoringMouseOver){
678                 this.doc.un('mouseover', this.monitorMouseOver, this);
679                 this.monitoringMouseOver = false;
680             }
681             this.onMouseOut(e);
682         }
683     },
684
685     // private
686     onMouseOut : function(e){
687         var internal = e.within(this.el) && e.target != this.el.dom;
688         this.el.removeClass('x-btn-over');
689         this.fireEvent('mouseout', this, e);
690         if(this.isMenuTriggerOut(e, internal)){
691             this.fireEvent('menutriggerout', this, this.menu, e);
692         }
693     },
694
695     focus : function() {
696         this.btnEl.focus();
697     },
698
699     blur : function() {
700         this.btnEl.blur();
701     },
702
703     // private
704     onFocus : function(e){
705         if(!this.disabled){
706             this.el.addClass('x-btn-focus');
707         }
708     },
709     // private
710     onBlur : function(e){
711         this.el.removeClass('x-btn-focus');
712     },
713
714     // private
715     getClickEl : function(e, isUp){
716        return this.el;
717     },
718
719     // private
720     onMouseDown : function(e){
721         if(!this.disabled && e.button === 0){
722             this.getClickEl(e).addClass('x-btn-click');
723             this.doc.on('mouseup', this.onMouseUp, this);
724         }
725     },
726     // private
727     onMouseUp : function(e){
728         if(e.button === 0){
729             this.getClickEl(e, true).removeClass('x-btn-click');
730             this.doc.un('mouseup', this.onMouseUp, this);
731         }
732     },
733     // private
734     onMenuShow : function(e){
735         if(this.menu.ownerCt == this){
736             this.menu.ownerCt = this;
737             this.ignoreNextClick = 0;
738             this.el.addClass('x-btn-menu-active');
739             this.fireEvent('menushow', this, this.menu);
740         }
741     },
742     // private
743     onMenuHide : function(e){
744         if(this.menu.ownerCt == this){
745             this.el.removeClass('x-btn-menu-active');
746             this.ignoreNextClick = this.restoreClick.defer(250, this);
747             this.fireEvent('menuhide', this, this.menu);
748             delete this.menu.ownerCt;
749         }
750     },
751
752     // private
753     restoreClick : function(){
754         this.ignoreNextClick = 0;
755     }
756
757     /**
758      * @cfg {String} autoEl @hide
759      */
760     /**
761      * @cfg {String/Object} html @hide
762      */
763     /**
764      * @cfg {String} contentEl  @hide
765      */
766     /**
767      * @cfg {Mixed} data  @hide
768      */
769     /**
770      * @cfg {Mixed} tpl  @hide
771      */
772     /**
773      * @cfg {String} tplWriteMode  @hide
774      */
775 });
776 Ext.reg('button', Ext.Button);
777
778 // Private utility class used by Button
779 Ext.ButtonToggleMgr = function(){
780    var groups = {};
781
782    function toggleGroup(btn, state){
783        if(state){
784            var g = groups[btn.toggleGroup];
785            for(var i = 0, l = g.length; i < l; i++){
786                if(g[i] != btn){
787                    g[i].toggle(false);
788                }
789            }
790        }
791    }
792
793    return {
794        register : function(btn){
795            if(!btn.toggleGroup){
796                return;
797            }
798            var g = groups[btn.toggleGroup];
799            if(!g){
800                g = groups[btn.toggleGroup] = [];
801            }
802            g.push(btn);
803            btn.on('toggle', toggleGroup);
804        },
805
806        unregister : function(btn){
807            if(!btn.toggleGroup){
808                return;
809            }
810            var g = groups[btn.toggleGroup];
811            if(g){
812                g.remove(btn);
813                btn.un('toggle', toggleGroup);
814            }
815        },
816
817        /**
818         * Gets the pressed button in the passed group or null
819         * @param {String} group
820         * @return Button
821         */
822        getPressed : function(group){
823            var g = groups[group];
824            if(g){
825                for(var i = 0, len = g.length; i < len; i++){
826                    if(g[i].pressed === true){
827                        return g[i];
828                    }
829                }
830            }
831            return null;
832        }
833    };
834 }();
835 /**
836  * @class Ext.SplitButton
837  * @extends Ext.Button
838  * A split button that provides a built-in dropdown arrow that can fire an event separately from the default
839  * click event of the button.  Typically this would be used to display a dropdown menu that provides additional
840  * options to the primary button action, but any custom handler can provide the arrowclick implementation.  Example usage:
841  * <pre><code>
842 // display a dropdown menu:
843 new Ext.SplitButton({
844         renderTo: 'button-ct', // the container id
845         text: 'Options',
846         handler: optionsHandler, // handle a click on the button itself
847         menu: new Ext.menu.Menu({
848         items: [
849                 // these items will render as dropdown menu items when the arrow is clicked:
850                 {text: 'Item 1', handler: item1Handler},
851                 {text: 'Item 2', handler: item2Handler}
852         ]
853         })
854 });
855
856 // Instead of showing a menu, you provide any type of custom
857 // functionality you want when the dropdown arrow is clicked:
858 new Ext.SplitButton({
859         renderTo: 'button-ct',
860         text: 'Options',
861         handler: optionsHandler,
862         arrowHandler: myCustomHandler
863 });
864 </code></pre>
865  * @cfg {Function} arrowHandler A function called when the arrow button is clicked (can be used instead of click event)
866  * @cfg {String} arrowTooltip The title attribute of the arrow
867  * @constructor
868  * Create a new menu button
869  * @param {Object} config The config object
870  * @xtype splitbutton
871  */
872 Ext.SplitButton = Ext.extend(Ext.Button, {
873         // private
874     arrowSelector : 'em',
875     split: true,
876
877     // private
878     initComponent : function(){
879         Ext.SplitButton.superclass.initComponent.call(this);
880         /**
881          * @event arrowclick
882          * Fires when this button's arrow is clicked
883          * @param {MenuButton} this
884          * @param {EventObject} e The click event
885          */
886         this.addEvents("arrowclick");
887     },
888
889     // private
890     onRender : function(){
891         Ext.SplitButton.superclass.onRender.apply(this, arguments);
892         if(this.arrowTooltip){
893             this.el.child(this.arrowSelector).dom[this.tooltipType] = this.arrowTooltip;
894         }
895     },
896
897     /**
898      * Sets this button's arrow click handler.
899      * @param {Function} handler The function to call when the arrow is clicked
900      * @param {Object} scope (optional) Scope for the function passed above
901      */
902     setArrowHandler : function(handler, scope){
903         this.arrowHandler = handler;
904         this.scope = scope;
905     },
906
907     getMenuClass : function(){
908         return 'x-btn-split' + (this.arrowAlign == 'bottom' ? '-bottom' : '');
909     },
910
911     isClickOnArrow : function(e){
912         if (this.arrowAlign != 'bottom') {
913             var visBtn = this.el.child('em.x-btn-split');
914             var right = visBtn.getRegion().right - visBtn.getPadding('r');
915             return e.getPageX() > right;
916         } else {
917             return e.getPageY() > this.btnEl.getRegion().bottom;
918         }
919     },
920
921     // private
922     onClick : function(e, t){
923         e.preventDefault();
924         if(!this.disabled){
925             if(this.isClickOnArrow(e)){
926                 if(this.menu && !this.menu.isVisible() && !this.ignoreNextClick){
927                     this.showMenu();
928                 }
929                 this.fireEvent("arrowclick", this, e);
930                 if(this.arrowHandler){
931                     this.arrowHandler.call(this.scope || this, this, e);
932                 }
933             }else{
934                 this.doToggle();
935                 this.fireEvent("click", this, e);
936                 if(this.handler){
937                     this.handler.call(this.scope || this, this, e);
938                 }
939             }
940         }
941     },
942
943     // private
944     isMenuTriggerOver : function(e){
945         return this.menu && e.target.tagName == this.arrowSelector;
946     },
947
948     // private
949     isMenuTriggerOut : function(e, internal){
950         return this.menu && e.target.tagName != this.arrowSelector;
951     }
952 });
953
954 Ext.reg('splitbutton', Ext.SplitButton);/**
955  * @class Ext.CycleButton
956  * @extends Ext.SplitButton
957  * A specialized SplitButton that contains a menu of {@link Ext.menu.CheckItem} elements.  The button automatically
958  * cycles through each menu item on click, raising the button's {@link #change} event (or calling the button's
959  * {@link #changeHandler} function, if supplied) for the active menu item. Clicking on the arrow section of the
960  * button displays the dropdown menu just like a normal SplitButton.  Example usage:
961  * <pre><code>
962 var btn = new Ext.CycleButton({
963     showText: true,
964     prependText: 'View as ',
965     items: [{
966         text:'text only',
967         iconCls:'view-text',
968         checked:true
969     },{
970         text:'HTML',
971         iconCls:'view-html'
972     }],
973     changeHandler:function(btn, item){
974         Ext.Msg.alert('Change View', item.text);
975     }
976 });
977 </code></pre>
978  * @constructor
979  * Create a new split button
980  * @param {Object} config The config object
981  * @xtype cycle
982  */
983 Ext.CycleButton = Ext.extend(Ext.SplitButton, {
984     /**
985      * @cfg {Array} items An array of {@link Ext.menu.CheckItem} <b>config</b> objects to be used when creating the
986      * button's menu items (e.g., {text:'Foo', iconCls:'foo-icon'})
987      */
988     /**
989      * @cfg {Boolean} showText True to display the active item's text as the button text (defaults to false)
990      */
991     /**
992      * @cfg {String} prependText A static string to prepend before the active item's text when displayed as the
993      * button's text (only applies when showText = true, defaults to '')
994      */
995     /**
996      * @cfg {Function} changeHandler A callback function that will be invoked each time the active menu
997      * item in the button's menu has changed.  If this callback is not supplied, the SplitButton will instead
998      * fire the {@link #change} event on active item change.  The changeHandler function will be called with the
999      * following argument list: (SplitButton this, Ext.menu.CheckItem item)
1000      */
1001     /**
1002      * @cfg {String} forceIcon A css class which sets an image to be used as the static icon for this button.  This
1003      * icon will always be displayed regardless of which item is selected in the dropdown list.  This overrides the 
1004      * default behavior of changing the button's icon to match the selected item's icon on change.
1005      */
1006     /**
1007      * @property menu
1008      * @type Menu
1009      * The {@link Ext.menu.Menu Menu} object used to display the {@link Ext.menu.CheckItem CheckItems} representing the available choices.
1010      */
1011
1012     // private
1013     getItemText : function(item){
1014         if(item && this.showText === true){
1015             var text = '';
1016             if(this.prependText){
1017                 text += this.prependText;
1018             }
1019             text += item.text;
1020             return text;
1021         }
1022         return undefined;
1023     },
1024
1025     /**
1026      * Sets the button's active menu item.
1027      * @param {Ext.menu.CheckItem} item The item to activate
1028      * @param {Boolean} suppressEvent True to prevent the button's change event from firing (defaults to false)
1029      */
1030     setActiveItem : function(item, suppressEvent){
1031         if(!Ext.isObject(item)){
1032             item = this.menu.getComponent(item);
1033         }
1034         if(item){
1035             if(!this.rendered){
1036                 this.text = this.getItemText(item);
1037                 this.iconCls = item.iconCls;
1038             }else{
1039                 var t = this.getItemText(item);
1040                 if(t){
1041                     this.setText(t);
1042                 }
1043                 this.setIconClass(item.iconCls);
1044             }
1045             this.activeItem = item;
1046             if(!item.checked){
1047                 item.setChecked(true, false);
1048             }
1049             if(this.forceIcon){
1050                 this.setIconClass(this.forceIcon);
1051             }
1052             if(!suppressEvent){
1053                 this.fireEvent('change', this, item);
1054             }
1055         }
1056     },
1057
1058     /**
1059      * Gets the currently active menu item.
1060      * @return {Ext.menu.CheckItem} The active item
1061      */
1062     getActiveItem : function(){
1063         return this.activeItem;
1064     },
1065
1066     // private
1067     initComponent : function(){
1068         this.addEvents(
1069             /**
1070              * @event change
1071              * Fires after the button's active menu item has changed.  Note that if a {@link #changeHandler} function
1072              * is set on this CycleButton, it will be called instead on active item change and this change event will
1073              * not be fired.
1074              * @param {Ext.CycleButton} this
1075              * @param {Ext.menu.CheckItem} item The menu item that was selected
1076              */
1077             "change"
1078         );
1079
1080         if(this.changeHandler){
1081             this.on('change', this.changeHandler, this.scope||this);
1082             delete this.changeHandler;
1083         }
1084
1085         this.itemCount = this.items.length;
1086
1087         this.menu = {cls:'x-cycle-menu', items:[]};
1088         var checked = 0;
1089         Ext.each(this.items, function(item, i){
1090             Ext.apply(item, {
1091                 group: item.group || this.id,
1092                 itemIndex: i,
1093                 checkHandler: this.checkHandler,
1094                 scope: this,
1095                 checked: item.checked || false
1096             });
1097             this.menu.items.push(item);
1098             if(item.checked){
1099                 checked = i;
1100             }
1101         }, this);
1102         Ext.CycleButton.superclass.initComponent.call(this);
1103         this.on('click', this.toggleSelected, this);
1104         this.setActiveItem(checked, true);
1105     },
1106
1107     // private
1108     checkHandler : function(item, pressed){
1109         if(pressed){
1110             this.setActiveItem(item);
1111         }
1112     },
1113
1114     /**
1115      * This is normally called internally on button click, but can be called externally to advance the button's
1116      * active item programmatically to the next one in the menu.  If the current item is the last one in the menu
1117      * the active item will be set to the first item in the menu.
1118      */
1119     toggleSelected : function(){
1120         var m = this.menu;
1121         m.render();
1122         // layout if we haven't before so the items are active
1123         if(!m.hasLayout){
1124             m.doLayout();
1125         }
1126         
1127         var nextIdx, checkItem;
1128         for (var i = 1; i < this.itemCount; i++) {
1129             nextIdx = (this.activeItem.itemIndex + i) % this.itemCount;
1130             // check the potential item
1131             checkItem = m.items.itemAt(nextIdx);
1132             // if its not disabled then check it.
1133             if (!checkItem.disabled) {
1134                 checkItem.setChecked(true);
1135                 break;
1136             }
1137         }
1138     }
1139 });
1140 Ext.reg('cycle', Ext.CycleButton);