/**
+ * @class Ext.button.Cycle
* @extends Ext.button.Split
* A specialized SplitButton that contains a menu of {@link Ext.menu.CheckItem} elements. The button automatically
* cycles through each menu item on click, raising the button's {@link #change} event (or calling the button's
@@ -28,12 +45,7 @@ Ext.create('Ext.button.Cycle', {
}
});
</code></pre>
- * @constructor
- * Create a new split button
- * @param {Object} config The config object
- * @xtype cycle
*/
-
Ext.define('Ext.button.Cycle', {
/* Begin Definitions */
@@ -45,32 +57,32 @@ Ext.define('Ext.button.Cycle', {
/* End Definitions */
- /**
+ /**
* @cfg {Array} items <p>Deprecated as of 4.0. Use the {@link #menu} config instead. All menu items will be created
* as {@link Ext.menu.CheckItem CheckItem}s.</p>
* <p>An array of {@link Ext.menu.CheckItem} <b>config</b> objects to be used when creating the
* button's menu items (e.g., {text:'Foo', iconCls:'foo-icon'})
*/
- /**
+ /**
* @cfg {Boolean} showText True to display the active item's text as the button text (defaults to false).
* The Button will show its configured {@link #text} if this. config is omitted.
*/
- /**
+ /**
* @cfg {String} prependText A static string to prepend before the active item's text when displayed as the
* button's text (only applies when showText = true, defaults to '')
*/
- /**
+ /**
* @cfg {Function} changeHandler A callback function that will be invoked each time the active menu
* item in the button's menu has changed. If this callback is not supplied, the SplitButton will instead
* fire the {@link #change} event on active item change. The changeHandler function will be called with the
* following argument list: (SplitButton this, Ext.menu.CheckItem item)
*/
- /**
+ /**
* @cfg {String} forceIcon A css class which sets an image to be used as the static icon for this button. This
* icon will always be displayed regardless of which item is selected in the dropdown list. This overrides the
* default behavior of changing the button's icon to match the selected item's icon on change.
*/
- /**
+ /**
* @property menu
* @type Menu
* The {@link Ext.menu.Menu Menu} object used to display the {@link Ext.menu.CheckItem CheckItems} representing the available choices.
@@ -91,7 +103,7 @@ Ext.define('Ext.button.Cycle', {
return me.text;
},
- /**
+ /**
* Sets the button's active menu item.
* @param {Ext.menu.CheckItem} item The item to activate
* @param {Boolean} suppressEvent True to prevent the button's change event from firing (defaults to false)
@@ -123,7 +135,7 @@ Ext.define('Ext.button.Cycle', {
}
},
- /**
+ /**
* Gets the currently active menu item.
* @return {Ext.menu.CheckItem} The active item
*/
@@ -138,7 +150,7 @@ Ext.define('Ext.button.Cycle', {
items;
me.addEvents(
- /**
+ /**
* @event change
* Fires after the button's active menu item has changed. Note that if a {@link #changeHandler} function
* is set on this CycleButton, it will be called instead on active item change and this change event will
@@ -194,7 +206,7 @@ Ext.define('Ext.button.Cycle', {
}
},
- /**
+ /**
* This is normally called internally on button click, but can be called externally to advance the button's
* active item programmatically to the next one in the menu. If the current item is the last one in the menu
* the active item will be set to the first item in the menu.
@@ -207,4 +219,6 @@ Ext.define('Ext.button.Cycle', {
checkItem = me.activeItem.next(':not([disabled])') || m.items.getAt(0);
checkItem.setChecked(true);
}
-});