docs/api/Ext.form.action.Action.html

   1 <!DOCTYPE html><html><head><title>Ext.form.action.Action | Ext JS 4.0 Documentation</title><script type="text/javascript" src="../ext-all.js"></script><link rel="stylesheet" href="../reset.css" type="text/css"><link rel="stylesheet" href="../scrollbars.css" type="text/css"><link rel="stylesheet" href="../docs.css" type="text/css"><link id="styleCss" rel="stylesheet" href="../style.css" type="text/css"><script type="text/javascript" src="../prettify.js"></script><link rel="stylesheet" href="../prettify.css" type="text/css"><!-- link(rel: 'stylesheet', href: req.baseURL + '/css/ext4.css', type: 'text/css')--><link rel="shortcut icon" type="image/ico" href="../favicon.ico"><!--[if IE]>
   2 <style type="text/css">.head-band { display: none; }
   3 .header { border: 0; top: 0; left: 0px; background: url(../header.gif) repeat-x; }
   4 .doc-tab .members .member a.more { background-color: #efefef; }
   5 </style><link rel="stylesheet" href="/new/css/ie.css" type="text/css"><![endif]-->
   6 </head><body id="ext-body" class="iScroll"><div id="notice" class="notice">For up to date documentation and features, visit
   7 <a href="http://docs.sencha.com/ext-js/4-0">http://docs.sencha.com/ext-js/4-0</a></div><div class="wrapper"><div class="head-band"></div><div class="header"><h2><a href="../index.html">Sencha Documentation</a></h2></div><div id="search"><form><input type="text" placeholder="Search" id="search-field" autocomplete="off" name="q"></form><div id="search-box"></div></div><div id="treePanel"></div><div id="container"><script type="text/javascript">
   8
   9     req = {
  10         liveURL: '.',
  11         standAloneMode: true,
  12         origDocClass: 'Ext.form.action.Action',
  13         docClass: 'Ext.form.action.Action',
  14         docReq: 'Ext.form.action.Action',
  15         version: '4.0',
  16         baseURL: '.',
  17         baseDocURL: '.',
  18         baseProdURL: '.'
  19     };
  20
  21     clsInfo = {};
  22
  23
  24
  25 </script>
  26
  27 <script type="text/javascript" src="../search.js"></script>
  28 <!--script type="text/javascript" src="/new/javascripts/app/examples.js"></script-->
  29 <script type="text/javascript" src="../class_tree.js"></script>
  30 <script type="text/javascript" src="../class_doc.js"></script>
  31 <script type="text/javascript">
  32     req.source = 'Action2.html#Ext-form.action.Action';
  33     clsInfo = {"methods":["Action","callOverridden","getName"],"cfgs":["failure","form","headers","method","params","reset","scope","submitEmptyText","success","timeout","url","waitMsg","waitTitle"],"properties":["CLIENT_INVALID","CONNECT_FAILURE","LOAD_FAILURE","SERVER_INVALID","addStatics","borrow","create","createAlias","failureType","implement","override","response","result","run","type"],"events":[],"subclasses":["Ext.form.action.Load","Ext.form.action.Submit"]};
  34     Ext.onReady(function() {
  35         Ext.create('Docs.classPanel');
  36     });
  37 </script><div id="top-block" class="top-block"><h1 id="clsTitle" class="cls"><a href="../source/Action2.html#Ext-form.action.Action" target="_blank">Ext.form.action.Action</a></h1></div><div id="docContent"><div id="doc-overview-content"><div class="lft"><pre class="subclasses"><h4>Hierarchy</h4><div class="subclass f"><a href="Ext.Base.html" rel="Ext.Base" class="cls docClass">Ext.Base</a><div class="subclass"><strong>Ext.form.action.Action</strong></div></div></pre><p>The subclasses of this class provide actions to perform upon <a href="Ext.form.Basic.html" rel="Ext.form.Basic" class="docClass">Form</a>s.</p>
  38
  39
  40 <p>Instances of this class are only created by a <a href="Ext.form.Basic.html" rel="Ext.form.Basic" class="docClass">Form</a> when
  41 the Form needs to perform an action such as submit or load. The Configuration options
  42 listed for this class are set through the Form's action methods: <a href="Ext.form.Basic.html#submit" rel="Ext.form.Basic#submit" class="docClass">submit</a>,
  43 <a href="Ext.form.Basic.html#load" rel="Ext.form.Basic#load" class="docClass">load</a> and <a href="Ext.form.Basic.html#doAction" rel="Ext.form.Basic#doAction" class="docClass">doAction</a></p>
  44
  45
  46 <p>The instance of Action which performed the action is passed to the success
  47 and failure callbacks of the Form's action methods (<a href="Ext.form.Basic.html#submit" rel="Ext.form.Basic#submit" class="docClass">submit</a>,
  48 <a href="Ext.form.Basic.html#load" rel="Ext.form.Basic#load" class="docClass">load</a> and <a href="Ext.form.Basic.html#doAction" rel="Ext.form.Basic#doAction" class="docClass">doAction</a>),
  49 and to the <a href="Ext.form.Basic.html#actioncomplete" rel="Ext.form.Basic#actioncomplete" class="docClass">actioncomplete</a> and
  50 <a href="Ext.form.Basic.html#actionfailed" rel="Ext.form.Basic#actionfailed" class="docClass">actionfailed</a> event handlers.</p>
  51
  52 <div class="members"><div class="m-cfgs"><div class="definedBy">Defined By</div><a name="configs"></a><h3 class="cfg p">Config Options</h3><h4 class="cfgGroup">Other Configs</h4><div id="config-failure" class="member f ni"><a href="Ext.form.action.Action.html#config-failure" rel="config-failure" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.form.action.Action.html" class="definedIn docClass">Ext.form.action.Action</a><br/><a href="../source/Action2.html#Ext-form.action.Action-cfg-failure" class="viewSource">view source</a></div><a name="failure"></a><a name="config-failure"></a><a href="Ext.form.action.Action.html#" rel="config-failure" class="cls expand">failure</a><span> : Function</span></div><div class="description"><div class="short">The function to call when a failure packet was received, or when an
  53 error ocurred in the Ajax communication.
  54 The func...</div><div class="long"><p>The function to call when a failure packet was received, or when an
  55 error ocurred in the Ajax communication.
  56 The function is passed the following parameters:<ul class="mdetail-params">
  57 <li><b>form</b> : Ext.form.Basic<div class="sub-desc">The form that requested the action</div></li>
  58 <li><b>action</b> : Ext.form.action.Action<div class="sub-desc">The Action class. If an Ajax
  59 error ocurred, the failure type will be in <a href="Ext.form.action.Action.html#failureType" rel="Ext.form.action.Action#failureType" class="docClass">failureType</a>. The <a href="Ext.form.action.Action.html#result" rel="Ext.form.action.Action#result" class="docClass">result</a>
  60 property of this object may be examined to perform custom postprocessing.</div></li>
  61 </ul></p>
  62 </div></div></div><div id="config-form" class="member ni"><a href="Ext.form.action.Action.html#config-form" rel="config-form" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.form.action.Action.html" class="definedIn docClass">Ext.form.action.Action</a><br/><a href="../source/Action2.html#Ext-form.action.Action-cfg-form" class="viewSource">view source</a></div><a name="form"></a><a name="config-form"></a><a href="Ext.form.action.Action.html#" rel="config-form" class="cls expand">form</a><span> : Ext.form.Basic</span></div><div class="description"><div class="short"><p>The <a href="Ext.form.Basic.html" rel="Ext.form.Basic" class="docClass">BasicForm</a> instance that
  63 is invoking this Action. Required.</p>
  64 </div><div class="long"><p>The <a href="Ext.form.Basic.html" rel="Ext.form.Basic" class="docClass">BasicForm</a> instance that
  65 is invoking this Action. Required.</p>
  66 </div></div></div><div id="config-headers" class="member ni"><a href="Ext.form.action.Action.html#config-headers" rel="config-headers" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.form.action.Action.html" class="definedIn docClass">Ext.form.action.Action</a><br/><a href="../source/Action2.html#Ext-form.action.Action-cfg-headers" class="viewSource">view source</a></div><a name="headers"></a><a name="config-headers"></a><a href="Ext.form.action.Action.html#" rel="config-headers" class="cls expand">headers</a><span> : Object</span></div><div class="description"><div class="short"><p>Extra headers to be sent in the AJAX request for submit and load actions. See
  67 <a href="Ext.data.Connection.html#headers" rel="Ext.data.Connection#headers" class="docClass">Ext.data.Connection.headers</a>.</p>
  68
  69 </div><div class="long"><p>Extra headers to be sent in the AJAX request for submit and load actions. See
  70 <a href="Ext.data.Connection.html#headers" rel="Ext.data.Connection#headers" class="docClass">Ext.data.Connection.headers</a>.</p>
  71
  72 </div></div></div><div id="config-method" class="member ni"><a href="Ext.form.action.Action.html#config-method" rel="config-method" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.form.action.Action.html" class="definedIn docClass">Ext.form.action.Action</a><br/><a href="../source/Action2.html#Ext-form.action.Action-cfg-method" class="viewSource">view source</a></div><a name="method"></a><a name="config-method"></a><a href="Ext.form.action.Action.html#" rel="config-method" class="cls expand">method</a><span> : String</span></div><div class="description"><div class="short"><p>The HTTP method to use to access the requested URL. Defaults to the
  73 <a href="Ext.form.Basic.html#method" rel="Ext.form.Basic#method" class="docClass">BasicForm's method</a>, or 'POST' if not specified.</p>
  74 </div><div class="long"><p>The HTTP method to use to access the requested URL. Defaults to the
  75 <a href="Ext.form.Basic.html#method" rel="Ext.form.Basic#method" class="docClass">BasicForm's method</a>, or 'POST' if not specified.</p>
  76 </div></div></div><div id="config-params" class="member ni"><a href="Ext.form.action.Action.html#config-params" rel="config-params" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.form.action.Action.html" class="definedIn docClass">Ext.form.action.Action</a><br/><a href="../source/Action2.html#Ext-form.action.Action-cfg-params" class="viewSource">view source</a></div><a name="params"></a><a name="config-params"></a><a href="Ext.form.action.Action.html#" rel="config-params" class="cls expand">params</a><span> : Object/String</span></div><div class="description"><div class="short">Extra parameter values to pass. These are added to the Form's
  77 Ext.form.Basic.baseParams and passed to the specified U...</div><div class="long"><p>Extra parameter values to pass. These are added to the Form's
  78 <a href="Ext.form.Basic.html#baseParams" rel="Ext.form.Basic#baseParams" class="docClass">Ext.form.Basic.baseParams</a> and passed to the specified URL along with the Form's
  79 input fields.</p>
  80
  81
  82 <p>Parameters are encoded as standard HTTP parameters using <a href="Ext.html#urlEncode" rel="Ext#urlEncode" class="docClass">Ext.Object.toQueryString</a>.</p>
  83
  84 </div></div></div><div id="config-reset" class="member ni"><a href="Ext.form.action.Action.html#config-reset" rel="config-reset" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.form.action.Action.html" class="definedIn docClass">Ext.form.action.Action</a><br/><a href="../source/Action2.html#Ext-form.action.Action-cfg-reset" class="viewSource">view source</a></div><a name="reset"></a><a name="config-reset"></a><a href="Ext.form.action.Action.html#" rel="config-reset" class="cls expand">reset</a><span> : Boolean</span></div><div class="description"><div class="short">When set to true, causes the Form to be
  85 reset on Action success. If specified, this happens
  86 before the success callba...</div><div class="long"><p>When set to <tt><b>true</b></tt>, causes the Form to be
  87 <a href="Ext.form.Basic.html#reset" rel="Ext.form.Basic#reset" class="docClass">reset</a> on Action success. If specified, this happens
  88 before the <a href="Ext.form.action.Action.html#success" rel="Ext.form.action.Action#success" class="docClass">success</a> callback is called and before the Form's
  89 <a href="Ext.form.Basic.html#actioncomplete" rel="Ext.form.Basic#actioncomplete" class="docClass">actioncomplete</a> event fires.</p>
  90 </div></div></div><div id="config-scope" class="member ni"><a href="Ext.form.action.Action.html#config-scope" rel="config-scope" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.form.action.Action.html" class="definedIn docClass">Ext.form.action.Action</a><br/><a href="../source/Action2.html#Ext-form.action.Action-cfg-scope" class="viewSource">view source</a></div><a name="scope"></a><a name="config-scope"></a><a href="Ext.form.action.Action.html#" rel="config-scope" class="cls expand">scope</a><span> : Object</span></div><div class="description"><div class="short">The scope in which to call the configured success and failure
  91 callback functions (the this reference for the callback...</div><div class="long"><p>The scope in which to call the configured <tt>success</tt> and <tt>failure</tt>
  92 callback functions (the <tt>this</tt> reference for the callback functions).</p>
  93 </div></div></div><div id="config-submitEmptyText" class="member ni"><a href="Ext.form.action.Action.html#config-submitEmptyText" rel="config-submitEmptyText" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.form.action.Action.html" class="definedIn docClass">Ext.form.action.Action</a><br/><a href="../source/Action2.html#Ext-form.action.Action-cfg-submitEmptyText" class="viewSource">view source</a></div><a name="submitEmptyText"></a><a name="config-submitEmptyText"></a><a href="Ext.form.action.Action.html#" rel="config-submitEmptyText" class="cls expand">submitEmptyText</a><span> : Boolean</span></div><div class="description"><div class="short"><p>If set to <tt>true</tt>, the emptyText value will be sent with the form
  94 when it is submitted. Defaults to <tt>true</tt>.</p>
  95 </div><div class="long"><p>If set to <tt>true</tt>, the emptyText value will be sent with the form
  96 when it is submitted. Defaults to <tt>true</tt>.</p>
  97 </div></div></div><div id="config-success" class="member ni"><a href="Ext.form.action.Action.html#config-success" rel="config-success" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.form.action.Action.html" class="definedIn docClass">Ext.form.action.Action</a><br/><a href="../source/Action2.html#Ext-form.action.Action-cfg-success" class="viewSource">view source</a></div><a name="success"></a><a name="config-success"></a><a href="Ext.form.action.Action.html#" rel="config-success" class="cls expand">success</a><span> : Function</span></div><div class="description"><div class="short">The function to call when a valid success return packet is received.
  98 The function is passed the following parameters:...</div><div class="long"><p>The function to call when a valid success return packet is received.
  99 The function is passed the following parameters:<ul class="mdetail-params">
 100 <li><b>form</b> : Ext.form.Basic<div class="sub-desc">The form that requested the action</div></li>
 101 <li><b>action</b> : Ext.form.action.Action<div class="sub-desc">The Action class. The <a href="Ext.form.action.Action.html#result" rel="Ext.form.action.Action#result" class="docClass">result</a>
 102 property of this object may be examined to perform custom postprocessing.</div></li>
 103 </ul></p>
 104 </div></div></div><div id="config-timeout" class="member ni"><a href="Ext.form.action.Action.html#config-timeout" rel="config-timeout" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.form.action.Action.html" class="definedIn docClass">Ext.form.action.Action</a><br/><a href="../source/Action2.html#Ext-form.action.Action-cfg-timeout" class="viewSource">view source</a></div><a name="timeout"></a><a name="config-timeout"></a><a href="Ext.form.action.Action.html#" rel="config-timeout" class="cls expand">timeout</a><span> : Number</span></div><div class="description"><div class="short">The number of seconds to wait for a server response before
 105 failing with the failureType as CONNECT_FAILURE. If not sp...</div><div class="long"><p>The number of seconds to wait for a server response before
 106 failing with the <a href="Ext.form.action.Action.html#failureType" rel="Ext.form.action.Action#failureType" class="docClass">failureType</a> as <a href="Ext.form.action.Action.html#CONNECT_FAILURE" rel="Ext.form.action.Action#CONNECT_FAILURE" class="docClass">CONNECT_FAILURE</a>. If not specified,
 107 defaults to the configured <tt><a href="Ext.form.Basic.html#timeout" rel="Ext.form.Basic#timeout" class="docClass">timeout</a></tt> of the
 108 <a href="Ext.form.action.Action.html#form" rel="Ext.form.action.Action#form" class="docClass">form</a>.</p>
 109 </div></div></div><div id="config-url" class="member ni"><a href="Ext.form.action.Action.html#config-url" rel="config-url" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.form.action.Action.html" class="definedIn docClass">Ext.form.action.Action</a><br/><a href="../source/Action2.html#Ext-form.action.Action-cfg-url" class="viewSource">view source</a></div><a name="url"></a><a name="config-url"></a><a href="Ext.form.action.Action.html#" rel="config-url" class="cls expand">url</a><span> : String</span></div><div class="description"><div class="short"><p>The URL that the Action is to invoke. Will default to the <a href="Ext.form.Basic.html#url" rel="Ext.form.Basic#url" class="docClass">url</a>
 110 configured on the <a href="Ext.form.action.Action.html#form" rel="Ext.form.action.Action#form" class="docClass">form</a>.</p>
 111 </div><div class="long"><p>The URL that the Action is to invoke. Will default to the <a href="Ext.form.Basic.html#url" rel="Ext.form.Basic#url" class="docClass">url</a>
 112 configured on the <a href="Ext.form.action.Action.html#form" rel="Ext.form.action.Action#form" class="docClass">form</a>.</p>
 113 </div></div></div><div id="config-waitMsg" class="member ni"><a href="Ext.form.action.Action.html#config-waitMsg" rel="config-waitMsg" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.form.action.Action.html" class="definedIn docClass">Ext.form.action.Action</a><br/><a href="../source/Action2.html#Ext-form.action.Action-cfg-waitMsg" class="viewSource">view source</a></div><a name="waitMsg"></a><a name="config-waitMsg"></a><a href="Ext.form.action.Action.html#" rel="config-waitMsg" class="cls expand">waitMsg</a><span> : String</span></div><div class="description"><div class="short"><p>The message to be displayed by a call to <a href="Ext.window.MessageBox.html#wait" rel="Ext.window.MessageBox#wait" class="docClass">Ext.window.MessageBox.wait</a>
 114 during the time the action is being processed.</p>
 115 </div><div class="long"><p>The message to be displayed by a call to <a href="Ext.window.MessageBox.html#wait" rel="Ext.window.MessageBox#wait" class="docClass">Ext.window.MessageBox.wait</a>
 116 during the time the action is being processed.</p>
 117 </div></div></div><div id="config-waitTitle" class="member ni"><a href="Ext.form.action.Action.html#config-waitTitle" rel="config-waitTitle" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.form.action.Action.html" class="definedIn docClass">Ext.form.action.Action</a><br/><a href="../source/Action2.html#Ext-form.action.Action-cfg-waitTitle" class="viewSource">view source</a></div><a name="waitTitle"></a><a name="config-waitTitle"></a><a href="Ext.form.action.Action.html#" rel="config-waitTitle" class="cls expand">waitTitle</a><span> : String</span></div><div class="description"><div class="short"><p>The title to be displayed by a call to <a href="Ext.window.MessageBox.html#wait" rel="Ext.window.MessageBox#wait" class="docClass">Ext.window.MessageBox.wait</a>
 118 during the time the action is being processed.</p>
 119 </div><div class="long"><p>The title to be displayed by a call to <a href="Ext.window.MessageBox.html#wait" rel="Ext.window.MessageBox#wait" class="docClass">Ext.window.MessageBox.wait</a>
 120 during the time the action is being processed.</p>
 121 </div></div></div></div><div class="m-properties"><a name="properties"></a><div class="definedBy">Defined By</div><h3 class="prp p">Properties</h3><div id="property-CLIENT_INVALID" class="member f ni"><a href="Ext.form.action.Action.html#property-CLIENT_INVALID" rel="property-CLIENT_INVALID" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.form.action.Action.html" class="definedIn docClass">Ext.form.action.Action</a><br/><a href="../source/Action2.html#Ext-form.action.Action-property-CLIENT_INVALID" class="viewSource">view source</a></div><a name="CLIENT_INVALID"></a><a name="property-CLIENT_INVALID"></a><a href="Ext.form.action.Action.html#" rel="property-CLIENT_INVALID" class="cls expand">CLIENT_INVALID</a><span> : String</span></div><div class="description"><div class="short">Failure type returned when client side validation of the Form fails
 122 thus aborting a submit action. Client side valida...</div><div class="long"><p>Failure type returned when client side validation of the Form fails
 123 thus aborting a submit action. Client side validation is performed unless
 124 <a href="Ext.form.action.Submit.html#clientValidation" rel="Ext.form.action.Submit#clientValidation" class="docClass">Ext.form.action.Submit.clientValidation</a> is explicitly set to <tt>false</tt>.</p>
 125 </div></div></div><div id="property-CONNECT_FAILURE" class="member ni"><a href="Ext.form.action.Action.html#property-CONNECT_FAILURE" rel="property-CONNECT_FAILURE" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.form.action.Action.html" class="definedIn docClass">Ext.form.action.Action</a><br/><a href="../source/Action2.html#Ext-form.action.Action-property-CONNECT_FAILURE" class="viewSource">view source</a></div><a name="CONNECT_FAILURE"></a><a name="property-CONNECT_FAILURE"></a><a href="Ext.form.action.Action.html#" rel="property-CONNECT_FAILURE" class="cls expand">CONNECT_FAILURE</a><span> : String</span></div><div class="description"><div class="short">Failure type returned when a communication error happens when attempting
 126 to send a request to the remote server. The ...</div><div class="long"><p>Failure type returned when a communication error happens when attempting
 127 to send a request to the remote server. The <a href="Ext.form.action.Action.html#response" rel="Ext.form.action.Action#response" class="docClass">response</a> may be examined to
 128 provide further information.</p>
 129 </div></div></div><div id="property-LOAD_FAILURE" class="member ni"><a href="Ext.form.action.Action.html#property-LOAD_FAILURE" rel="property-LOAD_FAILURE" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.form.action.Action.html" class="definedIn docClass">Ext.form.action.Action</a><br/><a href="../source/Action2.html#Ext-form.action.Action-property-LOAD_FAILURE" class="viewSource">view source</a></div><a name="LOAD_FAILURE"></a><a name="property-LOAD_FAILURE"></a><a href="Ext.form.action.Action.html#" rel="property-LOAD_FAILURE" class="cls expand">LOAD_FAILURE</a><span> : String</span></div><div class="description"><div class="short">Failure type returned when the response's success
 130 property is set to false, or no field values are returned in the re...</div><div class="long"><p>Failure type returned when the response's <tt>success</tt>
 131 property is set to <tt>false</tt>, or no field values are returned in the response's
 132 <tt>data</tt> property.</p>
 133 </div></div></div><div id="property-SERVER_INVALID" class="member ni"><a href="Ext.form.action.Action.html#property-SERVER_INVALID" rel="property-SERVER_INVALID" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.form.action.Action.html" class="definedIn docClass">Ext.form.action.Action</a><br/><a href="../source/Action2.html#Ext-form.action.Action-property-SERVER_INVALID" class="viewSource">view source</a></div><a name="SERVER_INVALID"></a><a name="property-SERVER_INVALID"></a><a href="Ext.form.action.Action.html#" rel="property-SERVER_INVALID" class="cls expand">SERVER_INVALID</a><span> : String</span></div><div class="description"><div class="short">Failure type returned when server side processing fails and the result's
 134 success property is set to false.
 135
 136
 137 In the c...</div><div class="long"><p>Failure type returned when server side processing fails and the <a href="Ext.form.action.Action.html#result" rel="Ext.form.action.Action#result" class="docClass">result</a>'s
 138 <tt>success</tt> property is set to <tt>false</tt>.</p>
 139
 140
 141 <p>In the case of a form submission, field-specific error messages may be returned in the
 142 <a href="Ext.form.action.Action.html#result" rel="Ext.form.action.Action#result" class="docClass">result</a>'s <tt>errors</tt> property.</p>
 143
 144 </div></div></div><div id="property-addStatics" class="member inherited"><a href="Ext.form.action.Action.html#property-addStatics" rel="property-addStatics" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.Base.html" class="definedIn docClass">Ext.Base</a><br/><a href="../source/Base3.html#Ext-Base-property-addStatics" class="viewSource">view source</a></div><a name="addStatics"></a><a name="property-addStatics"></a><a href="Ext.form.action.Action.html#" rel="property-addStatics" class="cls expand">addStatics</a><span> : Function</span></div><div class="description"><div class="short">Add / override static properties of this class.
 145
 146 Ext.define('My.cool.Class', {
 147     ...
 148 });
 149
 150 My.cool.Class.addStatics(...</div><div class="long"><p>Add / override static properties of this class.</p>
 151
 152 <pre><code>Ext.define('My.cool.Class', {
 153     ...
 154 });
 155
 156 My.cool.Class.addStatics({
 157     someProperty: 'someValue',      // My.cool.Class.someProperty = 'someValue'
 158     method1: function() { ... },    // My.cool.Class.method1 = function() { ... };
 159     method2: function() { ... }     // My.cool.Class.method2 = function() { ... };
 160 });
 161 </code></pre>
 162 </div></div></div><div id="property-borrow" class="member inherited"><a href="Ext.form.action.Action.html#property-borrow" rel="property-borrow" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.Base.html" class="definedIn docClass">Ext.Base</a><br/><a href="../source/Base3.html#Ext-Base-property-borrow" class="viewSource">view source</a></div><a name="borrow"></a><a name="property-borrow"></a><a href="Ext.form.action.Action.html#" rel="property-borrow" class="cls expand">borrow</a><span> : Function</span></div><div class="description"><div class="short">Borrow another class' members to the prototype of this class.
 163
 164 Ext.define('Bank', {
 165
 166 money: '$$$',
 167 printMoney: functi...</div><div class="long"><p>Borrow another class' members to the prototype of this class.</p>
 168
 169 <p>Ext.define('Bank', {</p>
 170
 171 <pre><code>money: '$$$',
 172 printMoney: function() {
 173     alert('$$$$$$$');
 174 }
 175 </code></pre>
 176
 177 <p>});</p>
 178
 179 <p>Ext.define('Thief', {</p>
 180
 181 <pre><code>...
 182 </code></pre>
 183
 184 <p>});</p>
 185
 186 <p>Thief.borrow(Bank, ['money', 'printMoney']);</p>
 187
 188 <p>var steve = new Thief();</p>
 189
 190 <p>alert(steve.money); // alerts '$$$'
 191 steve.printMoney(); // alerts '$$$$$$$'</p>
 192 </div></div></div><div id="property-create" class="member inherited"><a href="Ext.form.action.Action.html#property-create" rel="property-create" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.Base.html" class="definedIn docClass">Ext.Base</a><br/><a href="../source/Base3.html#Ext-Base-property-create" class="viewSource">view source</a></div><a name="create"></a><a name="property-create"></a><a href="Ext.form.action.Action.html#" rel="property-create" class="cls expand">create</a><span> : Function</span></div><div class="description"><div class="short">Create a new instance of this Class.
 193 Ext.define('My.cool.Class', {
 194
 195 ...
 196
 197
 198 });
 199
 200 My.cool.Class.create({
 201
 202 someConfig: tr...</div><div class="long"><p>Create a new instance of this Class.
 203 Ext.define('My.cool.Class', {</p>
 204
 205 <pre><code>...
 206 </code></pre>
 207
 208 <p>});</p>
 209
 210 <p>My.cool.Class.create({</p>
 211
 212 <pre><code>someConfig: true
 213 </code></pre>
 214
 215 <p>});</p>
 216 </div></div></div><div id="property-createAlias" class="member inherited"><a href="Ext.form.action.Action.html#property-createAlias" rel="property-createAlias" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.Base.html" class="definedIn docClass">Ext.Base</a><br/><a href="../source/Base3.html#Ext-Base-property-createAlias" class="viewSource">view source</a></div><a name="createAlias"></a><a name="property-createAlias"></a><a href="Ext.form.action.Action.html#" rel="property-createAlias" class="cls expand">createAlias</a><span> : Function</span></div><div class="description"><div class="short">Create aliases for existing prototype methods. Example:
 217
 218 Ext.define('My.cool.Class', {
 219     method1: function() { ... ...</div><div class="long"><p>Create aliases for existing prototype methods. Example:</p>
 220
 221 <pre><code>Ext.define('My.cool.Class', {
 222     method1: function() { ... },
 223     method2: function() { ... }
 224 });
 225
 226 var test = new My.cool.Class();
 227
 228 My.cool.Class.createAlias({
 229     method3: 'method1',
 230     method4: 'method2'
 231 });
 232
 233 test.method3(); // test.method1()
 234
 235 My.cool.Class.createAlias('method5', 'method3');
 236
 237 test.method5(); // test.method3() -&gt; test.method1()
 238 </code></pre>
 239 </div></div></div><div id="property-failureType" class="member ni"><a href="Ext.form.action.Action.html#property-failureType" rel="property-failureType" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.form.action.Action.html" class="definedIn docClass">Ext.form.action.Action</a><br/><a href="../source/Action2.html#Ext-form.action.Action-property-failureType" class="viewSource">view source</a></div><a name="failureType"></a><a name="property-failureType"></a><a href="Ext.form.action.Action.html#" rel="property-failureType" class="cls expand">failureType</a><span> : String</span></div><div class="description"><div class="short">The type of failure detected will be one of these: CLIENT_INVALID,
 240 SERVER_INVALID, CONNECT_FAILURE, or
 241 LOAD_FAILURE. ...</div><div class="long"><p>The type of failure detected will be one of these: <a href="Ext.form.action.Action.html#CLIENT_INVALID" rel="Ext.form.action.Action#CLIENT_INVALID" class="docClass">CLIENT_INVALID</a>,
 242 <a href="Ext.form.action.Action.html#SERVER_INVALID" rel="Ext.form.action.Action#SERVER_INVALID" class="docClass">SERVER_INVALID</a>, <a href="Ext.form.action.Action.html#CONNECT_FAILURE" rel="Ext.form.action.Action#CONNECT_FAILURE" class="docClass">CONNECT_FAILURE</a>, or
 243 <a href="Ext.form.action.Action.html#LOAD_FAILURE" rel="Ext.form.action.Action#LOAD_FAILURE" class="docClass">LOAD_FAILURE</a>.  Usage:</p>
 244
 245 <pre><code>var fp = new Ext.form.Panel({
 246 ...
 247 buttons: [{
 248     text: 'Save',
 249     formBind: true,
 250     handler: function(){
 251         if(fp.getForm().isValid()){
 252             fp.getForm().submit({
 253                 url: 'form-submit.php',
 254                 waitMsg: 'Submitting your data...',
 255                 success: function(form, action){
 256                     // server responded with success = true
 257                     var result = action.<a href="Ext.form.action.Action.html#result" rel="Ext.form.action.Action#result" class="docClass">result</a>;
 258                 },
 259                 failure: function(form, action){
 260                     if (action.<a href="Ext.form.action.Action.html#failureType" rel="Ext.form.action.Action#failureType" class="docClass">failureType</a> === <a href="Ext.form.action.Action.html#CONNECT_FAILURE" rel="Ext.form.action.Action#CONNECT_FAILURE" class="docClass">CONNECT_FAILURE</a>) {
 261                         Ext.Msg.alert('Error',
 262                             'Status:'+action.<a href="Ext.form.action.Action.html#response" rel="Ext.form.action.Action#response" class="docClass">response</a>.status+': '+
 263                             action.<a href="Ext.form.action.Action.html#response" rel="Ext.form.action.Action#response" class="docClass">response</a>.statusText);
 264                     }
 265                     if (action.failureType === <a href="Ext.form.action.Action.html#SERVER_INVALID" rel="Ext.form.action.Action#SERVER_INVALID" class="docClass">SERVER_INVALID</a>){
 266                         // server responded with success = false
 267                         Ext.Msg.alert('Invalid', action.<a href="Ext.form.action.Action.html#result" rel="Ext.form.action.Action#result" class="docClass">result</a>.errormsg);
 268                     }
 269                 }
 270             });
 271         }
 272     }
 273 },{
 274     text: 'Reset',
 275     handler: function(){
 276         fp.getForm().reset();
 277     }
 278 }]
 279 </code></pre>
 280
 281 </div></div></div><div id="property-implement" class="member inherited"><a href="Ext.form.action.Action.html#property-implement" rel="property-implement" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.Base.html" class="definedIn docClass">Ext.Base</a><br/><a href="../source/Base3.html#Ext-Base-property-implement" class="viewSource">view source</a></div><a name="implement"></a><a name="property-implement"></a><a href="Ext.form.action.Action.html#" rel="property-implement" class="cls expand">implement</a><span> : Function</span></div><div class="description"><div class="short">Add methods / properties to the prototype of this class.
 282
 283 Ext.define('My.awesome.Cat', {
 284     constructor: function() ...</div><div class="long"><p>Add methods / properties to the prototype of this class.</p>
 285
 286 <pre><code>Ext.define('My.awesome.Cat', {
 287     constructor: function() {
 288         ...
 289     }
 290 });
 291
 292  My.awesome.Cat.implement({
 293      meow: function() {
 294         alert('Meowww...');
 295      }
 296  });
 297
 298  var kitty = new My.awesome.Cat;
 299  kitty.meow();
 300 </code></pre>
 301 </div></div></div><div id="property-override" class="member inherited"><a href="Ext.form.action.Action.html#property-override" rel="property-override" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.Base.html" class="definedIn docClass">Ext.Base</a><br/><a href="../source/Base3.html#Ext-Base-property-override" class="viewSource">view source</a></div><a name="override"></a><a name="property-override"></a><a href="Ext.form.action.Action.html#" rel="property-override" class="cls expand">override</a><span> : Function</span></div><div class="description"><div class="short">Override prototype members of this class. Overridden methods can be invoked via
 302 Ext.Base.callOverridden
 303
 304 Ext.define('...</div><div class="long"><p>Override prototype members of this class. Overridden methods can be invoked via
 305 <a href="Ext.Base.html#callOverridden" rel="Ext.Base#callOverridden" class="docClass">Ext.Base.callOverridden</a></p>
 306
 307 <pre><code>Ext.define('My.Cat', {
 308     constructor: function() {
 309         alert("I'm a cat!");
 310
 311         return this;
 312     }
 313 });
 314
 315 My.Cat.override({
 316     constructor: function() {
 317         alert("I'm going to be a cat!");
 318
 319         var instance = this.callOverridden();
 320
 321         alert("Meeeeoooowwww");
 322
 323         return instance;
 324     }
 325 });
 326
 327 var kitty = new My.Cat(); // alerts "I'm going to be a cat!"
 328                           // alerts "I'm a cat!"
 329                           // alerts "Meeeeoooowwww"
 330 </code></pre>
 331 </div></div></div><div id="property-response" class="member ni"><a href="Ext.form.action.Action.html#property-response" rel="property-response" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.form.action.Action.html" class="definedIn docClass">Ext.form.action.Action</a><br/><a href="../source/Action2.html#Ext-form.action.Action-property-response" class="viewSource">view source</a></div><a name="response"></a><a name="property-response"></a><a href="Ext.form.action.Action.html#" rel="property-response" class="cls expand">response</a><span> : Object</span></div><div class="description"><div class="short"><p>The raw XMLHttpRequest object used to perform the action.</p>
 332 </div><div class="long"><p>The raw XMLHttpRequest object used to perform the action.</p>
 333 </div></div></div><div id="property-result" class="member ni"><a href="Ext.form.action.Action.html#property-result" rel="property-result" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.form.action.Action.html" class="definedIn docClass">Ext.form.action.Action</a><br/><a href="../source/Action2.html#Ext-form.action.Action-property-result" class="viewSource">view source</a></div><a name="result"></a><a name="property-result"></a><a href="Ext.form.action.Action.html#" rel="property-result" class="cls expand">result</a><span> : Object</span></div><div class="description"><div class="short"><p>The decoded response object containing a boolean <tt>success</tt> property and
 334 other, action-specific properties.</p>
 335 </div><div class="long"><p>The decoded response object containing a boolean <tt>success</tt> property and
 336 other, action-specific properties.</p>
 337 </div></div></div><div id="property-run" class="member ni"><a href="Ext.form.action.Action.html#property-run" rel="property-run" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.form.action.Action.html" class="definedIn docClass">Ext.form.action.Action</a><br/><a href="../source/Action2.html#Ext-form.action.Action-property-run" class="viewSource">view source</a></div><a name="run"></a><a name="property-run"></a><a href="Ext.form.action.Action.html#" rel="property-run" class="cls expand">run</a><span> : Object</span></div><div class="description"><div class="short"><p>Invokes this action using the current configuration.</p>
 338 </div><div class="long"><p>Invokes this action using the current configuration.</p>
 339 </div></div></div><div id="property-type" class="member ni"><a href="Ext.form.action.Action.html#property-type" rel="property-type" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.form.action.Action.html" class="definedIn docClass">Ext.form.action.Action</a><br/><a href="../source/Action2.html#Ext-form.action.Action-property-type" class="viewSource">view source</a></div><a name="type"></a><a name="property-type"></a><a href="Ext.form.action.Action.html#" rel="property-type" class="cls expand">type</a><span> : String</span></div><div class="description"><div class="short"><p>The type of action this Action instance performs.
 340 Currently only "submit" and "load" are supported.</p>
 341 </div><div class="long"><p>The type of action this Action instance performs.
 342 Currently only "submit" and "load" are supported.</p>
 343 </div></div></div></div><div class="m-methods"><a name="methods"></a><div class="definedBy">Defined By</div><h3 class="mth p">Methods</h3><div id="method-Action" class="member f ni"><a href="Ext.form.action.Action.html#method-Action" rel="method-Action" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.form.action.Action.html" class="definedIn docClass">Ext.form.action.Action</a><br/><a href="../source/Action2.html#Ext-form.action.Action-method-constructor" class="viewSource">view source</a></div><a name="Action"></a><a name="method-Action"></a><a href="Ext.form.action.Action.html#" rel="method-Action" class="cls expand">Action</a>(
 344 <span class="pre">Object config</span>)
 345  : void</div><div class="description"><div class="short"><p>&nbsp;</p></div><div class="long">
 346 <h3 class="pa">Parameters</h3><ul><li><span class="pre">config</span> : Object<div class="sub-desc"><p>The configuration for this instance.</p>
 347 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
 348 </li></ul></div></div></div><div id="method-callOverridden" class="member inherited"><a href="Ext.form.action.Action.html#method-callOverridden" rel="method-callOverridden" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.Base.html" class="definedIn docClass">Ext.Base</a><br/><a href="../source/Base3.html#Ext-Base-method-callOverridden" class="viewSource">view source</a></div><a name="callOverridden"></a><a name="method-callOverridden"></a><a href="Ext.form.action.Action.html#" rel="method-callOverridden" class="cls expand">callOverridden</a>(
 349 <span class="pre">Array/Arguments args</span>)
 350  : Mixed</div><div class="description"><div class="short">Call the original method that was previously overridden with Ext.Base.override
 351
 352 Ext.define('My.Cat', {
 353     constructo...</div><div class="long"><p>Call the original method that was previously overridden with <a href="Ext.Base.html#override" rel="Ext.Base#override" class="docClass">Ext.Base.override</a></p>
 354
 355 <pre><code>Ext.define('My.Cat', {
 356     constructor: function() {
 357         alert("I'm a cat!");
 358
 359         return this;
 360     }
 361 });
 362
 363 My.Cat.override({
 364     constructor: function() {
 365         alert("I'm going to be a cat!");
 366
 367         var instance = this.callOverridden();
 368
 369         alert("Meeeeoooowwww");
 370
 371         return instance;
 372     }
 373 });
 374
 375 var kitty = new My.Cat(); // alerts "I'm going to be a cat!"
 376                           // alerts "I'm a cat!"
 377                           // alerts "Meeeeoooowwww"
 378 </code></pre>
 379 <h3 class="pa">Parameters</h3><ul><li><span class="pre">args</span> : Array/Arguments<div class="sub-desc"><p>The arguments, either an array or the <code>arguments</code> object</p>
 380 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">Mixed</span>&nbsp; &nbsp;<p>Returns the result after calling the overridden method</p>
 381 </li></ul></div></div></div><div id="method-getName" class="member inherited"><a href="Ext.form.action.Action.html#method-getName" rel="method-getName" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.Base.html" class="definedIn docClass">Ext.Base</a><br/><a href="../source/Base3.html#Ext-Base-method-getName" class="viewSource">view source</a></div><a name="getName"></a><a name="method-getName"></a><a href="Ext.form.action.Action.html#" rel="method-getName" class="cls expand">getName</a> : String</div><div class="description"><div class="short">Get the current class' name in string format.
 382
 383 Ext.define('My.cool.Class', {
 384     constructor: function() {
 385         al...</div><div class="long"><p>Get the current class' name in string format.</p>
 386
 387 <pre><code>Ext.define('My.cool.Class', {
 388     constructor: function() {
 389         alert(this.self.getName()); // alerts 'My.cool.Class'
 390     }
 391 });
 392
 393 My.cool.Class.getName(); // 'My.cool.Class'
 394 </code></pre>
 395 <h3 class="pa">Returns</h3><ul><li><span class="pre">String</span>&nbsp; &nbsp;<p>className</p>
 396 </li></ul></div></div></div></div></div></div></div><div id="pageContent"></div></div></div></div></body></html>