<html>\r
<head>\r
+ <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> \r
<title>The source code</title>\r
<link href="../resources/prettify/prettify.css" type="text/css" rel="stylesheet" />\r
<script type="text/javascript" src="../resources/prettify/prettify.js"></script>\r
</head>\r
<body onload="prettyPrint();">\r
- <pre class="prettyprint lang-js"><div id="cls-Ext.form.Action"></div>/**
- * @class Ext.form.Action
- * <p>The subclasses of this class provide actions to perform upon {@link Ext.form.BasicForm Form}s.</p>
- * <p>Instances of this class are only created by a {@link Ext.form.BasicForm Form} when
- * the Form needs to perform an action such as submit or load. The Configuration options
- * listed for this class are set through the Form's action methods: {@link Ext.form.BasicForm#submit submit},
- * {@link Ext.form.BasicForm#load load} and {@link Ext.form.BasicForm#doAction doAction}</p>
- * <p>The instance of Action which performed the action is passed to the success
- * and failure callbacks of the Form's action methods ({@link Ext.form.BasicForm#submit submit},
- * {@link Ext.form.BasicForm#load load} and {@link Ext.form.BasicForm#doAction doAction}),
- * and to the {@link Ext.form.BasicForm#actioncomplete actioncomplete} and
- * {@link Ext.form.BasicForm#actionfailed actionfailed} event handlers.</p>
- */
-Ext.form.Action = function(form, options){
- this.form = form;
- this.options = options || {};
-};
-
-<div id="prop-Ext.form.Action-CLIENT_INVALID"></div>/**
- * Failure type returned when client side validation of the Form fails
- * thus aborting a submit action. Client side validation is performed unless
- * {@link #clientValidation} is explicitly set to <tt>false</tt>.
- * @type {String}
- * @static
- */
-Ext.form.Action.CLIENT_INVALID = 'client';
-<div id="prop-Ext.form.Action-SERVER_INVALID"></div>/**
- * <p>Failure type returned when server side processing fails and the {@link #result}'s
- * <tt style="font-weight:bold">success</tt> property is set to <tt>false</tt>.</p>
- * <p>In the case of a form submission, field-specific error messages may be returned in the
- * {@link #result}'s <tt style="font-weight:bold">errors</tt> property.</p>
- * @type {String}
- * @static
- */
-Ext.form.Action.SERVER_INVALID = 'server';
-<div id="prop-Ext.form.Action-CONNECT_FAILURE"></div>/**
- * Failure type returned when a communication error happens when attempting
- * to send a request to the remote server. The {@link #response} may be examined to
- * provide further information.
- * @type {String}
- * @static
- */
-Ext.form.Action.CONNECT_FAILURE = 'connect';
-<div id="prop-Ext.form.Action-LOAD_FAILURE"></div>/**
- * Failure type returned when the response's <tt style="font-weight:bold">success</tt>
- * property is set to <tt>false</tt>, or no field values are returned in the response's
- * <tt style="font-weight:bold">data</tt> property.
- * @type {String}
- * @static
- */
-Ext.form.Action.LOAD_FAILURE = 'load';
-
-Ext.form.Action.prototype = {
-<div id="cfg-Ext.form.Action-url"></div>/**
- * @cfg {String} url The URL that the Action is to invoke.
- */
-<div id="cfg-Ext.form.Action-reset"></div>/**
- * @cfg {Boolean} reset When set to <tt><b>true</b></tt>, causes the Form to be
- * {@link Ext.form.BasicForm.reset reset} on Action success. If specified, this happens
- * <b>before</b> the {@link #success} callback is called and before the Form's
- * {@link Ext.form.BasicForm.actioncomplete actioncomplete} event fires.
- */
-<div id="cfg-Ext.form.Action-method"></div>/**
- * @cfg {String} method The HTTP method to use to access the requested URL. Defaults to the
- * {@link Ext.form.BasicForm}'s method, or if that is not specified, the underlying DOM form's method.
- */
-<div id="cfg-Ext.form.Action-params"></div>/**
- * @cfg {Mixed} params <p>Extra parameter values to pass. These are added to the Form's
- * {@link Ext.form.BasicForm#baseParams} and passed to the specified URL along with the Form's
- * input fields.</p>
- * <p>Parameters are encoded as standard HTTP parameters using {@link Ext#urlEncode}.</p>
- */
-<div id="cfg-Ext.form.Action-timeout"></div>/**
- * @cfg {Number} timeout The number of seconds to wait for a server response before
- * failing with the {@link #failureType} as {@link #Action.CONNECT_FAILURE}. If not specified,
- * defaults to the configured <tt>{@link Ext.form.BasicForm#timeout timeout}</tt> of the
- * {@link Ext.form.BasicForm form}.
- */
-<div id="cfg-Ext.form.Action-success"></div>/**
- * @cfg {Function} success The function to call when a valid success return packet is recieved.
- * The function is passed the following parameters:<ul class="mdetail-params">
- * <li><b>form</b> : Ext.form.BasicForm<div class="sub-desc">The form that requested the action</div></li>
- * <li><b>action</b> : Ext.form.Action<div class="sub-desc">The Action class. The {@link #result}
- * property of this object may be examined to perform custom postprocessing.</div></li>
- * </ul>
- */
-<div id="cfg-Ext.form.Action-failure"></div>/**
- * @cfg {Function} failure The function to call when a failure packet was recieved, or when an
- * error ocurred in the Ajax communication.
- * The function is passed the following parameters:<ul class="mdetail-params">
- * <li><b>form</b> : Ext.form.BasicForm<div class="sub-desc">The form that requested the action</div></li>
- * <li><b>action</b> : Ext.form.Action<div class="sub-desc">The Action class. If an Ajax
- * error ocurred, the failure type will be in {@link #failureType}. The {@link #result}
- * property of this object may be examined to perform custom postprocessing.</div></li>
- * </ul>
- */
-<div id="cfg-Ext.form.Action-scope"></div>/**
- * @cfg {Object} scope The scope in which to call the callback functions (The <tt>this</tt> reference
- * for the callback functions).
- */
-<div id="cfg-Ext.form.Action-waitMsg"></div>/**
- * @cfg {String} waitMsg The message to be displayed by a call to {@link Ext.MessageBox#wait}
- * during the time the action is being processed.
- */
-<div id="cfg-Ext.form.Action-waitTitle"></div>/**
- * @cfg {String} waitTitle The title to be displayed by a call to {@link Ext.MessageBox#wait}
- * during the time the action is being processed.
- */
-
-<div id="prop-Ext.form.Action-type"></div>/**
- * The type of action this Action instance performs.
- * Currently only "submit" and "load" are supported.
- * @type {String}
- */
- type : 'default',
-<div id="prop-Ext.form.Action-failureType"></div>/**
- * The type of failure detected will be one of these: {@link #CLIENT_INVALID},
- * {@link #SERVER_INVALID}, {@link #CONNECT_FAILURE}, or {@link #LOAD_FAILURE}. Usage:
- * <pre><code>
-var fp = new Ext.form.FormPanel({
-...
-buttons: [{
- text: 'Save',
- formBind: true,
- handler: function(){
- if(fp.getForm().isValid()){
- fp.getForm().submit({
- url: 'form-submit.php',
- waitMsg: 'Submitting your data...',
- success: function(form, action){
- // server responded with success = true
- var result = action.{@link #result};
- },
- failure: function(form, action){
- if (action.{@link #failureType} === Ext.form.Action.{@link #CONNECT_FAILURE}) {
- Ext.Msg.alert('Error',
- 'Status:'+action.{@link #response}.status+': '+
- action.{@link #response}.statusText);
- }
- if (action.failureType === Ext.form.Action.{@link #SERVER_INVALID}){
- // server responded with success = false
- Ext.Msg.alert('Invalid', action.{@link #result}.errormsg);
- }
- }
- });
- }
- }
-},{
- text: 'Reset',
- handler: function(){
- fp.getForm().reset();
- }
-}]
- * </code></pre>
- * @property failureType
- * @type {String}
- */
- <div id="prop-Ext.form.Action-response"></div>/**
- * The XMLHttpRequest object used to perform the action.
- * @property response
- * @type {Object}
- */
- <div id="prop-Ext.form.Action-result"></div>/**
- * The decoded response object containing a boolean <tt style="font-weight:bold">success</tt> property and
- * other, action-specific properties.
- * @property result
- * @type {Object}
- */
-
- // interface method
- run : function(options){
-
- },
-
- // interface method
- success : function(response){
-
- },
-
- // interface method
- handleResponse : function(response){
-
- },
-
- // default connection failure
- failure : function(response){
- this.response = response;
- this.failureType = Ext.form.Action.CONNECT_FAILURE;
- this.form.afterAction(this, false);
- },
-
- // private
- // shared code among all Actions to validate that there was a response
- // with either responseText or responseXml
- processResponse : function(response){
- this.response = response;
- if(!response.responseText && !response.responseXML){
- return true;
- }
- this.result = this.handleResponse(response);
- return this.result;
- },
-
- // utility functions used internally
- getUrl : function(appendParams){
- var url = this.options.url || this.form.url || this.form.el.dom.action;
- if(appendParams){
- var p = this.getParams();
- if(p){
- url = Ext.urlAppend(url, p);
- }
- }
- return url;
- },
-
- // private
- getMethod : function(){
- return (this.options.method || this.form.method || this.form.el.dom.method || 'POST').toUpperCase();
- },
-
- // private
- getParams : function(){
- var bp = this.form.baseParams;
- var p = this.options.params;
- if(p){
- if(typeof p == "object"){
- p = Ext.urlEncode(Ext.applyIf(p, bp));
- }else if(typeof p == 'string' && bp){
- p += '&' + Ext.urlEncode(bp);
- }
- }else if(bp){
- p = Ext.urlEncode(bp);
- }
- return p;
- },
-
- // private
- createCallback : function(opts){
- var opts = opts || {};
- return {
- success: this.success,
- failure: this.failure,
- scope: this,
- timeout: (opts.timeout*1000) || (this.form.timeout*1000),
- upload: this.form.fileUpload ? this.success : undefined
- };
- }
-};
-
-<div id="cls-Ext.form.Action.Submit"></div>/**
- * @class Ext.form.Action.Submit
- * @extends Ext.form.Action
- * <p>A class which handles submission of data from {@link Ext.form.BasicForm Form}s
- * and processes the returned response.</p>
- * <p>Instances of this class are only created by a {@link Ext.form.BasicForm Form} when
- * {@link Ext.form.BasicForm#submit submit}ting.</p>
- * <p><u><b>Response Packet Criteria</b></u></p>
- * <p>A response packet may contain:
- * <div class="mdetail-params"><ul>
- * <li><b><code>success</code></b> property : Boolean
- * <div class="sub-desc">The <code>success</code> property is required.</div></li>
- * <li><b><code>errors</code></b> property : Object
- * <div class="sub-desc"><div class="sub-desc">The <code>errors</code> property,
- * which is optional, contains error messages for invalid fields.</div></li>
- * </ul></div>
- * <p><u><b>JSON Packets</b></u></p>
- * <p>By default, response packets are assumed to be JSON, so a typical response
- * packet may look like this:</p><pre><code>
-{
- success: false,
- errors: {
- clientCode: "Client not found",
- portOfLoading: "This field must not be null"
- }
-}</code></pre>
- * <p>Other data may be placed into the response for processing by the {@link Ext.form.BasicForm}'s callback
- * or event handler methods. The object decoded from this JSON is available in the
- * {@link Ext.form.Action#result result} property.</p>
- * <p>Alternatively, if an {@link #errorReader} is specified as an {@link Ext.data.XmlReader XmlReader}:</p><pre><code>
- errorReader: new Ext.data.XmlReader({
- record : 'field',
- success: '@success'
- }, [
- 'id', 'msg'
- ]
- )
-</code></pre>
- * <p>then the results may be sent back in XML format:</p><pre><code>
-<?xml version="1.0" encoding="UTF-8"?>
-<message success="false">
-<errors>
- <field>
- <id>clientCode</id>
- <msg><![CDATA[Code not found. <br /><i>This is a test validation message from the server </i>]]></msg>
- </field>
- <field>
- <id>portOfLoading</id>
- <msg><![CDATA[Port not found. <br /><i>This is a test validation message from the server </i>]]></msg>
- </field>
-</errors>
-</message>
-</code></pre>
- * <p>Other elements may be placed into the response XML for processing by the {@link Ext.form.BasicForm}'s callback
- * or event handler methods. The XML document is available in the {@link #errorReader}'s {@link Ext.data.XmlReader#xmlData xmlData} property.</p>
- */
-Ext.form.Action.Submit = function(form, options){
- Ext.form.Action.Submit.superclass.constructor.call(this, form, options);
-};
-
-Ext.extend(Ext.form.Action.Submit, Ext.form.Action, {
- <div id="cfg-Ext.form.Action.Submit-errorReader"></div>/**
- * @cfg {Ext.data.DataReader} errorReader <p><b>Optional. JSON is interpreted with
- * no need for an errorReader.</b></p>
- * <p>A Reader which reads a single record from the returned data. The DataReader's
- * <b>success</b> property specifies how submission success is determined. The Record's
- * data provides the error messages to apply to any invalid form Fields.</p>
- */
- <div id="cfg-Ext.form.Action.Submit-clientValidation"></div>/**
- * @cfg {boolean} clientValidation Determines whether a Form's fields are validated
- * in a final call to {@link Ext.form.BasicForm#isValid isValid} prior to submission.
- * Pass <tt>false</tt> in the Form's submit options to prevent this. If not defined, pre-submission field validation
- * is performed.
- */
- type : 'submit',
-
- // private
- run : function(){
- var o = this.options;
- var method = this.getMethod();
- var isGet = method == 'GET';
- if(o.clientValidation === false || this.form.isValid()){
- Ext.Ajax.request(Ext.apply(this.createCallback(o), {
- form:this.form.el.dom,
- url:this.getUrl(isGet),
- method: method,
- headers: o.headers,
- params:!isGet ? this.getParams() : null,
- isUpload: this.form.fileUpload
- }));
- }else if (o.clientValidation !== false){ // client validation failed
- this.failureType = Ext.form.Action.CLIENT_INVALID;
- this.form.afterAction(this, false);
- }
- },
-
- // private
- success : function(response){
- var result = this.processResponse(response);
- if(result === true || result.success){
- this.form.afterAction(this, true);
- return;
- }
- if(result.errors){
- this.form.markInvalid(result.errors);
- this.failureType = Ext.form.Action.SERVER_INVALID;
- }
- this.form.afterAction(this, false);
- },
-
- // private
- handleResponse : function(response){
- if(this.form.errorReader){
- var rs = this.form.errorReader.read(response);
- var errors = [];
- if(rs.records){
- for(var i = 0, len = rs.records.length; i < len; i++) {
- var r = rs.records[i];
- errors[i] = r.data;
- }
- }
- if(errors.length < 1){
- errors = null;
- }
- return {
- success : rs.success,
- errors : errors
- };
- }
- return Ext.decode(response.responseText);
- }
-});
-
-
-<div id="cls-Ext.form.Action.Load"></div>/**
- * @class Ext.form.Action.Load
- * @extends Ext.form.Action
- * <p>A class which handles loading of data from a server into the Fields of an {@link Ext.form.BasicForm}.</p>
- * <p>Instances of this class are only created by a {@link Ext.form.BasicForm Form} when
- * {@link Ext.form.BasicForm#load load}ing.</p>
- * <p><u><b>Response Packet Criteria</b></u></p>
- * <p>A response packet <b>must</b> contain:
- * <div class="mdetail-params"><ul>
- * <li><b><code>success</code></b> property : Boolean</li>
- * <li><b><code>data</code></b> property : Object</li>
- * <div class="sub-desc">The <code>data</code> property contains the values of Fields to load.
- * The individual value object for each Field is passed to the Field's
- * {@link Ext.form.Field#setValue setValue} method.</div></li>
- * </ul></div>
- * <p><u><b>JSON Packets</b></u></p>
- * <p>By default, response packets are assumed to be JSON, so for the following form load call:<pre><code>
-var myFormPanel = new Ext.form.FormPanel({
- title: 'Client and routing info',
- items: [{
- fieldLabel: 'Client',
- name: 'clientName'
- }, {
- fieldLabel: 'Port of loading',
- name: 'portOfLoading'
- }, {
- fieldLabel: 'Port of discharge',
- name: 'portOfDischarge'
- }]
-});
-myFormPanel.{@link Ext.form.FormPanel#getForm getForm}().{@link Ext.form.BasicForm#load load}({
- url: '/getRoutingInfo.php',
- params: {
- consignmentRef: myConsignmentRef
- },
- failure: function(form, action() {
- Ext.Msg.alert("Load failed", action.result.errorMessage);
- }
-});
-</code></pre>
- * a <b>success response</b> packet may look like this:</p><pre><code>
-{
- success: true,
- data: {
- clientName: "Fred. Olsen Lines",
- portOfLoading: "FXT",
- portOfDischarge: "OSL"
- }
-}</code></pre>
- * while a <b>failure response</b> packet may look like this:</p><pre><code>
-{
- success: false,
- errorMessage: "Consignment reference not found"
-}</code></pre>
- * <p>Other data may be placed into the response for processing the {@link Ext.form.BasicForm Form}'s
- * callback or event handler methods. The object decoded from this JSON is available in the
- * {@link Ext.form.Action#result result} property.</p>
- */
-Ext.form.Action.Load = function(form, options){
- Ext.form.Action.Load.superclass.constructor.call(this, form, options);
- this.reader = this.form.reader;
-};
-
-Ext.extend(Ext.form.Action.Load, Ext.form.Action, {
- // private
- type : 'load',
-
- // private
- run : function(){
- Ext.Ajax.request(Ext.apply(
- this.createCallback(this.options), {
- method:this.getMethod(),
- url:this.getUrl(false),
- headers: this.options.headers,
- params:this.getParams()
- }));
- },
-
- // private
- success : function(response){
- var result = this.processResponse(response);
- if(result === true || !result.success || !result.data){
- this.failureType = Ext.form.Action.LOAD_FAILURE;
- this.form.afterAction(this, false);
- return;
- }
- this.form.clearInvalid();
- this.form.setValues(result.data);
- this.form.afterAction(this, true);
- },
-
- // private
- handleResponse : function(response){
- if(this.form.reader){
- var rs = this.form.reader.read(response);
- var data = rs.records && rs.records[0] ? rs.records[0].data : null;
- return {
- success : rs.success,
- data : data
- };
- }
- return Ext.decode(response.responseText);
- }
-});
-
-
-
-<div id="cls-Ext.form.Action.DirectLoad"></div>/**
- * @class Ext.form.Action.DirectLoad
- * @extends Ext.form.Action.Load
- * Provides Ext.direct support for loading form data. This example illustrates usage
- * of Ext.Direct to load a submit a form through Ext.Direct.
- * <pre><code>
-var myFormPanel = new Ext.form.FormPanel({
- // configs for FormPanel
- title: 'Basic Information',
- border: false,
- padding: 10,
- buttons:[{
- text: 'Submit',
- handler: function(){
- basicInfo.getForm().submit({
- params: {
- uid: 5
- }
- });
- }
- }],
-
- // configs apply to child items
- defaults: {anchor: '100%'},
- defaultType: 'textfield',
- items: [
- // form fields go here
- ],
-
- // configs for BasicForm
- api: {
- load: Profile.getBasicInfo,
- // The server-side must mark the submit handler as a 'formHandler'
- submit: Profile.updateBasicInfo
- },
- paramOrder: ['uid']
-});
-
-// load the form
-myFormPanel.getForm().load({
- params: {
- uid: 5
- }
-});
- * </code></pre>
- */
-Ext.form.Action.DirectLoad = Ext.extend(Ext.form.Action.Load, {
- constructor: function(form, opts) {
- Ext.form.Action.DirectLoad.superclass.constructor.call(this, form, opts);
- },
- type: 'directload',
-
- run : function(){
- var args = this.getParams();
- args.push(this.success, this);
- this.form.api.load.apply(window, args);
- },
-
- getParams: function() {
- var buf = [], o = {};
- var bp = this.form.baseParams;
- var p = this.options.params;
- Ext.apply(o, p, bp);
- var paramOrder = this.form.paramOrder;
- if(paramOrder){
- for(var i = 0, len = paramOrder.length; i < len; i++){
- buf.push(o[paramOrder[i]]);
- }
- }else if(this.form.paramsAsHash){
- buf.push(o);
- }
- return buf;
- },
- // Direct actions have already been processed and therefore
- // we can directly set the result; Direct Actions do not have
- // a this.response property.
- processResponse: function(result) {
- this.result = result;
- return result;
- }
-});
-
-<div id="cls-Ext.form.Action.DirectSubmit"></div>/**
- * @class Ext.form.Action.DirectSubmit
- * @extends Ext.form.Action.Submit
- * Provides Ext.direct support for submitting form data.
- * See {@link Ext.form.Action.DirectLoad}.
- */
-Ext.form.Action.DirectSubmit = Ext.extend(Ext.form.Action.Submit, {
- constructor: function(form, opts) {
- Ext.form.Action.DirectSubmit.superclass.constructor.call(this, form, opts);
- },
- type: 'directsubmit',
- // override of Submit
- run : function(){
- var o = this.options;
- if(o.clientValidation === false || this.form.isValid()){
- // tag on any additional params to be posted in the
- // form scope
- this.success.params = this.getParams();
- this.form.api.submit(this.form.el.dom, this.success, this);
- }else if (o.clientValidation !== false){ // client validation failed
- this.failureType = Ext.form.Action.CLIENT_INVALID;
- this.form.afterAction(this, false);
- }
- },
-
- getParams: function() {
- var o = {};
- var bp = this.form.baseParams;
- var p = this.options.params;
- Ext.apply(o, p, bp);
- return o;
- },
- // Direct actions have already been processed and therefore
- // we can directly set the result; Direct Actions do not have
- // a this.response property.
- processResponse: function(result) {
- this.result = result;
- return result;
- }
-});
-
-
-Ext.form.Action.ACTION_TYPES = {
- 'load' : Ext.form.Action.Load,
- 'submit' : Ext.form.Action.Submit,
- 'directload': Ext.form.Action.DirectLoad,
- 'directsubmit': Ext.form.Action.DirectSubmit
-};
+ <pre class="prettyprint lang-js"><div id="cls-Ext.Action"></div>/**\r
+ * @class Ext.Action\r
+ * <p>An Action is a piece of reusable functionality that can be abstracted out of any particular component so that it\r
+ * can be usefully shared among multiple components. Actions let you share handlers, configuration options and UI\r
+ * updates across any components that support the Action interface (primarily {@link Ext.Toolbar}, {@link Ext.Button}\r
+ * and {@link Ext.menu.Menu} components).</p>\r
+ * <p>Aside from supporting the config object interface, any component that needs to use Actions must also support\r
+ * the following method list, as these will be called as needed by the Action class: setText(string), setIconCls(string),\r
+ * setDisabled(boolean), setVisible(boolean) and setHandler(function).</p>\r
+ * Example usage:<br>\r
+ * <pre><code>\r
+// Define the shared action. Each component below will have the same\r
+// display text and icon, and will display the same message on click.\r
+var action = new Ext.Action({\r
+ {@link #text}: 'Do something',\r
+ {@link #handler}: function(){\r
+ Ext.Msg.alert('Click', 'You did something.');\r
+ },\r
+ {@link #iconCls}: 'do-something',\r
+ {@link #itemId}: 'myAction'\r
+});\r
+\r
+var panel = new Ext.Panel({\r
+ title: 'Actions',\r
+ width: 500,\r
+ height: 300,\r
+ tbar: [\r
+ // Add the action directly to a toolbar as a menu button\r
+ action,\r
+ {\r
+ text: 'Action Menu',\r
+ // Add the action to a menu as a text item\r
+ menu: [action]\r
+ }\r
+ ],\r
+ items: [\r
+ // Add the action to the panel body as a standard button\r
+ new Ext.Button(action)\r
+ ],\r
+ renderTo: Ext.getBody()\r
+});\r
+\r
+// Change the text for all components using the action\r
+action.setText('Something else');\r
+\r
+// Reference an action through a container using the itemId\r
+var btn = panel.getComponent('myAction');\r
+var aRef = btn.baseAction;\r
+aRef.setText('New text');\r
+</code></pre>\r
+ * @constructor\r
+ * @param {Object} config The configuration options\r
+ */\r
+Ext.Action = Ext.extend(Object, {\r
+ <div id="cfg-Ext.Action-text"></div>/**\r
+ * @cfg {String} text The text to set for all components using this action (defaults to '').\r
+ */\r
+ <div id="cfg-Ext.Action-iconCls"></div>/**\r
+ * @cfg {String} iconCls\r
+ * The CSS class selector that specifies a background image to be used as the header icon for\r
+ * all components using this action (defaults to '').\r
+ * <p>An example of specifying a custom icon class would be something like:\r
+ * </p><pre><code>\r
+// specify the property in the config for the class:\r
+ ...\r
+ iconCls: 'do-something'\r
+\r
+// css class that specifies background image to be used as the icon image:\r
+.do-something { background-image: url(../images/my-icon.gif) 0 6px no-repeat !important; }\r
+</code></pre>\r
+ */\r
+ <div id="cfg-Ext.Action-disabled"></div>/**\r
+ * @cfg {Boolean} disabled True to disable all components using this action, false to enable them (defaults to false).\r
+ */\r
+ <div id="cfg-Ext.Action-hidden"></div>/**\r
+ * @cfg {Boolean} hidden True to hide all components using this action, false to show them (defaults to false).\r
+ */\r
+ <div id="cfg-Ext.Action-handler"></div>/**\r
+ * @cfg {Function} handler The function that will be invoked by each component tied to this action\r
+ * when the component's primary event is triggered (defaults to undefined).\r
+ */\r
+ <div id="cfg-Ext.Action-itemId"></div>/**\r
+ * @cfg {String} itemId\r
+ * See {@link Ext.Component}.{@link Ext.Component#itemId itemId}.\r
+ */\r
+ <div id="cfg-Ext.Action-scope"></div>/**\r
+ * @cfg {Object} scope The scope (<tt><b>this</b></tt> reference) in which the\r
+ * <code>{@link #handler}</code> is executed. Defaults to this Button.\r
+ */\r
+\r
+ constructor : function(config){\r
+ this.initialConfig = config;\r
+ this.itemId = config.itemId = (config.itemId || config.id || Ext.id());\r
+ this.items = [];\r
+ },\r
+ \r
+ // private\r
+ isAction : true,\r
+\r
+ <div id="method-Ext.Action-setText"></div>/**\r
+ * Sets the text to be displayed by all components using this action.\r
+ * @param {String} text The text to display\r
+ */\r
+ setText : function(text){\r
+ this.initialConfig.text = text;\r
+ this.callEach('setText', [text]);\r
+ },\r
+\r
+ <div id="method-Ext.Action-getText"></div>/**\r
+ * Gets the text currently displayed by all components using this action.\r
+ */\r
+ getText : function(){\r
+ return this.initialConfig.text;\r
+ },\r
+\r
+ <div id="method-Ext.Action-setIconClass"></div>/**\r
+ * Sets the icon CSS class for all components using this action. The class should supply\r
+ * a background image that will be used as the icon image.\r
+ * @param {String} cls The CSS class supplying the icon image\r
+ */\r
+ setIconClass : function(cls){\r
+ this.initialConfig.iconCls = cls;\r
+ this.callEach('setIconClass', [cls]);\r
+ },\r
+\r
+ <div id="method-Ext.Action-getIconClass"></div>/**\r
+ * Gets the icon CSS class currently used by all components using this action.\r
+ */\r
+ getIconClass : function(){\r
+ return this.initialConfig.iconCls;\r
+ },\r
+\r
+ <div id="method-Ext.Action-setDisabled"></div>/**\r
+ * Sets the disabled state of all components using this action. Shortcut method\r
+ * for {@link #enable} and {@link #disable}.\r
+ * @param {Boolean} disabled True to disable the component, false to enable it\r
+ */\r
+ setDisabled : function(v){\r
+ this.initialConfig.disabled = v;\r
+ this.callEach('setDisabled', [v]);\r
+ },\r
+\r
+ <div id="method-Ext.Action-enable"></div>/**\r
+ * Enables all components using this action.\r
+ */\r
+ enable : function(){\r
+ this.setDisabled(false);\r
+ },\r
+\r
+ <div id="method-Ext.Action-disable"></div>/**\r
+ * Disables all components using this action.\r
+ */\r
+ disable : function(){\r
+ this.setDisabled(true);\r
+ },\r
+\r
+ <div id="method-Ext.Action-isDisabled"></div>/**\r
+ * Returns true if the components using this action are currently disabled, else returns false. \r
+ */\r
+ isDisabled : function(){\r
+ return this.initialConfig.disabled;\r
+ },\r
+\r
+ <div id="method-Ext.Action-setHidden"></div>/**\r
+ * Sets the hidden state of all components using this action. Shortcut method\r
+ * for <code>{@link #hide}</code> and <code>{@link #show}</code>.\r
+ * @param {Boolean} hidden True to hide the component, false to show it\r
+ */\r
+ setHidden : function(v){\r
+ this.initialConfig.hidden = v;\r
+ this.callEach('setVisible', [!v]);\r
+ },\r
+\r
+ <div id="method-Ext.Action-show"></div>/**\r
+ * Shows all components using this action.\r
+ */\r
+ show : function(){\r
+ this.setHidden(false);\r
+ },\r
+\r
+ <div id="method-Ext.Action-hide"></div>/**\r
+ * Hides all components using this action.\r
+ */\r
+ hide : function(){\r
+ this.setHidden(true);\r
+ },\r
+\r
+ <div id="method-Ext.Action-isHidden"></div>/**\r
+ * Returns true if the components using this action are currently hidden, else returns false. \r
+ */\r
+ isHidden : function(){\r
+ return this.initialConfig.hidden;\r
+ },\r
+\r
+ <div id="method-Ext.Action-setHandler"></div>/**\r
+ * Sets the function that will be called by each Component using this action when its primary event is triggered.\r
+ * @param {Function} fn The function that will be invoked by the action's components. The function\r
+ * will be called with no arguments.\r
+ * @param {Object} scope The scope (<code>this</code> reference) in which the function is executed. Defaults to the Component firing the event.\r
+ */\r
+ setHandler : function(fn, scope){\r
+ this.initialConfig.handler = fn;\r
+ this.initialConfig.scope = scope;\r
+ this.callEach('setHandler', [fn, scope]);\r
+ },\r
+\r
+ <div id="method-Ext.Action-each"></div>/**\r
+ * Executes the specified function once for each Component currently tied to this action. The function passed\r
+ * in should accept a single argument that will be an object that supports the basic Action config/method interface.\r
+ * @param {Function} fn The function to execute for each component\r
+ * @param {Object} scope The scope (<code>this</code> reference) in which the function is executed. Defaults to the Component.\r
+ */\r
+ each : function(fn, scope){\r
+ Ext.each(this.items, fn, scope);\r
+ },\r
+\r
+ // private\r
+ callEach : function(fnName, args){\r
+ var cs = this.items;\r
+ for(var i = 0, len = cs.length; i < len; i++){\r
+ cs[i][fnName].apply(cs[i], args);\r
+ }\r
+ },\r
+\r
+ // private\r
+ addComponent : function(comp){\r
+ this.items.push(comp);\r
+ comp.on('destroy', this.removeComponent, this);\r
+ },\r
+\r
+ // private\r
+ removeComponent : function(comp){\r
+ this.items.remove(comp);\r
+ },\r
+\r
+ <div id="method-Ext.Action-execute"></div>/**\r
+ * Executes this action manually using the handler function specified in the original config object\r
+ * or the handler function set with <code>{@link #setHandler}</code>. Any arguments passed to this\r
+ * function will be passed on to the handler function.\r
+ * @param {Mixed} arg1 (optional) Variable number of arguments passed to the handler function\r
+ * @param {Mixed} arg2 (optional)\r
+ * @param {Mixed} etc... (optional)\r
+ */\r
+ execute : function(){\r
+ this.initialConfig.handler.apply(this.initialConfig.scope || window, arguments);\r
+ }\r
+});\r
</pre> \r
</body>\r
</html>
\ No newline at end of file
git.ithinksw.org / extjs.git / blobdiff