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 {Object} scope The scope (<tt><b>this</b></tt> reference) in which the handler is executed. Defaults to this Button.
20 * @cfg {Number} minWidth The minimum width for this button (used to give a set of buttons a common width).
21 * See also {@link Ext.Panel}.<tt>{@link Ext.Panel#minButtonWidth minButtonWidth}</tt>.
22 * @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
23 * @cfg {Boolean} hidden True to start hidden (defaults to false)
24 * @cfg {Boolean} disabled True to start disabled (defaults to false)
25 * @cfg {Boolean} pressed True to start pressed (only if enableToggle = true)
26 * @cfg {String} toggleGroup The group this toggle button is a member of (only 1 per group can be pressed)
27 * @cfg {Boolean/Object} repeat True to repeat fire the click event while the mouse is down. This can also be
28 * a {@link Ext.util.ClickRepeater ClickRepeater} config object (defaults to false).
31 * @param {Object} config The config object
34 Ext.Button = Ext.extend(Ext.BoxComponent, {
36 * Read-only. True if this button is hidden
41 * Read-only. True if this button is disabled
46 * Read-only. True if this button is pressed (only if enableToggle = true)
51 * The Button's owner {@link Ext.Panel} (defaults to undefined, and is set automatically when
52 * the Button is added to a container). Read-only.
58 * @cfg {Number} tabIndex Set a DOM tabIndex for this button (defaults to undefined)
62 * @cfg {Boolean} allowDepress
63 * False to not allow a pressed Button to be depressed (defaults to undefined). Only valid when {@link #enableToggle} is true.
67 * @cfg {Boolean} enableToggle
68 * True to enable pressed/not pressed toggling (defaults to false)
72 * @cfg {Function} toggleHandler
73 * Function called when a Button with {@link #enableToggle} set to true is clicked. Two arguments are passed:<ul class="mdetail-params">
74 * <li><b>button</b> : Ext.Button<div class="sub-desc">this Button object</div></li>
75 * <li><b>state</b> : Boolean<div class="sub-desc">The next state if the Button, true means pressed.</div></li>
80 * Standard menu attribute consisting of a reference to a menu object, a menu id or a menu config blob (defaults to undefined).
83 * @cfg {String} menuAlign
84 * The position to align the menu to (see {@link Ext.Element#alignTo} for more details, defaults to 'tl-bl?').
89 * @cfg {String} overflowText If used in a {@link Ext.Toolbar Toolbar}, the
90 * text to be used if this item is shown in the overflow menu. See also
91 * {@link Ext.Toolbar.Item}.<code>{@link Ext.Toolbar.Item#overflowText overflowText}</code>.
94 * @cfg {String} iconCls
95 * A css class which sets a background image to be used as the icon for this button
99 * submit, reset or button - defaults to 'button'
104 menuClassTarget: 'tr:nth(2)',
107 * @cfg {String} clickEvent
108 * The type of event to map to the button's event handler (defaults to 'click')
110 clickEvent : 'click',
113 * @cfg {Boolean} handleMouseEvents
114 * False to disable visual cues on mouseover, mouseout and mousedown (defaults to true)
116 handleMouseEvents : true,
119 * @cfg {String} tooltipType
120 * The type of tooltip to use. Either 'qtip' (default) for QuickTips or 'title' for title attribute.
122 tooltipType : 'qtip',
125 * @cfg {String} buttonSelector
126 * <p>(Optional) A {@link Ext.DomQuery DomQuery} selector which is used to extract the active, clickable element from the
127 * DOM structure created.</p>
128 * <p>When a custom {@link #template} is used, you must ensure that this selector results in the selection of
129 * a focussable element.</p>
130 * <p>Defaults to <b><tt>"button:first-child"</tt></b>.</p>
132 buttonSelector : 'button:first-child',
135 * @cfg {String} scale
136 * <p>(Optional) The size of the Button. Three values are allowed:</p>
137 * <ul class="mdetail-params">
138 * <li>'small'<div class="sub-desc">Results in the button element being 16px high.</div></li>
139 * <li>'medium'<div class="sub-desc">Results in the button element being 24px high.</div></li>
140 * <li>'large'<div class="sub-desc">Results in the button element being 32px high.</div></li>
142 * <p>Defaults to <b><tt>'small'</tt></b>.</p>
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){
336 this.el.dom.id = this.el.id = this.id;
339 btnEl.setStyle('background-image', 'url(' +this.icon +')');
341 if(this.tabIndex !== undefined){
342 btnEl.dom.tabIndex = this.tabIndex;
345 this.setTooltip(this.tooltip, true);
348 if(this.handleMouseEvents){
351 mouseover: this.onMouseOver,
352 mousedown: this.onMouseDown
355 // new functionality for monitoring on the document level
356 //this.mon(btn, 'mouseout', this.onMouseOut, this);
360 this.mon(this.menu, {
362 show: this.onMenuShow,
363 hide: this.onMenuHide
368 var repeater = new Ext.util.ClickRepeater(btn, Ext.isObject(this.repeat) ? this.repeat : {});
369 this.mon(repeater, 'click', this.onClick, this);
372 this.mon(btn, this.clickEvent, this.onClick, this);
376 afterRender : function(){
377 Ext.Button.superclass.afterRender.call(this);
382 * Sets the CSS class that provides a background image to use as the button's icon. This method also changes
383 * the value of the {@link iconCls} config internally.
384 * @param {String} cls The CSS class providing the icon image
385 * @return {Ext.Button} this
387 setIconClass : function(cls){
389 this.btnEl.replaceClass(this.iconCls, cls);
396 * Sets the tooltip for this Button.
397 * @param {String/Object} tooltip. This may be:<div class="mdesc-details"><ul>
398 * <li><b>String</b> : A string to be used as innerHTML (html tags are accepted) to show in a tooltip</li>
399 * <li><b>Object</b> : A configuration object for {@link Ext.QuickTips#register}.</li>
401 * @return {Ext.Button} this
403 setTooltip : function(tooltip, /* private */ initial){
408 if(Ext.isObject(tooltip)){
409 Ext.QuickTips.register(Ext.apply({
410 target: this.btnEl.id
412 this.tooltip = tooltip;
414 this.btnEl.dom[this.tooltipType] = tooltip;
417 this.tooltip = tooltip;
423 clearTip: function(){
424 if(Ext.isObject(this.tooltip)){
425 Ext.QuickTips.unregister(this.btnEl);
430 beforeDestroy: function(){
434 Ext.destroy(this.menu, this.repeater);
438 onDestroy : function(){
439 var doc = Ext.getDoc();
440 doc.un('mouseover', this.monitorMouseOver, this);
441 doc.un('mouseup', this.onMouseUp, this);
443 Ext.ButtonToggleMgr.unregister(this);
448 doAutoWidth : function(){
449 if(this.el && this.text && this.width === undefined){
450 this.el.setWidth('auto');
451 if(Ext.isIE7 && Ext.isStrict){
453 if(ib && ib.getWidth() > 20){
455 ib.setWidth(Ext.util.TextMetrics.measure(ib, this.text).width+ib.getFrameWidth('lr'));
459 if(this.el.getWidth() < this.minWidth){
460 this.el.setWidth(this.minWidth);
467 * Assigns this Button's click handler
468 * @param {Function} handler The function to call when the button is clicked
469 * @param {Object} scope (optional) Scope for the function passed in
470 * @return {Ext.Button} this
472 setHandler : function(handler, scope){
473 this.handler = handler;
479 * Sets this Button's text
480 * @param {String} text The button text
481 * @return {Ext.Button} this
483 setText : function(text){
486 this.el.child('td.x-btn-mc ' + this.buttonSelector).update(text);
493 * Gets the text for this Button
494 * @return {String} The button text
496 getText : function(){
501 * If a state it passed, it becomes the pressed state otherwise the current state is toggled.
502 * @param {Boolean} state (optional) Force a particular state
503 * @param {Boolean} supressEvent (optional) True to stop events being fired when calling this method.
504 * @return {Ext.Button} this
506 toggle : function(state, suppressEvent){
507 state = state === undefined ? !this.pressed : !!state;
508 if(state != this.pressed){
509 this.el[state ? 'addClass' : 'removeClass']('x-btn-pressed');
510 this.pressed = state;
512 this.fireEvent('toggle', this, state);
513 if(this.toggleHandler){
514 this.toggleHandler.call(this.scope || this, this, state);
529 onDisable : function(){
530 this.onDisableChange(true);
534 onEnable : function(){
535 this.onDisableChange(false);
538 onDisableChange : function(disabled){
540 if(!Ext.isIE6 || !this.text){
541 this.el[disabled ? 'addClass' : 'removeClass'](this.disabledClass);
543 this.el.dom.disabled = disabled;
545 this.disabled = disabled;
549 * Show this button's menu (if it has one)
551 showMenu : function(){
552 if(this.rendered && this.menu){
554 Ext.QuickTips.getQuickTip().cancelShow(this.btnEl);
556 this.menu.show(this.el, this.menuAlign);
562 * Hide this button's menu (if it has one)
564 hideMenu : function(){
572 * Returns true if the button has a menu and it is visible
575 hasVisibleMenu : function(){
576 return this.menu && this.menu.isVisible();
580 onClick : function(e){
588 if(this.enableToggle && (this.allowDepress !== false || !this.pressed)){
591 if(this.menu && !this.menu.isVisible() && !this.ignoreNextClick){
594 this.fireEvent('click', this, e);
596 //this.el.removeClass('x-btn-over');
597 this.handler.call(this.scope || this, this, e);
603 isMenuTriggerOver : function(e, internal){
604 return this.menu && !internal;
608 isMenuTriggerOut : function(e, internal){
609 return this.menu && !internal;
613 onMouseOver : function(e){
615 var internal = e.within(this.el, true);
617 this.el.addClass('x-btn-over');
618 if(!this.monitoringMouseOver){
619 Ext.getDoc().on('mouseover', this.monitorMouseOver, this);
620 this.monitoringMouseOver = true;
622 this.fireEvent('mouseover', this, e);
624 if(this.isMenuTriggerOver(e, internal)){
625 this.fireEvent('menutriggerover', this, this.menu, e);
631 monitorMouseOver : function(e){
632 if(e.target != this.el.dom && !e.within(this.el)){
633 if(this.monitoringMouseOver){
634 Ext.getDoc().un('mouseover', this.monitorMouseOver, this);
635 this.monitoringMouseOver = false;
642 onMouseOut : function(e){
643 var internal = e.within(this.el) && e.target != this.el.dom;
644 this.el.removeClass('x-btn-over');
645 this.fireEvent('mouseout', this, e);
646 if(this.isMenuTriggerOut(e, internal)){
647 this.fireEvent('menutriggerout', this, this.menu, e);
651 onFocus : function(e){
653 this.el.addClass('x-btn-focus');
657 onBlur : function(e){
658 this.el.removeClass('x-btn-focus');
662 getClickEl : function(e, isUp){
667 onMouseDown : function(e){
668 if(!this.disabled && e.button === 0){
669 this.getClickEl(e).addClass('x-btn-click');
670 Ext.getDoc().on('mouseup', this.onMouseUp, this);
674 onMouseUp : function(e){
676 this.getClickEl(e, true).removeClass('x-btn-click');
677 Ext.getDoc().un('mouseup', this.onMouseUp, this);
681 onMenuShow : function(e){
682 this.ignoreNextClick = 0;
683 this.el.addClass('x-btn-menu-active');
684 this.fireEvent('menushow', this, this.menu);
687 onMenuHide : function(e){
688 this.el.removeClass('x-btn-menu-active');
689 this.ignoreNextClick = this.restoreClick.defer(250, this);
690 this.fireEvent('menuhide', this, this.menu);
694 restoreClick : function(){
695 this.ignoreNextClick = 0;
701 * @cfg {String} autoEl @hide
704 Ext.reg('button', Ext.Button);
706 // Private utility class used by Button
707 Ext.ButtonToggleMgr = function(){
710 function toggleGroup(btn, state){
712 var g = groups[btn.toggleGroup];
713 for(var i = 0, l = g.length; i < l; i++){
722 register : function(btn){
723 if(!btn.toggleGroup){
726 var g = groups[btn.toggleGroup];
728 g = groups[btn.toggleGroup] = [];
731 btn.on('toggle', toggleGroup);
734 unregister : function(btn){
735 if(!btn.toggleGroup){
738 var g = groups[btn.toggleGroup];
741 btn.un('toggle', toggleGroup);
746 * Gets the pressed button in the passed group or null
747 * @param {String} group
750 getPressed : function(group){
751 var g = groups[group];
753 for(var i = 0, len = g.length; i < len; i++){
754 if(g[i].pressed === true){
763 * @class Ext.SplitButton
\r
764 * @extends Ext.Button
\r
765 * A split button that provides a built-in dropdown arrow that can fire an event separately from the default
\r
766 * click event of the button. Typically this would be used to display a dropdown menu that provides additional
\r
767 * options to the primary button action, but any custom handler can provide the arrowclick implementation. Example usage:
\r
769 // display a dropdown menu:
\r
770 new Ext.SplitButton({
\r
771 renderTo: 'button-ct', // the container id
\r
773 handler: optionsHandler, // handle a click on the button itself
\r
774 menu: new Ext.menu.Menu({
\r
776 // these items will render as dropdown menu items when the arrow is clicked:
\r
777 {text: 'Item 1', handler: item1Handler},
\r
778 {text: 'Item 2', handler: item2Handler}
\r
783 // Instead of showing a menu, you provide any type of custom
\r
784 // functionality you want when the dropdown arrow is clicked:
\r
785 new Ext.SplitButton({
\r
786 renderTo: 'button-ct',
\r
788 handler: optionsHandler,
\r
789 arrowHandler: myCustomHandler
\r
792 * @cfg {Function} arrowHandler A function called when the arrow button is clicked (can be used instead of click event)
\r
793 * @cfg {String} arrowTooltip The title attribute of the arrow
\r
795 * Create a new menu button
\r
796 * @param {Object} config The config object
\r
797 * @xtype splitbutton
\r
799 Ext.SplitButton = Ext.extend(Ext.Button, {
\r
801 arrowSelector : 'em',
\r
805 initComponent : function(){
\r
806 Ext.SplitButton.superclass.initComponent.call(this);
\r
808 * @event arrowclick
\r
809 * Fires when this button's arrow is clicked
\r
810 * @param {MenuButton} this
\r
811 * @param {EventObject} e The click event
\r
813 this.addEvents("arrowclick");
\r
817 onRender : function(){
\r
818 Ext.SplitButton.superclass.onRender.apply(this, arguments);
\r
819 if(this.arrowTooltip){
\r
820 this.el.child(this.arrowSelector).dom[this.tooltipType] = this.arrowTooltip;
\r
825 * Sets this button's arrow click handler.
\r
826 * @param {Function} handler The function to call when the arrow is clicked
\r
827 * @param {Object} scope (optional) Scope for the function passed above
\r
829 setArrowHandler : function(handler, scope){
\r
830 this.arrowHandler = handler;
\r
831 this.scope = scope;
\r
834 getMenuClass : function(){
\r
835 return 'x-btn-split' + (this.arrowAlign == 'bottom' ? '-bottom' : '');
\r
838 isClickOnArrow : function(e){
\r
839 return this.arrowAlign != 'bottom' ?
\r
840 e.getPageX() > this.el.child(this.buttonSelector).getRegion().right :
\r
841 e.getPageY() > this.el.child(this.buttonSelector).getRegion().bottom;
\r
845 onClick : function(e, t){
\r
846 e.preventDefault();
\r
847 if(!this.disabled){
\r
848 if(this.isClickOnArrow(e)){
\r
849 if(this.menu && !this.menu.isVisible() && !this.ignoreNextClick){
\r
852 this.fireEvent("arrowclick", this, e);
\r
853 if(this.arrowHandler){
\r
854 this.arrowHandler.call(this.scope || this, this, e);
\r
857 if(this.enableToggle){
\r
860 this.fireEvent("click", this, e);
\r
862 this.handler.call(this.scope || this, this, e);
\r
869 isMenuTriggerOver : function(e){
\r
870 return this.menu && e.target.tagName == 'em';
\r
874 isMenuTriggerOut : function(e, internal){
\r
875 return this.menu && e.target.tagName != 'em';
\r
879 Ext.reg('splitbutton', Ext.SplitButton);/**
\r
880 * @class Ext.CycleButton
\r
881 * @extends Ext.SplitButton
\r
882 * A specialized SplitButton that contains a menu of {@link Ext.menu.CheckItem} elements. The button automatically
\r
883 * cycles through each menu item on click, raising the button's {@link #change} event (or calling the button's
\r
884 * {@link #changeHandler} function, if supplied) for the active menu item. Clicking on the arrow section of the
\r
885 * button displays the dropdown menu just like a normal SplitButton. Example usage:
\r
887 var btn = new Ext.CycleButton({
\r
889 prependText: 'View as ',
\r
892 iconCls:'view-text',
\r
896 iconCls:'view-html'
\r
898 changeHandler:function(btn, item){
\r
899 Ext.Msg.alert('Change View', item.text);
\r
904 * Create a new split button
\r
905 * @param {Object} config The config object
\r
908 Ext.CycleButton = Ext.extend(Ext.SplitButton, {
\r
910 * @cfg {Array} items An array of {@link Ext.menu.CheckItem} <b>config</b> objects to be used when creating the
\r
911 * button's menu items (e.g., {text:'Foo', iconCls:'foo-icon'})
\r
914 * @cfg {Boolean} showText True to display the active item's text as the button text (defaults to false)
\r
917 * @cfg {String} prependText A static string to prepend before the active item's text when displayed as the
\r
918 * button's text (only applies when showText = true, defaults to '')
\r
921 * @cfg {Function} changeHandler A callback function that will be invoked each time the active menu
\r
922 * item in the button's menu has changed. If this callback is not supplied, the SplitButton will instead
\r
923 * fire the {@link #change} event on active item change. The changeHandler function will be called with the
\r
924 * following argument list: (SplitButton this, Ext.menu.CheckItem item)
\r
927 * @cfg {String} forceIcon A css class which sets an image to be used as the static icon for this button. This
\r
928 * icon will always be displayed regardless of which item is selected in the dropdown list. This overrides the
\r
929 * default behavior of changing the button's icon to match the selected item's icon on change.
\r
934 * The {@link Ext.menu.Menu Menu} object used to display the {@link Ext.menu.CheckItem CheckItems} representing the available choices.
\r
938 getItemText : function(item){
\r
939 if(item && this.showText === true){
\r
941 if(this.prependText){
\r
942 text += this.prependText;
\r
951 * Sets the button's active menu item.
\r
952 * @param {Ext.menu.CheckItem} item The item to activate
\r
953 * @param {Boolean} suppressEvent True to prevent the button's change event from firing (defaults to false)
\r
955 setActiveItem : function(item, suppressEvent){
\r
956 if(typeof item != 'object'){
\r
957 item = this.menu.items.get(item);
\r
960 if(!this.rendered){
\r
961 this.text = this.getItemText(item);
\r
962 this.iconCls = item.iconCls;
\r
964 var t = this.getItemText(item);
\r
968 this.setIconClass(item.iconCls);
\r
970 this.activeItem = item;
\r
972 item.setChecked(true, true);
\r
974 if(this.forceIcon){
\r
975 this.setIconClass(this.forceIcon);
\r
977 if(!suppressEvent){
\r
978 this.fireEvent('change', this, item);
\r
984 * Gets the currently active menu item.
\r
985 * @return {Ext.menu.CheckItem} The active item
\r
987 getActiveItem : function(){
\r
988 return this.activeItem;
\r
992 initComponent : function(){
\r
996 * Fires after the button's active menu item has changed. Note that if a {@link #changeHandler} function
\r
997 * is set on this CycleButton, it will be called instead on active item change and this change event will
\r
999 * @param {Ext.CycleButton} this
\r
1000 * @param {Ext.menu.CheckItem} item The menu item that was selected
\r
1005 if(this.changeHandler){
\r
1006 this.on('change', this.changeHandler, this.scope||this);
\r
1007 delete this.changeHandler;
\r
1010 this.itemCount = this.items.length;
\r
1012 this.menu = {cls:'x-cycle-menu', items:[]};
\r
1014 for(var i = 0, len = this.itemCount; i < len; i++){
\r
1015 var item = this.items[i];
\r
1016 item.group = item.group || this.id;
\r
1017 item.itemIndex = i;
\r
1018 item.checkHandler = this.checkHandler;
\r
1019 item.scope = this;
\r
1020 item.checked = item.checked || false;
\r
1021 this.menu.items.push(item);
\r
1026 this.setActiveItem(checked, true);
\r
1027 Ext.CycleButton.superclass.initComponent.call(this);
\r
1029 this.on('click', this.toggleSelected, this);
\r
1033 checkHandler : function(item, pressed){
\r
1035 this.setActiveItem(item);
\r
1040 * This is normally called internally on button click, but can be called externally to advance the button's
\r
1041 * active item programmatically to the next one in the menu. If the current item is the last one in the menu
\r
1042 * the active item will be set to the first item in the menu.
\r
1044 toggleSelected : function(){
\r
1045 this.menu.render();
\r
1047 var nextIdx, checkItem;
\r
1048 for (var i = 1; i < this.itemCount; i++) {
\r
1049 nextIdx = (this.activeItem.itemIndex + i) % this.itemCount;
\r
1050 // check the potential item
\r
1051 checkItem = this.menu.items.itemAt(nextIdx);
\r
1052 // if its not disabled then check it.
\r
1053 if (!checkItem.disabled) {
\r
1054 checkItem.setChecked(true);
\r
1060 Ext.reg('cycle', Ext.CycleButton);