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

   1 <!DOCTYPE html><html><head><title>Ext.form.action.Submit | 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.Submit',
  13         docClass: 'Ext.form.action.Submit',
  14         docReq: 'Ext.form.action.Submit',
  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 = 'Submit.html#Ext-form.action.Submit';
  33     clsInfo = {"methods":["Submit","callOverridden","getName"],"cfgs":["clientValidation","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.DirectSubmit","Ext.form.action.StandardSubmit"]};
  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/Submit.html#Ext-form.action.Submit" target="_blank">Ext.form.action.Submit</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"><a href="Ext.form.action.Action.html" rel="Ext.form.action.Action" class="cls docClass">Ext.form.action.Action</a><div class="subclass"><strong>Ext.form.action.Submit</strong></div></div></div></pre><p>A class which handles submission of data from <a href="Ext.form.Basic.html" rel="Ext.form.Basic" class="docClass">Form</a>s
  38 and processes the returned response.</p>
  39
  40
  41 <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
  42 <a href="Ext.form.Basic.html#submit" rel="Ext.form.Basic#submit" class="docClass">submit</a>ting.</p>
  43
  44
  45 <p><u><b>Response Packet Criteria</b></u></p>
  46
  47
  48 <p>A response packet may contain:
  49 <div class="mdetail-params"><ul>
  50 <li><b><code>success</code></b> property : Boolean
  51 <div class="sub-desc">The <code>success</code> property is required.</div></li>
  52 <li><b><code>errors</code></b> property : Object
  53 <div class="sub-desc"><div class="sub-desc">The <code>errors</code> property,
  54 which is optional, contains error messages for invalid fields.</div></li>
  55 </ul></div>
  56 <p><u><b>JSON Packets</b></u></p>
  57 <p>By default, response packets are assumed to be JSON, so a typical response
  58 packet may look like this:</p>
  59 <pre class="prettyprint"><code>{
  60     success: false,
  61     errors: {
  62         clientCode: "Client not found",
  63         portOfLoading: "This field must not be null"
  64     }
  65 }</code></pre>
  66 <p>Other data may be placed into the response for processing by the <a href="Ext.form.Basic.html" rel="Ext.form.Basic" class="docClass">Ext.form.Basic</a>'s callback
  67 or event handler methods. The object decoded from this JSON is available in the
  68 <a href="Ext.form.action.Action.html#result" rel="Ext.form.action.Action#result" class="docClass">result</a> property.</p>
  69 <p>Alternatively, if an <a href="Ext.form.action.Submit.html#errorReader" rel="Ext.form.action.Submit#errorReader" class="docClass">errorReader</a> is specified as an <a href="Ext.data.reader.Xml.html" rel="Ext.data.reader.Xml" class="docClass">XmlReader</a>:</p>
  70 <pre class="prettyprint"><code>    errorReader: new Ext.data.reader.Xml({
  71             record : 'field',
  72             success: '@success'
  73         }, [
  74             'id', 'msg'
  75         ]
  76     )
  77 </code></pre>
  78 <p>then the results may be sent back in XML format:</p>
  79 <pre class="prettyprint"><code>&lt;?xml version="1.0" encoding="UTF-8"?&gt;
  80 &lt;message success="false"&gt;
  81 &lt;errors&gt;
  82     &lt;field&gt;
  83         &lt;id&gt;clientCode&lt;/id&gt;
  84         &lt;msg&gt;&lt;![CDATA[Code not found. &lt;br /&gt;&lt;i&gt;This is a test validation message from the server &lt;/i&gt;]]&gt;&lt;/msg&gt;
  85     &lt;/field&gt;
  86     &lt;field&gt;
  87         &lt;id&gt;portOfLoading&lt;/id&gt;
  88         &lt;msg&gt;&lt;![CDATA[Port not found. &lt;br /&gt;&lt;i&gt;This is a test validation message from the server &lt;/i&gt;]]&gt;&lt;/msg&gt;
  89     &lt;/field&gt;
  90 &lt;/errors&gt;
  91 &lt;/message&gt;
  92 </code></pre>
  93 <p>Other elements may be placed into the response XML for processing by the <a href="Ext.form.Basic.html" rel="Ext.form.Basic" class="docClass">Ext.form.Basic</a>'s callback
  94 or event handler methods. The XML document is available in the <a href="Ext.form.action.Submit.html#errorReader" rel="Ext.form.action.Submit#errorReader" class="docClass">errorReader</a>'s <a href="Ext.data.reader.Xml.html#xmlData" rel="Ext.data.reader.Xml#xmlData" class="docClass">xmlData</a> property.</p>
  95
  96 <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-clientValidation" class="member f ni"><a href="Ext.form.action.Submit.html#config-clientValidation" rel="config-clientValidation" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.form.action.Submit.html" class="definedIn docClass">Ext.form.action.Submit</a><br/><a href="../source/Submit.html#Ext-form.action.Submit-cfg-clientValidation" class="viewSource">view source</a></div><a name="clientValidation"></a><a name="config-clientValidation"></a><a href="Ext.form.action.Submit.html#" rel="config-clientValidation" class="cls expand">clientValidation</a><span> : boolean</span></div><div class="description"><div class="short">Determines whether a Form's fields are validated
  97 in a final call to isValid prior to submission.
  98 Pass false in the Fo...</div><div class="long"><p>Determines whether a Form's fields are validated
  99 in a final call to <a href="Ext.form.Basic.html#isValid" rel="Ext.form.Basic#isValid" class="docClass">isValid</a> prior to submission.
 100 Pass <tt>false</tt> in the Form's submit options to prevent this. Defaults to true.</p>
 101 </div></div></div><div id="config-failure" class="member inherited"><a href="Ext.form.action.Submit.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.Submit.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
 102 error ocurred in the Ajax communication.
 103 The func...</div><div class="long"><p>The function to call when a failure packet was received, or when an
 104 error ocurred in the Ajax communication.
 105 The function is passed the following parameters:<ul class="mdetail-params">
 106 <li><b>form</b> : Ext.form.Basic<div class="sub-desc">The form that requested the action</div></li>
 107 <li><b>action</b> : Ext.form.action.Action<div class="sub-desc">The Action class. If an Ajax
 108 error ocurred, the failure type will be in <a href="Ext.form.action.Submit.html#failureType" rel="Ext.form.action.Submit#failureType" class="docClass">failureType</a>. The <a href="Ext.form.action.Submit.html#result" rel="Ext.form.action.Submit#result" class="docClass">result</a>
 109 property of this object may be examined to perform custom postprocessing.</div></li>
 110 </ul></p>
 111 </div></div></div><div id="config-form" class="member inherited"><a href="Ext.form.action.Submit.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.Submit.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
 112 is invoking this Action. Required.</p>
 113 </div><div class="long"><p>The <a href="Ext.form.Basic.html" rel="Ext.form.Basic" class="docClass">BasicForm</a> instance that
 114 is invoking this Action. Required.</p>
 115 </div></div></div><div id="config-headers" class="member inherited"><a href="Ext.form.action.Submit.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.Submit.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
 116 <a href="Ext.data.Connection.html#headers" rel="Ext.data.Connection#headers" class="docClass">Ext.data.Connection.headers</a>.</p>
 117
 118 </div><div class="long"><p>Extra headers to be sent in the AJAX request for submit and load actions. See
 119 <a href="Ext.data.Connection.html#headers" rel="Ext.data.Connection#headers" class="docClass">Ext.data.Connection.headers</a>.</p>
 120
 121 </div></div></div><div id="config-method" class="member inherited"><a href="Ext.form.action.Submit.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.Submit.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
 122 <a href="Ext.form.Basic.html#method" rel="Ext.form.Basic#method" class="docClass">BasicForm's method</a>, or 'POST' if not specified.</p>
 123 </div><div class="long"><p>The HTTP method to use to access the requested URL. Defaults to the
 124 <a href="Ext.form.Basic.html#method" rel="Ext.form.Basic#method" class="docClass">BasicForm's method</a>, or 'POST' if not specified.</p>
 125 </div></div></div><div id="config-params" class="member inherited"><a href="Ext.form.action.Submit.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.Submit.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
 126 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
 127 <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
 128 input fields.</p>
 129
 130
 131 <p>Parameters are encoded as standard HTTP parameters using <a href="Ext.html#urlEncode" rel="Ext#urlEncode" class="docClass">Ext.Object.toQueryString</a>.</p>
 132
 133 </div></div></div><div id="config-reset" class="member inherited"><a href="Ext.form.action.Submit.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.Submit.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
 134 reset on Action success. If specified, this happens
 135 before the success callba...</div><div class="long"><p>When set to <tt><b>true</b></tt>, causes the Form to be
 136 <a href="Ext.form.Basic.html#reset" rel="Ext.form.Basic#reset" class="docClass">reset</a> on Action success. If specified, this happens
 137 before the <a href="Ext.form.action.Submit.html#success" rel="Ext.form.action.Submit#success" class="docClass">success</a> callback is called and before the Form's
 138 <a href="Ext.form.Basic.html#actioncomplete" rel="Ext.form.Basic#actioncomplete" class="docClass">actioncomplete</a> event fires.</p>
 139 </div></div></div><div id="config-scope" class="member inherited"><a href="Ext.form.action.Submit.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.Submit.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
 140 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>
 141 callback functions (the <tt>this</tt> reference for the callback functions).</p>
 142 </div></div></div><div id="config-submitEmptyText" class="member inherited"><a href="Ext.form.action.Submit.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.Submit.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
 143 when it is submitted. Defaults to <tt>true</tt>.</p>
 144 </div><div class="long"><p>If set to <tt>true</tt>, the emptyText value will be sent with the form
 145 when it is submitted. Defaults to <tt>true</tt>.</p>
 146 </div></div></div><div id="config-success" class="member inherited"><a href="Ext.form.action.Submit.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.Submit.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.
 147 The function is passed the following parameters:...</div><div class="long"><p>The function to call when a valid success return packet is received.
 148 The function is passed the following parameters:<ul class="mdetail-params">
 149 <li><b>form</b> : Ext.form.Basic<div class="sub-desc">The form that requested the action</div></li>
 150 <li><b>action</b> : Ext.form.action.Action<div class="sub-desc">The Action class. The <a href="Ext.form.action.Submit.html#result" rel="Ext.form.action.Submit#result" class="docClass">result</a>
 151 property of this object may be examined to perform custom postprocessing.</div></li>
 152 </ul></p>
 153 </div></div></div><div id="config-timeout" class="member inherited"><a href="Ext.form.action.Submit.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.Submit.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
 154 failing with the failureType as Ext.form.action.Action.CON...</div><div class="long"><p>The number of seconds to wait for a server response before
 155 failing with the <a href="Ext.form.action.Submit.html#failureType" rel="Ext.form.action.Submit#failureType" class="docClass">failureType</a> as <a href="Ext.form.action.Action.html#CONNECT_FAILURE" rel="Ext.form.action.Action#CONNECT_FAILURE" class="docClass">Ext.form.action.Action.CONNECT_FAILURE</a>. If not specified,
 156 defaults to the configured <tt><a href="Ext.form.Basic.html#timeout" rel="Ext.form.Basic#timeout" class="docClass">timeout</a></tt> of the
 157 <a href="Ext.form.action.Submit.html#form" rel="Ext.form.action.Submit#form" class="docClass">form</a>.</p>
 158 </div></div></div><div id="config-url" class="member inherited"><a href="Ext.form.action.Submit.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.Submit.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>
 159 configured on the <a href="Ext.form.action.Submit.html#form" rel="Ext.form.action.Submit#form" class="docClass">form</a>.</p>
 160 </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>
 161 configured on the <a href="Ext.form.action.Submit.html#form" rel="Ext.form.action.Submit#form" class="docClass">form</a>.</p>
 162 </div></div></div><div id="config-waitMsg" class="member inherited"><a href="Ext.form.action.Submit.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.Submit.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>
 163 during the time the action is being processed.</p>
 164 </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>
 165 during the time the action is being processed.</p>
 166 </div></div></div><div id="config-waitTitle" class="member inherited"><a href="Ext.form.action.Submit.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.Submit.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>
 167 during the time the action is being processed.</p>
 168 </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>
 169 during the time the action is being processed.</p>
 170 </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 inherited"><a href="Ext.form.action.Submit.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.Submit.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
 171 thus aborting a submit action. Client side valida...</div><div class="long"><p>Failure type returned when client side validation of the Form fails
 172 thus aborting a submit action. Client side validation is performed unless
 173 <a href="Ext.form.action.Submit.html#clientValidation" rel="Ext.form.action.Submit#clientValidation" class="docClass">clientValidation</a> is explicitly set to <tt>false</tt>.</p>
 174 </div></div></div><div id="property-CONNECT_FAILURE" class="member inherited"><a href="Ext.form.action.Submit.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.Submit.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
 175 to send a request to the remote server. The ...</div><div class="long"><p>Failure type returned when a communication error happens when attempting
 176 to send a request to the remote server. The <a href="Ext.form.action.Submit.html#response" rel="Ext.form.action.Submit#response" class="docClass">response</a> may be examined to
 177 provide further information.</p>
 178 </div></div></div><div id="property-LOAD_FAILURE" class="member inherited"><a href="Ext.form.action.Submit.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.Submit.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
 179 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>
 180 property is set to <tt>false</tt>, or no field values are returned in the response's
 181 <tt>data</tt> property.</p>
 182 </div></div></div><div id="property-SERVER_INVALID" class="member inherited"><a href="Ext.form.action.Submit.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.Submit.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
 183 success property is set to false.
 184
 185
 186 In the c...</div><div class="long"><p>Failure type returned when server side processing fails and the <a href="Ext.form.action.Submit.html#result" rel="Ext.form.action.Submit#result" class="docClass">result</a>'s
 187 <tt>success</tt> property is set to <tt>false</tt>.</p>
 188
 189
 190 <p>In the case of a form submission, field-specific error messages may be returned in the
 191 <a href="Ext.form.action.Submit.html#result" rel="Ext.form.action.Submit#result" class="docClass">result</a>'s <tt>errors</tt> property.</p>
 192
 193 </div></div></div><div id="property-addStatics" class="member inherited"><a href="Ext.form.action.Submit.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.Submit.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.
 194
 195 Ext.define('My.cool.Class', {
 196     ...
 197 });
 198
 199 My.cool.Class.addStatics(...</div><div class="long"><p>Add / override static properties of this class.</p>
 200
 201 <pre><code>Ext.define('My.cool.Class', {
 202     ...
 203 });
 204
 205 My.cool.Class.addStatics({
 206     someProperty: 'someValue',      // My.cool.Class.someProperty = 'someValue'
 207     method1: function() { ... },    // My.cool.Class.method1 = function() { ... };
 208     method2: function() { ... }     // My.cool.Class.method2 = function() { ... };
 209 });
 210 </code></pre>
 211 </div></div></div><div id="property-borrow" class="member inherited"><a href="Ext.form.action.Submit.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.Submit.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.
 212
 213 Ext.define('Bank', {
 214
 215 money: '$$$',
 216 printMoney: functi...</div><div class="long"><p>Borrow another class' members to the prototype of this class.</p>
 217
 218 <p>Ext.define('Bank', {</p>
 219
 220 <pre><code>money: '$$$',
 221 printMoney: function() {
 222     alert('$$$$$$$');
 223 }
 224 </code></pre>
 225
 226 <p>});</p>
 227
 228 <p>Ext.define('Thief', {</p>
 229
 230 <pre><code>...
 231 </code></pre>
 232
 233 <p>});</p>
 234
 235 <p>Thief.borrow(Bank, ['money', 'printMoney']);</p>
 236
 237 <p>var steve = new Thief();</p>
 238
 239 <p>alert(steve.money); // alerts '$$$'
 240 steve.printMoney(); // alerts '$$$$$$$'</p>
 241 </div></div></div><div id="property-create" class="member inherited"><a href="Ext.form.action.Submit.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.Submit.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.
 242 Ext.define('My.cool.Class', {
 243
 244 ...
 245
 246
 247 });
 248
 249 My.cool.Class.create({
 250
 251 someConfig: tr...</div><div class="long"><p>Create a new instance of this Class.
 252 Ext.define('My.cool.Class', {</p>
 253
 254 <pre><code>...
 255 </code></pre>
 256
 257 <p>});</p>
 258
 259 <p>My.cool.Class.create({</p>
 260
 261 <pre><code>someConfig: true
 262 </code></pre>
 263
 264 <p>});</p>
 265 </div></div></div><div id="property-createAlias" class="member inherited"><a href="Ext.form.action.Submit.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.Submit.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:
 266
 267 Ext.define('My.cool.Class', {
 268     method1: function() { ... ...</div><div class="long"><p>Create aliases for existing prototype methods. Example:</p>
 269
 270 <pre><code>Ext.define('My.cool.Class', {
 271     method1: function() { ... },
 272     method2: function() { ... }
 273 });
 274
 275 var test = new My.cool.Class();
 276
 277 My.cool.Class.createAlias({
 278     method3: 'method1',
 279     method4: 'method2'
 280 });
 281
 282 test.method3(); // test.method1()
 283
 284 My.cool.Class.createAlias('method5', 'method3');
 285
 286 test.method5(); // test.method3() -&gt; test.method1()
 287 </code></pre>
 288 </div></div></div><div id="property-failureType" class="member inherited"><a href="Ext.form.action.Submit.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.Submit.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: Ext.form.action.Action.CLIENT_INVALID,
 289 Ext.form.action.Action.SERV...</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">Ext.form.action.Action.CLIENT_INVALID</a>,
 290 <a href="Ext.form.action.Action.html#SERVER_INVALID" rel="Ext.form.action.Action#SERVER_INVALID" class="docClass">Ext.form.action.Action.SERVER_INVALID</a>, <a href="Ext.form.action.Action.html#CONNECT_FAILURE" rel="Ext.form.action.Action#CONNECT_FAILURE" class="docClass">Ext.form.action.Action.CONNECT_FAILURE</a>, or
 291 <a href="Ext.form.action.Action.html#LOAD_FAILURE" rel="Ext.form.action.Action#LOAD_FAILURE" class="docClass">Ext.form.action.Action.LOAD_FAILURE</a>.  Usage:</p>
 292
 293 <pre><code>var fp = new Ext.form.Panel({
 294 ...
 295 buttons: [{
 296     text: 'Save',
 297     formBind: true,
 298     handler: function(){
 299         if(fp.getForm().isValid()){
 300             fp.getForm().submit({
 301                 url: 'form-submit.php',
 302                 waitMsg: 'Submitting your data...',
 303                 success: function(form, action){
 304                     // server responded with success = true
 305                     var result = action.<a href="Ext.form.action.Submit.html#result" rel="Ext.form.action.Submit#result" class="docClass">result</a>;
 306                 },
 307                 failure: function(form, action){
 308                     if (action.<a href="Ext.form.action.Submit.html#failureType" rel="Ext.form.action.Submit#failureType" class="docClass">failureType</a> === <a href="Ext.form.action.Action.html#CONNECT_FAILURE" rel="Ext.form.action.Action#CONNECT_FAILURE" class="docClass">Ext.form.action.Action.CONNECT_FAILURE</a>) {
 309                         Ext.Msg.alert('Error',
 310                             'Status:'+action.<a href="Ext.form.action.Submit.html#response" rel="Ext.form.action.Submit#response" class="docClass">response</a>.status+': '+
 311                             action.<a href="Ext.form.action.Submit.html#response" rel="Ext.form.action.Submit#response" class="docClass">response</a>.statusText);
 312                     }
 313                     if (action.failureType === <a href="Ext.form.action.Action.html#SERVER_INVALID" rel="Ext.form.action.Action#SERVER_INVALID" class="docClass">Ext.form.action.Action.SERVER_INVALID</a>){
 314                         // server responded with success = false
 315                         Ext.Msg.alert('Invalid', action.<a href="Ext.form.action.Submit.html#result" rel="Ext.form.action.Submit#result" class="docClass">result</a>.errormsg);
 316                     }
 317                 }
 318             });
 319         }
 320     }
 321 },{
 322     text: 'Reset',
 323     handler: function(){
 324         fp.getForm().reset();
 325     }
 326 }]
 327 </code></pre>
 328
 329 </div></div></div><div id="property-implement" class="member inherited"><a href="Ext.form.action.Submit.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.Submit.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.
 330
 331 Ext.define('My.awesome.Cat', {
 332     constructor: function() ...</div><div class="long"><p>Add methods / properties to the prototype of this class.</p>
 333
 334 <pre><code>Ext.define('My.awesome.Cat', {
 335     constructor: function() {
 336         ...
 337     }
 338 });
 339
 340  My.awesome.Cat.implement({
 341      meow: function() {
 342         alert('Meowww...');
 343      }
 344  });
 345
 346  var kitty = new My.awesome.Cat;
 347  kitty.meow();
 348 </code></pre>
 349 </div></div></div><div id="property-override" class="member inherited"><a href="Ext.form.action.Submit.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.Submit.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
 350 Ext.Base.callOverridden
 351
 352 Ext.define('...</div><div class="long"><p>Override prototype members of this class. Overridden methods can be invoked via
 353 <a href="Ext.Base.html#callOverridden" rel="Ext.Base#callOverridden" class="docClass">Ext.Base.callOverridden</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 </div></div></div><div id="property-response" class="member inherited"><a href="Ext.form.action.Submit.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.Submit.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>
 380 </div><div class="long"><p>The raw XMLHttpRequest object used to perform the action.</p>
 381 </div></div></div><div id="property-result" class="member inherited"><a href="Ext.form.action.Submit.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.Submit.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
 382 other, action-specific properties.</p>
 383 </div><div class="long"><p>The decoded response object containing a boolean <tt>success</tt> property and
 384 other, action-specific properties.</p>
 385 </div></div></div><div id="property-run" class="member inherited"><a href="Ext.form.action.Submit.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.Submit.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>
 386 </div><div class="long"><p>Invokes this action using the current configuration.</p>
 387 </div></div></div><div id="property-type" class="member inherited"><a href="Ext.form.action.Submit.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.Submit.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.
 388 Currently only "submit" and "load" are supported.</p>
 389 </div><div class="long"><p>The type of action this Action instance performs.
 390 Currently only "submit" and "load" are supported.</p>
 391 </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-Submit" class="member f inherited"><a href="Ext.form.action.Submit.html#method-Submit" rel="method-Submit" 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="Submit"></a><a name="method-Submit"></a><a href="Ext.form.action.Submit.html#" rel="method-Submit" class="cls expand">Submit</a>(
 392 <span class="pre">Object config</span>)
 393  : void</div><div class="description"><div class="short"><p>&nbsp;</p></div><div class="long">
 394 <h3 class="pa">Parameters</h3><ul><li><span class="pre">config</span> : Object<div class="sub-desc"><p>The configuration for this instance.</p>
 395 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
 396 </li></ul></div></div></div><div id="method-callOverridden" class="member inherited"><a href="Ext.form.action.Submit.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.Submit.html#" rel="method-callOverridden" class="cls expand">callOverridden</a>(
 397 <span class="pre">Array/Arguments args</span>)
 398  : Mixed</div><div class="description"><div class="short">Call the original method that was previously overridden with Ext.Base.override
 399
 400 Ext.define('My.Cat', {
 401     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>
 402
 403 <pre><code>Ext.define('My.Cat', {
 404     constructor: function() {
 405         alert("I'm a cat!");
 406
 407         return this;
 408     }
 409 });
 410
 411 My.Cat.override({
 412     constructor: function() {
 413         alert("I'm going to be a cat!");
 414
 415         var instance = this.callOverridden();
 416
 417         alert("Meeeeoooowwww");
 418
 419         return instance;
 420     }
 421 });
 422
 423 var kitty = new My.Cat(); // alerts "I'm going to be a cat!"
 424                           // alerts "I'm a cat!"
 425                           // alerts "Meeeeoooowwww"
 426 </code></pre>
 427 <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>
 428 </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>
 429 </li></ul></div></div></div><div id="method-getName" class="member inherited"><a href="Ext.form.action.Submit.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.Submit.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.
 430
 431 Ext.define('My.cool.Class', {
 432     constructor: function() {
 433         al...</div><div class="long"><p>Get the current class' name in string format.</p>
 434
 435 <pre><code>Ext.define('My.cool.Class', {
 436     constructor: function() {
 437         alert(this.self.getName()); // alerts 'My.cool.Class'
 438     }
 439 });
 440
 441 My.cool.Class.getName(); // 'My.cool.Class'
 442 </code></pre>
 443 <h3 class="pa">Returns</h3><ul><li><span class="pre">String</span>&nbsp; &nbsp;<p>className</p>
 444 </li></ul></div></div></div></div></div></div></div><div id="pageContent"></div></div></div></div></body></html>