3 * Copyright(c) 2006-2010 Ext JS, Inc.
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 of 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 * @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>.
196 initComponent : function(){
197 Ext.Button.superclass.initComponent.call(this);
202 * Fires when this button is clicked
203 * @param {Button} this
204 * @param {EventObject} e The click event
209 * Fires when the 'pressed' state of this button changes (only if enableToggle = true)
210 * @param {Button} this
211 * @param {Boolean} pressed
216 * Fires when the mouse hovers over the button
217 * @param {Button} this
218 * @param {Event} e The event object
223 * Fires when the mouse exits the button
224 * @param {Button} this
225 * @param {Event} e The event object
230 * If this button has a menu, this event fires when it is shown
231 * @param {Button} this
237 * If this button has a menu, this event fires when it is hidden
238 * @param {Button} this
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
247 * @param {EventObject} e
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
255 * @param {EventObject} e
260 this.menu = Ext.menu.MenuMgr.get(this.menu);
262 if(Ext.isString(this.toggleGroup)){
263 this.enableToggle = true;
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 <button>'s {@link #type}</li>
275 * <li>A CSS class name applied to the Button's main <tbody> 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 <table> element.</li>
278 * <li>The Component id which is applied to the button's wrapping <table> element.</li>
280 * @return {Array} Substitution data for a Template.
282 getTemplateArgs : function(){
283 return [this.type, 'x-btn-' + this.scale + ' x-btn-icon-' + this.scale + '-' + this.iconAlign, this.getMenuClass(), this.cls, this.id];
287 setButtonClass : function(){
288 if(this.useSetClass){
289 if(!Ext.isEmpty(this.oldCls)){
290 this.el.removeClass([this.oldCls, 'x-btn-pressed']);
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]);
298 getMenuClass : function(){
299 return this.menu ? (this.arrowAlign != 'bottom' ? 'x-btn-arrow' : 'x-btn-arrow-bottom') : '';
303 onRender : function(ct, position){
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> </i></td><td class="x-btn-tc"></td><td class="x-btn-tr"><i> </i></td></tr>',
310 '<tr><td class="x-btn-ml"><i> </i></td><td class="x-btn-mc"><em class="{2}" unselectable="on"><button type="{0}"></button></em></td><td class="x-btn-mr"><i> </i></td></tr>',
311 '<tr><td class="x-btn-bl"><i> </i></td><td class="x-btn-bc"></td><td class="x-btn-br"><i> </i></td></tr>',
313 Ext.Button.buttonTemplate.compile();
315 this.template = Ext.Button.buttonTemplate;
318 var btn, targs = this.getTemplateArgs();
321 btn = this.template.insertBefore(position, targs, true);
323 btn = this.template.append(ct, targs, true);
326 * An {@link Ext.Element Element} encapsulating the Button's clickable element. By default,
327 * this references a <tt><button></tt> element. Read only.
331 this.btnEl = btn.child(this.buttonSelector);
332 this.mon(this.btnEl, {
338 this.initButtonEl(btn, this.btnEl);
340 Ext.ButtonToggleMgr.register(this);
344 initButtonEl : function(btn, btnEl){
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;
353 this.setTooltip(this.tooltip, true);
356 if(this.handleMouseEvents){
359 mouseover: this.onMouseOver,
360 mousedown: this.onMouseDown
363 // new functionality for monitoring on the document level
364 //this.mon(btn, 'mouseout', this.onMouseOut, this);
368 this.mon(this.menu, {
370 show: this.onMenuShow,
371 hide: this.onMenuHide
376 var repeater = new Ext.util.ClickRepeater(btn, Ext.isObject(this.repeat) ? this.repeat : {});
377 this.mon(repeater, 'click', this.onClick, this);
379 this.mon(btn, this.clickEvent, this.onClick, this);
383 afterRender : function(){
384 Ext.Button.superclass.afterRender.call(this);
385 this.useSetClass = true;
386 this.setButtonClass();
387 this.doc = Ext.getDoc();
392 * Sets the CSS class that provides a background image to use as the button's icon. This method also changes
393 * the value of the {@link iconCls} config internally.
394 * @param {String} cls The CSS class providing the icon image
395 * @return {Ext.Button} this
397 setIconClass : function(cls){
400 this.btnEl.dom.className = '';
401 this.btnEl.addClass(['x-btn-text', cls || '']);
402 this.setButtonClass();
408 * Sets the tooltip for this Button.
409 * @param {String/Object} tooltip. This may be:<div class="mdesc-details"><ul>
410 * <li><b>String</b> : A string to be used as innerHTML (html tags are accepted) to show in a tooltip</li>
411 * <li><b>Object</b> : A configuration object for {@link Ext.QuickTips#register}.</li>
413 * @return {Ext.Button} this
415 setTooltip : function(tooltip, /* private */ initial){
420 if(Ext.isObject(tooltip)){
421 Ext.QuickTips.register(Ext.apply({
422 target: this.btnEl.id
424 this.tooltip = tooltip;
426 this.btnEl.dom[this.tooltipType] = tooltip;
429 this.tooltip = tooltip;
435 clearTip : function(){
436 if(Ext.isObject(this.tooltip)){
437 Ext.QuickTips.unregister(this.btnEl);
442 beforeDestroy : function(){
446 if(this.menu && this.destroyMenu !== false) {
447 Ext.destroy(this.menu);
449 Ext.destroy(this.repeater);
453 onDestroy : function(){
455 this.doc.un('mouseover', this.monitorMouseOver, this);
456 this.doc.un('mouseup', this.onMouseUp, this);
459 Ext.ButtonToggleMgr.unregister(this);
461 Ext.Button.superclass.onDestroy.call(this);
465 doAutoWidth : function(){
466 if(this.autoWidth !== false && this.el && this.text && this.width === undefined){
467 this.el.setWidth('auto');
468 if(Ext.isIE7 && Ext.isStrict){
470 if(ib && ib.getWidth() > 20){
472 ib.setWidth(Ext.util.TextMetrics.measure(ib, this.text).width+ib.getFrameWidth('lr'));
476 if(this.el.getWidth() < this.minWidth){
477 this.el.setWidth(this.minWidth);
484 * Assigns this Button's click handler
485 * @param {Function} handler The function to call when the button is clicked
486 * @param {Object} scope (optional) The scope (<code>this</code> reference) in which the handler function is executed.
487 * Defaults to this Button.
488 * @return {Ext.Button} this
490 setHandler : function(handler, scope){
491 this.handler = handler;
497 * Sets this Button's text
498 * @param {String} text The button text
499 * @return {Ext.Button} this
501 setText : function(text){
504 this.btnEl.update(text || ' ');
505 this.setButtonClass();
512 * Sets the background image (inline style) of the button. This method also changes
513 * the value of the {@link icon} config internally.
514 * @param {String} icon The path to an image to display in the button
515 * @return {Ext.Button} this
517 setIcon : function(icon){
520 this.btnEl.setStyle('background-image', icon ? 'url(' + icon + ')' : '');
521 this.setButtonClass();
527 * Gets the text for this Button
528 * @return {String} The button text
530 getText : function(){
535 * If a state it passed, it becomes the pressed state otherwise the current state is toggled.
536 * @param {Boolean} state (optional) Force a particular state
537 * @param {Boolean} supressEvent (optional) True to stop events being fired when calling this method.
538 * @return {Ext.Button} this
540 toggle : function(state, suppressEvent){
541 state = state === undefined ? !this.pressed : !!state;
542 if(state != this.pressed){
544 this.el[state ? 'addClass' : 'removeClass']('x-btn-pressed');
546 this.pressed = state;
548 this.fireEvent('toggle', this, state);
549 if(this.toggleHandler){
550 this.toggleHandler.call(this.scope || this, this, state);
558 onDisable : function(){
559 this.onDisableChange(true);
563 onEnable : function(){
564 this.onDisableChange(false);
567 onDisableChange : function(disabled){
569 if(!Ext.isIE6 || !this.text){
570 this.el[disabled ? 'addClass' : 'removeClass'](this.disabledClass);
572 this.el.dom.disabled = disabled;
574 this.disabled = disabled;
578 * Show this button's menu (if it has one)
580 showMenu : function(){
581 if(this.rendered && this.menu){
583 Ext.QuickTips.getQuickTip().cancelShow(this.btnEl);
585 if(this.menu.isVisible()){
588 this.menu.ownerCt = this;
589 this.menu.show(this.el, this.menuAlign);
595 * Hide this button's menu (if it has one)
597 hideMenu : function(){
598 if(this.hasVisibleMenu()){
605 * Returns true if the button has a menu and it is visible
608 hasVisibleMenu : function(){
609 return this.menu && this.menu.ownerCt == this && this.menu.isVisible();
613 onClick : function(e){
621 if(this.enableToggle && (this.allowDepress !== false || !this.pressed)){
624 if(this.menu && !this.hasVisibleMenu() && !this.ignoreNextClick){
627 this.fireEvent('click', this, e);
629 //this.el.removeClass('x-btn-over');
630 this.handler.call(this.scope || this, this, e);
636 isMenuTriggerOver : function(e, internal){
637 return this.menu && !internal;
641 isMenuTriggerOut : function(e, internal){
642 return this.menu && !internal;
646 onMouseOver : function(e){
648 var internal = e.within(this.el, true);
650 this.el.addClass('x-btn-over');
651 if(!this.monitoringMouseOver){
652 this.doc.on('mouseover', this.monitorMouseOver, this);
653 this.monitoringMouseOver = true;
655 this.fireEvent('mouseover', this, e);
657 if(this.isMenuTriggerOver(e, internal)){
658 this.fireEvent('menutriggerover', this, this.menu, e);
664 monitorMouseOver : function(e){
665 if(e.target != this.el.dom && !e.within(this.el)){
666 if(this.monitoringMouseOver){
667 this.doc.un('mouseover', this.monitorMouseOver, this);
668 this.monitoringMouseOver = false;
675 onMouseOut : function(e){
676 var internal = e.within(this.el) && e.target != this.el.dom;
677 this.el.removeClass('x-btn-over');
678 this.fireEvent('mouseout', this, e);
679 if(this.isMenuTriggerOut(e, internal)){
680 this.fireEvent('menutriggerout', this, this.menu, e);
693 onFocus : function(e){
695 this.el.addClass('x-btn-focus');
699 onBlur : function(e){
700 this.el.removeClass('x-btn-focus');
704 getClickEl : function(e, isUp){
709 onMouseDown : function(e){
710 if(!this.disabled && e.button === 0){
711 this.getClickEl(e).addClass('x-btn-click');
712 this.doc.on('mouseup', this.onMouseUp, this);
716 onMouseUp : function(e){
718 this.getClickEl(e, true).removeClass('x-btn-click');
719 this.doc.un('mouseup', this.onMouseUp, this);
723 onMenuShow : function(e){
724 if(this.menu.ownerCt == this){
725 this.menu.ownerCt = this;
726 this.ignoreNextClick = 0;
727 this.el.addClass('x-btn-menu-active');
728 this.fireEvent('menushow', this, this.menu);
732 onMenuHide : function(e){
733 if(this.menu.ownerCt == this){
734 this.el.removeClass('x-btn-menu-active');
735 this.ignoreNextClick = this.restoreClick.defer(250, this);
736 this.fireEvent('menuhide', this, this.menu);
737 delete this.menu.ownerCt;
742 restoreClick : function(){
743 this.ignoreNextClick = 0;
747 * @cfg {String} autoEl @hide
750 * @cfg {String/Object} html @hide
753 * @cfg {String} contentEl @hide
756 * @cfg {Mixed} data @hide
759 * @cfg {Mixed} tpl @hide
762 * @cfg {String} tplWriteMode @hide
765 Ext.reg('button', Ext.Button);
767 // Private utility class used by Button
768 Ext.ButtonToggleMgr = function(){
771 function toggleGroup(btn, state){
773 var g = groups[btn.toggleGroup];
774 for(var i = 0, l = g.length; i < l; i++){
783 register : function(btn){
784 if(!btn.toggleGroup){
787 var g = groups[btn.toggleGroup];
789 g = groups[btn.toggleGroup] = [];
792 btn.on('toggle', toggleGroup);
795 unregister : function(btn){
796 if(!btn.toggleGroup){
799 var g = groups[btn.toggleGroup];
802 btn.un('toggle', toggleGroup);
807 * Gets the pressed button in the passed group or null
808 * @param {String} group
811 getPressed : function(group){
812 var g = groups[group];
814 for(var i = 0, len = g.length; i < len; i++){
815 if(g[i].pressed === true){