An Action is a piece of reusable functionality that can be abstracted out of any particular component so that it can be usefully shared among multiple components. Actions let you share handlers, configuration options and UI updates across any components that support the Action interface (primarily Ext.toolbar.Toolbar, Ext.button.Button and Ext.menu.Menu components).
Use a single Action instance as the config object for any number of UI Components which share the same configuration. The Action not only supplies the configuration, but allows all Components based upon it to have a common set of methods called at once through a single call to the Action.
Any Component that is to be configured with an Action must also support the following methods:
setText(string)setIconCls(string)setDisabled(boolean)setVisible(boolean)setHandler(function)This allows the Action to control its associated Components.
Example usage:
// Define the shared Action. Each Component below will have the same
// display text and icon, and will display the same message on click.
var action = new Ext.Action({
text: 'Do something',
handler: function(){
Ext.Msg.alert('Click', 'You did something.');
},
iconCls: 'do-something',
itemId: 'myAction'
});
var panel = new Ext.panel.Panel({
title: 'Actions',
width: 500,
height: 300,
tbar: [
// Add the Action directly to a toolbar as a menu button
action,
{
text: 'Action Menu',
// Add the Action to a menu as a text item
menu: [action]
}
],
items: [
// Add the Action to the panel body as a standard button
new Ext.button.Button(action)
],
renderTo: Ext.getBody()
});
// Change the text for all components using the Action
action.setText('Something else');
// Reference an Action through a container using the itemId
var btn = panel.getComponent('myAction');
var aRef = btn.baseAction;
aRef.setText('New text');
The CSS class selector that specifies a background image to be used as the header icon for all components configured by this Action (defaults to '').
An example of specifying a custom icon class would be something like:
// specify the property in the config for the class:
...
iconCls: 'do-something'
// css class that specifies background image to be used as the icon image:
.do-something { background-image: url(../images/my-icon.gif) 0 6px no-repeat !important; }
True to disable all components configured by this Action, false to enable them (defaults to false).
True to disable all components configured by this Action, false to enable them (defaults to false).
The function that will be invoked by each component tied to this Action when the component's primary event is triggered (defaults to undefined).
The CSS class selector that specifies a background image to be used as the header icon for all components configured by this Action (defaults to '').
An example of specifying a custom icon class would be something like:
// specify the property in the config for the class:
...
iconCls: 'do-something'
// css class that specifies background image to be used as the icon image:
.do-something { background-image: url(../images/my-icon.gif) 0 6px no-repeat !important; }
Disables all components configured by this Action.
Disables all components configured by this Action.
Executes the specified function once for each Component currently tied to this Action. The function passed in should accept a single argument that will be an object that supports the basic Action config/method interface.
The function to execute for each component
The scope (this reference) in which the function is executed. Defaults to the Component.
Enables all components configured by this Action.
Enables all components configured by this Action.
Executes this Action manually using the handler function specified in the original config object
or the handler function set with setHandler. Any arguments passed to this
function will be passed on to the handler function.
(optional) Variable number of arguments passed to the handler function
(optional)
... (optional)
Gets the icon CSS class currently used by all components configured by this Action.
Gets the icon CSS class currently used by all components configured by this Action.
Gets the text currently displayed by all components configured by this Action.
Gets the text currently displayed by all components configured by this Action.
Hides all components configured by this Action.
Hides all components configured by this Action.
Returns true if the components using this Action are currently disabled, else returns false.
Returns true if the components using this Action are currently disabled, else returns false.
Returns true if the components configured by this Action are currently hidden, else returns false.
Returns true if the components configured by this Action are currently hidden, else returns false.
Sets the function that will be called by each Component using this action when its primary event is triggered.
Sets the function that will be called by each Component using this action when its primary event is triggered.
The function that will be invoked by the action's components. The function will be called with no arguments.
The scope (this reference) in which the function is executed. Defaults to the Component firing the event.
Sets the icon CSS class for all components configured by this Action. The class should supply a background image that will be used as the icon image.
The CSS class supplying the icon image
Sets the text to be displayed by all components configured by this Action.
Sets the text to be displayed by all components configured by this Action.
The text to display