3 * Copyright(c) 2006-2009 Ext JS, LLC
5 * http://www.extjs.com/license
9 * @extends Ext.BoxComponent
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>
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).
30 * @param {Object} config The config object
33 Ext.Button = Ext.extend(Ext.BoxComponent, {
35 * Read-only. True if this button is hidden
40 * Read-only. True if this button is disabled
45 * Read-only. True if this button is pressed (only if enableToggle = true)
51 * @cfg {Number} tabIndex Set a DOM tabIndex for this button (defaults to undefined)
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.
60 * @cfg {Boolean} enableToggle
61 * True to enable pressed/not pressed toggling (defaults to false)
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 if the Button, true means pressed.</div></li>
73 * Standard menu attribute consisting of a reference to a menu object, a menu id or a menu config blob (defaults to undefined).
76 * @cfg {String} menuAlign
77 * The position to align the menu to (see {@link Ext.Element#alignTo} for more details, defaults to 'tl-bl?').
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>.
87 * @cfg {String} iconCls
88 * A css class which sets a background image to be used as the icon for this button
92 * submit, reset or button - defaults to 'button'
97 menuClassTarget : 'tr:nth(2)',
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>.
104 clickEvent : 'click',
107 * @cfg {Boolean} handleMouseEvents
108 * False to disable visual cues on mouseover, mouseout and mousedown (defaults to true)
110 handleMouseEvents : true,
113 * @cfg {String} tooltipType
114 * The type of tooltip to use. Either 'qtip' (default) for QuickTips or 'title' for title attribute.
116 tooltipType : 'qtip',
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>
126 buttonSelector : 'button:first-child',
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>
136 * <p>Defaults to <b><tt>'small'</tt></b>.</p>
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.
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>
155 * <p>Defaults to <b><tt>'left'</tt></b>.</p>
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>
167 * <p>Defaults to <b><tt>'right'</tt></b>.</p>
169 arrowAlign : 'right',
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}.
181 * A CSS class string to apply to the button's main element.
186 * The {@link Ext.menu.Menu Menu} object associated with this Button when configured with the {@link #menu} config option.
189 initComponent : function(){
190 Ext.Button.superclass.initComponent.call(this);
195 * Fires when this button is clicked
196 * @param {Button} this
197 * @param {EventObject} e The click event
202 * Fires when the 'pressed' state of this button changes (only if enableToggle = true)
203 * @param {Button} this
204 * @param {Boolean} pressed
209 * Fires when the mouse hovers over the button
210 * @param {Button} this
211 * @param {Event} e The event object
216 * Fires when the mouse exits the button
217 * @param {Button} this
218 * @param {Event} e The event object
223 * If this button has a menu, this event fires when it is shown
224 * @param {Button} this
230 * If this button has a menu, this event fires when it is hidden
231 * @param {Button} this
236 * @event menutriggerover
237 * If this button has a menu, this event fires when the mouse enters the menu triggering element
238 * @param {Button} this
240 * @param {EventObject} e
244 * @event menutriggerout
245 * If this button has a menu, this event fires when the mouse leaves the menu triggering element
246 * @param {Button} this
248 * @param {EventObject} e
253 this.menu = Ext.menu.MenuMgr.get(this.menu);
255 if(Ext.isString(this.toggleGroup)){
256 this.enableToggle = true;
261 * <p>This method returns an object which provides substitution parameters for the {@link #template Template} used
262 * to create this Button's DOM structure.</p>
263 * <p>Instances or subclasses which use a different Template to create a different DOM structure may need to provide their
264 * own implementation of this method.</p>
265 * <p>The default implementation which provides data for the default {@link #template} returns an Array containing the
266 * following items:</p><div class="mdetail-params"><ul>
267 * <li>The Button's {@link #text}</li>
268 * <li>The <button>'s {@link #type}</li>
269 * <li>The {@link iconCls} applied to the <button> {@link #btnEl element}</li>
270 * <li>The {@link #cls} applied to the Button's main {@link #getEl Element}</li>
271 * <li>A CSS class name controlling the Button's {@link #scale} and {@link #iconAlign icon alignment}</li>
272 * <li>A CSS class name which applies an arrow to the Button if configured with a {@link #menu}</li>
274 * @return {Object} Substitution data for a Template.
276 getTemplateArgs : function(){
277 var cls = (this.cls || '');
278 cls += (this.iconCls || this.icon) ? (this.text ? ' x-btn-text-icon' : ' x-btn-icon') : ' x-btn-noicon';
280 cls += ' x-btn-pressed';
282 return [this.text || ' ', this.type, this.iconCls || '', cls, 'x-btn-' + this.scale + ' x-btn-icon-' + this.scale + '-' + this.iconAlign, this.getMenuClass()];
286 getMenuClass : function(){
287 return this.menu ? (this.arrowAlign != 'bottom' ? 'x-btn-arrow' : 'x-btn-arrow-bottom') : '';
291 onRender : function(ct, position){
293 if(!Ext.Button.buttonTemplate){
294 // hideous table template
295 Ext.Button.buttonTemplate = new Ext.Template(
296 '<table cellspacing="0" class="x-btn {3}"><tbody class="{4}">',
297 '<tr><td class="x-btn-tl"><i> </i></td><td class="x-btn-tc"></td><td class="x-btn-tr"><i> </i></td></tr>',
298 '<tr><td class="x-btn-ml"><i> </i></td><td class="x-btn-mc"><em class="{5}" unselectable="on"><button class="x-btn-text {2}" type="{1}">{0}</button></em></td><td class="x-btn-mr"><i> </i></td></tr>',
299 '<tr><td class="x-btn-bl"><i> </i></td><td class="x-btn-bc"></td><td class="x-btn-br"><i> </i></td></tr>',
301 Ext.Button.buttonTemplate.compile();
303 this.template = Ext.Button.buttonTemplate;
306 var btn, targs = this.getTemplateArgs();
309 btn = this.template.insertBefore(position, targs, true);
311 btn = this.template.append(ct, targs, true);
314 * An {@link Ext.Element Element} encapsulating the Button's clickable element. By default,
315 * this references a <tt><button></tt> element. Read only.
319 this.btnEl = btn.child(this.buttonSelector);
320 this.mon(this.btnEl, {
326 this.initButtonEl(btn, this.btnEl);
328 Ext.ButtonToggleMgr.register(this);
332 initButtonEl : function(btn, btnEl){
337 c = Ext.Element.cache;
340 d.id = this.el.id = this.id;
344 btnEl.setStyle('background-image', 'url(' +this.icon +')');
346 if(this.tabIndex !== undefined){
347 btnEl.dom.tabIndex = this.tabIndex;
350 this.setTooltip(this.tooltip, true);
353 if(this.handleMouseEvents){
356 mouseover: this.onMouseOver,
357 mousedown: this.onMouseDown
360 // new functionality for monitoring on the document level
361 //this.mon(btn, 'mouseout', this.onMouseOut, this);
365 this.mon(this.menu, {
367 show: this.onMenuShow,
368 hide: this.onMenuHide
373 var repeater = new Ext.util.ClickRepeater(btn, Ext.isObject(this.repeat) ? this.repeat : {});
374 this.mon(repeater, 'click', this.onClick, this);
376 this.mon(btn, this.clickEvent, this.onClick, this);
380 afterRender : function(){
381 Ext.Button.superclass.afterRender.call(this);
386 * Sets the CSS class that provides a background image to use as the button's icon. This method also changes
387 * the value of the {@link iconCls} config internally.
388 * @param {String} cls The CSS class providing the icon image
389 * @return {Ext.Button} this
391 setIconClass : function(cls){
393 this.btnEl.replaceClass(this.iconCls, cls);
400 * Sets the tooltip for this Button.
401 * @param {String/Object} tooltip. This may be:<div class="mdesc-details"><ul>
402 * <li><b>String</b> : A string to be used as innerHTML (html tags are accepted) to show in a tooltip</li>
403 * <li><b>Object</b> : A configuration object for {@link Ext.QuickTips#register}.</li>
405 * @return {Ext.Button} this
407 setTooltip : function(tooltip, /* private */ initial){
412 if(Ext.isObject(tooltip)){
413 Ext.QuickTips.register(Ext.apply({
414 target: this.btnEl.id
416 this.tooltip = tooltip;
418 this.btnEl.dom[this.tooltipType] = tooltip;
421 this.tooltip = tooltip;
427 clearTip : function(){
428 if(Ext.isObject(this.tooltip)){
429 Ext.QuickTips.unregister(this.btnEl);
434 beforeDestroy : function(){
438 Ext.destroy(this.menu, this.repeater);
442 onDestroy : function(){
443 var doc = Ext.getDoc();
444 doc.un('mouseover', this.monitorMouseOver, this);
445 doc.un('mouseup', this.onMouseUp, this);
447 Ext.ButtonToggleMgr.unregister(this);
452 doAutoWidth : function(){
453 if(this.el && this.text && this.width === undefined){
454 this.el.setWidth('auto');
455 if(Ext.isIE7 && Ext.isStrict){
457 if(ib && ib.getWidth() > 20){
459 ib.setWidth(Ext.util.TextMetrics.measure(ib, this.text).width+ib.getFrameWidth('lr'));
463 if(this.el.getWidth() < this.minWidth){
464 this.el.setWidth(this.minWidth);
471 * Assigns this Button's click handler
472 * @param {Function} handler The function to call when the button is clicked
473 * @param {Object} scope (optional) Scope for the function passed in. Defaults to this Button.
474 * @return {Ext.Button} this
476 setHandler : function(handler, scope){
477 this.handler = handler;
483 * Sets this Button's text
484 * @param {String} text The button text
485 * @return {Ext.Button} this
487 setText : function(text){
490 this.el.child('td.x-btn-mc ' + this.buttonSelector).update(text);
497 * Gets the text for this Button
498 * @return {String} The button text
500 getText : function(){
505 * If a state it passed, it becomes the pressed state otherwise the current state is toggled.
506 * @param {Boolean} state (optional) Force a particular state
507 * @param {Boolean} supressEvent (optional) True to stop events being fired when calling this method.
508 * @return {Ext.Button} this
510 toggle : function(state, suppressEvent){
511 state = state === undefined ? !this.pressed : !!state;
512 if(state != this.pressed){
514 this.el[state ? 'addClass' : 'removeClass']('x-btn-pressed');
516 this.pressed = state;
518 this.fireEvent('toggle', this, state);
519 if(this.toggleHandler){
520 this.toggleHandler.call(this.scope || this, this, state);
535 onDisable : function(){
536 this.onDisableChange(true);
540 onEnable : function(){
541 this.onDisableChange(false);
544 onDisableChange : function(disabled){
546 if(!Ext.isIE6 || !this.text){
547 this.el[disabled ? 'addClass' : 'removeClass'](this.disabledClass);
549 this.el.dom.disabled = disabled;
551 this.disabled = disabled;
555 * Show this button's menu (if it has one)
557 showMenu : function(){
558 if(this.rendered && this.menu){
560 Ext.QuickTips.getQuickTip().cancelShow(this.btnEl);
562 this.menu.show(this.el, this.menuAlign);
568 * Hide this button's menu (if it has one)
570 hideMenu : function(){
578 * Returns true if the button has a menu and it is visible
581 hasVisibleMenu : function(){
582 return this.menu && this.menu.isVisible();
586 onClick : function(e){
594 if(this.enableToggle && (this.allowDepress !== false || !this.pressed)){
597 if(this.menu && !this.menu.isVisible() && !this.ignoreNextClick){
600 this.fireEvent('click', this, e);
602 //this.el.removeClass('x-btn-over');
603 this.handler.call(this.scope || this, this, e);
609 isMenuTriggerOver : function(e, internal){
610 return this.menu && !internal;
614 isMenuTriggerOut : function(e, internal){
615 return this.menu && !internal;
619 onMouseOver : function(e){
621 var internal = e.within(this.el, true);
623 this.el.addClass('x-btn-over');
624 if(!this.monitoringMouseOver){
625 Ext.getDoc().on('mouseover', this.monitorMouseOver, this);
626 this.monitoringMouseOver = true;
628 this.fireEvent('mouseover', this, e);
630 if(this.isMenuTriggerOver(e, internal)){
631 this.fireEvent('menutriggerover', this, this.menu, e);
637 monitorMouseOver : function(e){
638 if(e.target != this.el.dom && !e.within(this.el)){
639 if(this.monitoringMouseOver){
640 Ext.getDoc().un('mouseover', this.monitorMouseOver, this);
641 this.monitoringMouseOver = false;
648 onMouseOut : function(e){
649 var internal = e.within(this.el) && e.target != this.el.dom;
650 this.el.removeClass('x-btn-over');
651 this.fireEvent('mouseout', this, e);
652 if(this.isMenuTriggerOut(e, internal)){
653 this.fireEvent('menutriggerout', this, this.menu, e);
657 onFocus : function(e){
659 this.el.addClass('x-btn-focus');
663 onBlur : function(e){
664 this.el.removeClass('x-btn-focus');
668 getClickEl : function(e, isUp){
673 onMouseDown : function(e){
674 if(!this.disabled && e.button === 0){
675 this.getClickEl(e).addClass('x-btn-click');
676 Ext.getDoc().on('mouseup', this.onMouseUp, this);
680 onMouseUp : function(e){
682 this.getClickEl(e, true).removeClass('x-btn-click');
683 Ext.getDoc().un('mouseup', this.onMouseUp, this);
687 onMenuShow : function(e){
688 this.ignoreNextClick = 0;
689 this.el.addClass('x-btn-menu-active');
690 this.fireEvent('menushow', this, this.menu);
693 onMenuHide : function(e){
694 this.el.removeClass('x-btn-menu-active');
695 this.ignoreNextClick = this.restoreClick.defer(250, this);
696 this.fireEvent('menuhide', this, this.menu);
700 restoreClick : function(){
701 this.ignoreNextClick = 0;
707 * @cfg {String} autoEl @hide
710 Ext.reg('button', Ext.Button);
712 // Private utility class used by Button
713 Ext.ButtonToggleMgr = function(){
716 function toggleGroup(btn, state){
718 var g = groups[btn.toggleGroup];
719 for(var i = 0, l = g.length; i < l; i++){
728 register : function(btn){
729 if(!btn.toggleGroup){
732 var g = groups[btn.toggleGroup];
734 g = groups[btn.toggleGroup] = [];
737 btn.on('toggle', toggleGroup);
740 unregister : function(btn){
741 if(!btn.toggleGroup){
744 var g = groups[btn.toggleGroup];
747 btn.un('toggle', toggleGroup);
752 * Gets the pressed button in the passed group or null
753 * @param {String} group
756 getPressed : function(group){
757 var g = groups[group];
759 for(var i = 0, len = g.length; i < len; i++){
760 if(g[i].pressed === true){