| 2 |
aperonnet |
1 |
<div class="body-wrap">
|
|
|
2 |
<div class="top-tools">
|
|
|
3 |
<a class="inner-link" href="#Ext.form.Action.Submit-props"><img src="../resources/images/default/s.gif" class="item-icon icon-prop">Properties</a>
|
|
|
4 |
<a class="inner-link" href="#Ext.form.Action.Submit-methods"><img src="../resources/images/default/s.gif" class="item-icon icon-method">Methods</a>
|
|
|
5 |
<a class="inner-link" href="#Ext.form.Action.Submit-events"><img src="../resources/images/default/s.gif" class="item-icon icon-event">Events</a>
|
|
|
6 |
<a class="inner-link" href="#Ext.form.Action.Submit-configs"><img src="../resources/images/default/s.gif" class="item-icon icon-config">Config Options</a>
|
|
|
7 |
<a class="bookmark" href="../docs/?class=Ext.form.Action.Submit"><img src="../resources/images/default/s.gif" class="item-icon icon-fav">Direct Link</a>
|
|
|
8 |
</div>
|
|
|
9 |
<div class="inheritance res-block">
|
|
|
10 |
<pre class="res-block-inner"><a ext:cls="Ext.form.Action" ext:member="" href="output/Ext.form.Action.html">Action</a>
|
|
|
11 |
<img src="resources/elbow-end.gif"/>Action.Submit</pre></div>
|
|
|
12 |
<h1>Class Ext.form.Action.Submit</h1>
|
|
|
13 |
<table cellspacing="0">
|
|
|
14 |
<tr><td class="label">Package:</td><td class="hd-info">Ext.form</td></tr>
|
|
|
15 |
<tr><td class="label">Defined In:</td><td class="hd-info"><a href="../source/widgets/form/Action.js" target="_blank">Action.js</a></td></tr>
|
|
|
16 |
<tr><td class="label">Class:</td><td class="hd-info">Action.Submit</td></tr>
|
|
|
17 |
<tr><td class="label">Extends:</td><td class="hd-info"><a ext:cls="Ext.form.Action" ext:member="" href="output/Ext.form.Action.html">Action</a></td></tr>
|
|
|
18 |
</table>
|
|
|
19 |
<div class="description">
|
|
|
20 |
A class which handles submission of data from <a ext:cls="Ext.form.BasicForm" href="output/Ext.form.BasicForm.html">Form</a>s
|
|
|
21 |
and processes the returned response.
|
|
|
22 |
<br><br>
|
|
|
23 |
Instances of this class are only created by a <a ext:cls="Ext.form.BasicForm" href="output/Ext.form.BasicForm.html">Form</a> when
|
|
|
24 |
submitting.
|
|
|
25 |
<br><br>
|
|
|
26 |
A response packet must contain a boolean <tt style="font-weight:bold">success</tt> property, and, optionally
|
|
|
27 |
an <tt style="font-weight:bold">errors</tt> property. The <tt style="font-weight:bold">errors</tt> property contains error
|
|
|
28 |
messages for invalid fields.
|
|
|
29 |
<br><br>
|
|
|
30 |
By default, response packets are assumed to be JSON, so a typical response
|
|
|
31 |
packet may look like this:
|
|
|
32 |
<br><br><pre><code>{
|
|
|
33 |
success: false,
|
|
|
34 |
errors: {
|
|
|
35 |
clientCode: <em>"Client not found"</em>,
|
|
|
36 |
portOfLoading: <em>"This field must not be null"</em>
|
|
|
37 |
}
|
|
|
38 |
}</code></pre>
|
|
|
39 |
<br><br>
|
|
|
40 |
Other data may be placed into the response for processing the the <a ext:cls="Ext.form.BasicForm" href="output/Ext.form.BasicForm.html">Ext.form.BasicForm</a>'s callback
|
|
|
41 |
or event handler methods. The object decoded from this JSON is available in the <a ext:cls="Ext.form.Action.Submit" ext:member="result" href="output/Ext.form.Action.Submit.html#result">result</a> property. </div>
|
|
|
42 |
|
|
|
43 |
<div class="hr"></div>
|
|
|
44 |
<a id="Ext.form.Action.Submit-configs"></a>
|
|
|
45 |
<h2>Config Options</h2>
|
|
|
46 |
<table cellspacing="0" class="member-table">
|
|
|
47 |
<tr>
|
|
|
48 |
<th class="sig-header" colspan="2">Config Options</th>
|
|
|
49 |
<th class="msource-header">Defined By</th>
|
|
|
50 |
</tr>
|
|
|
51 |
<tr class="config-row expandable">
|
|
|
52 |
<td class="micon"><a class="exi" href="#expand"> </a></td>
|
|
|
53 |
<td class="sig">
|
|
|
54 |
<a id="Ext.form.Action.Submit-clientValidation"></a>
|
|
|
55 |
<b>clientValidation</b> : boolean <div class="mdesc">
|
|
|
56 |
<div class="short">Determines whether a Form's fields are validated in a final call to isValid prior to submission. Pass false in the Fo...</div>
|
|
|
57 |
<div class="long">
|
|
|
58 |
Determines whether a Form's fields are validated in a final call to <a ext:cls="Ext.form.BasicForm" ext:member="isValid" href="output/Ext.form.BasicForm.html#isValid">isValid</a> prior to submission. Pass <tt>false</tt> in the Form's submit options to prevent this. If not defined, pre-submission field validation is performed. </div>
|
|
|
59 |
</div>
|
|
|
60 |
</td>
|
|
|
61 |
<td class="msource">Action.Submit</td>
|
|
|
62 |
</tr>
|
|
|
63 |
<tr class="config-row inherited alt expandable">
|
|
|
64 |
<td class="micon"><a class="exi" href="#expand"> </a></td>
|
|
|
65 |
<td class="sig">
|
|
|
66 |
<a id="Ext.form.Action.Submit-failure"></a>
|
|
|
67 |
<b>failure</b> : Function <div class="mdesc">
|
|
|
68 |
<div class="short">The function to call when a failure packet was recieved, or when an error ocurred in the Ajax communication. The func...</div>
|
|
|
69 |
<div class="long">
|
|
|
70 |
The function to call when a failure packet was recieved, or when an error ocurred in the Ajax communication. The function is passed the following parameters:<ul class="mdetail-params"> <li><b>form</b> : Ext.form.BasicForm<div class="sub-desc">The form that requested the action</div></li> <li><b>action</b> : Ext.form.Action<div class="sub-desc">The Action class. If an Ajax error ocurred, the failure type will be in <a ext:cls="Ext.form.Action" ext:member="failureType" href="output/Ext.form.Action.html#failureType">failureType</a>. The <a ext:cls="Ext.form.Action" ext:member="result" href="output/Ext.form.Action.html#result">result</a> property of this object may be examined to perform custom postprocessing.</div></li> </ul> </div>
|
|
|
71 |
</div>
|
|
|
72 |
</td>
|
|
|
73 |
<td class="msource"><a ext:cls="Ext.form.Action" ext:member="#failure" href="output/Ext.form.Action.html#failure">Action</a></td>
|
|
|
74 |
</tr>
|
|
|
75 |
<tr class="config-row inherited expandable">
|
|
|
76 |
<td class="micon"><a class="exi" href="#expand"> </a></td>
|
|
|
77 |
<td class="sig">
|
|
|
78 |
<a id="Ext.form.Action.Submit-method"></a>
|
|
|
79 |
<b>method</b> : String <div class="mdesc">
|
|
|
80 |
<div class="short">The HTTP method to use to access the requested URL. Defaults to the Ext.form.BasicForm's method, or if that is not sp...</div>
|
|
|
81 |
<div class="long">
|
|
|
82 |
The HTTP method to use to access the requested URL. Defaults to the <a ext:cls="Ext.form.BasicForm" href="output/Ext.form.BasicForm.html">Ext.form.BasicForm</a>'s method, or if that is not specified, the underlying DOM form's method. </div>
|
|
|
83 |
</div>
|
|
|
84 |
</td>
|
|
|
85 |
<td class="msource"><a ext:cls="Ext.form.Action" ext:member="#method" href="output/Ext.form.Action.html#method">Action</a></td>
|
|
|
86 |
</tr>
|
|
|
87 |
<tr class="config-row inherited alt expandable">
|
|
|
88 |
<td class="micon"><a class="exi" href="#expand"> </a></td>
|
|
|
89 |
<td class="sig">
|
|
|
90 |
<a id="Ext.form.Action.Submit-params"></a>
|
|
|
91 |
<b>params</b> : Mixed <div class="mdesc">
|
|
|
92 |
<div class="short">Extra parameter values to pass. These are added to the Form's Ext.form.BasicForm.baseParams and passed to the specifi...</div>
|
|
|
93 |
<div class="long">
|
|
|
94 |
Extra parameter values to pass. These are added to the Form's <a ext:cls="Ext.form.BasicForm" ext:member="baseParams" href="output/Ext.form.BasicForm.html#baseParams">Ext.form.BasicForm.baseParams</a> and passed to the specified URL along with the Form's input fields. </div>
|
|
|
95 |
</div>
|
|
|
96 |
</td>
|
|
|
97 |
<td class="msource"><a ext:cls="Ext.form.Action" ext:member="#params" href="output/Ext.form.Action.html#params">Action</a></td>
|
|
|
98 |
</tr>
|
|
|
99 |
<tr class="config-row inherited">
|
|
|
100 |
<td class="micon"><a class="exi" href="#expand"> </a></td>
|
|
|
101 |
<td class="sig">
|
|
|
102 |
<a id="Ext.form.Action.Submit-scope"></a>
|
|
|
103 |
<b>scope</b> : Object <div class="mdesc">
|
|
|
104 |
The scope in which to call the callback functions (The <tt>this</tt> reference for the callback functions). </div>
|
|
|
105 |
</td>
|
|
|
106 |
<td class="msource"><a ext:cls="Ext.form.Action" ext:member="#scope" href="output/Ext.form.Action.html#scope">Action</a></td>
|
|
|
107 |
</tr>
|
|
|
108 |
<tr class="config-row inherited alt expandable">
|
|
|
109 |
<td class="micon"><a class="exi" href="#expand"> </a></td>
|
|
|
110 |
<td class="sig">
|
|
|
111 |
<a id="Ext.form.Action.Submit-success"></a>
|
|
|
112 |
<b>success</b> : Function <div class="mdesc">
|
|
|
113 |
<div class="short">The function to call when a valid success return packet is recieved. The function is passed the following parameters:...</div>
|
|
|
114 |
<div class="long">
|
|
|
115 |
The function to call when a valid success return packet is recieved. The function is passed the following parameters:<ul class="mdetail-params"> <li><b>form</b> : Ext.form.BasicForm<div class="sub-desc">The form that requested the action</div></li> <li><b>action</b> : Ext.form.Action<div class="sub-desc">The Action class. The <a ext:cls="Ext.form.Action" ext:member="result" href="output/Ext.form.Action.html#result">result</a> property of this object may be examined to perform custom postprocessing.</div></li> </ul> </div>
|
|
|
116 |
</div>
|
|
|
117 |
</td>
|
|
|
118 |
<td class="msource"><a ext:cls="Ext.form.Action" ext:member="#success" href="output/Ext.form.Action.html#success">Action</a></td>
|
|
|
119 |
</tr>
|
|
|
120 |
<tr class="config-row inherited">
|
|
|
121 |
<td class="micon"><a class="exi" href="#expand"> </a></td>
|
|
|
122 |
<td class="sig">
|
|
|
123 |
<a id="Ext.form.Action.Submit-url"></a>
|
|
|
124 |
<b>url</b> : String <div class="mdesc">
|
|
|
125 |
The URL that the Action is to invoke. </div>
|
|
|
126 |
</td>
|
|
|
127 |
<td class="msource"><a ext:cls="Ext.form.Action" ext:member="#url" href="output/Ext.form.Action.html#url">Action</a></td>
|
|
|
128 |
</tr>
|
|
|
129 |
<tr class="config-row inherited alt">
|
|
|
130 |
<td class="micon"><a class="exi" href="#expand"> </a></td>
|
|
|
131 |
<td class="sig">
|
|
|
132 |
<a id="Ext.form.Action.Submit-waitMsg"></a>
|
|
|
133 |
<b>waitMsg</b> : String <div class="mdesc">
|
|
|
134 |
The message to be displayed by a call to <a ext:cls="Ext.MessageBox" ext:member="wait" href="output/Ext.MessageBox.html#wait">Ext.MessageBox.wait</a> during the time the action is being processed. </div>
|
|
|
135 |
</td>
|
|
|
136 |
<td class="msource"><a ext:cls="Ext.form.Action" ext:member="#waitMsg" href="output/Ext.form.Action.html#waitMsg">Action</a></td>
|
|
|
137 |
</tr>
|
|
|
138 |
<tr class="config-row inherited">
|
|
|
139 |
<td class="micon"><a class="exi" href="#expand"> </a></td>
|
|
|
140 |
<td class="sig">
|
|
|
141 |
<a id="Ext.form.Action.Submit-waitTitle"></a>
|
|
|
142 |
<b>waitTitle</b> : String <div class="mdesc">
|
|
|
143 |
The title to be displayed by a call to <a ext:cls="Ext.MessageBox" ext:member="wait" href="output/Ext.MessageBox.html#wait">Ext.MessageBox.wait</a> during the time the action is being processed. </div>
|
|
|
144 |
</td>
|
|
|
145 |
<td class="msource"><a ext:cls="Ext.form.Action" ext:member="#waitTitle" href="output/Ext.form.Action.html#waitTitle">Action</a></td>
|
|
|
146 |
</tr>
|
|
|
147 |
</table>
|
|
|
148 |
<a id="Ext.form.Action.Submit-props"></a>
|
|
|
149 |
<h2>Public Properties</h2>
|
|
|
150 |
<table cellspacing="0" class="member-table">
|
|
|
151 |
<tr>
|
|
|
152 |
<th class="sig-header" colspan="2">Property</th>
|
|
|
153 |
<th class="msource-header">Defined By</th>
|
|
|
154 |
</tr>
|
|
|
155 |
<tr class="property-row inherited">
|
|
|
156 |
<td class="micon"><a class="exi" href="#expand"> </a></td>
|
|
|
157 |
<td class="sig">
|
|
|
158 |
<a id="Ext.form.Action.Submit-failureType"></a>
|
|
|
159 |
<b>failureType</b> : String <div class="mdesc">
|
|
|
160 |
The type of failure detected. See <a ext:cls="Ext.form.Action" ext:member="Ext.form.Action.CLIENT_INVALID" href="output/Ext.form.Action.html#Ext.form.Action.CLIENT_INVALID">CLIENT_INVALID</a>, <a ext:cls="Ext.form.Action" ext:member="Ext.form.Action.SERVER_INVALID" href="output/Ext.form.Action.html#Ext.form.Action.SERVER_INVALID">SERVER_INVALID</a>,
|
|
|
161 |
<a ext:cls="Ext.form.Action" ext:member="Ext.form.Action.CONNECT_FAILURE" href="output/Ext.form.Action.html#Ext.form.Action.CONNECT_FAILURE">CONNECT_FAILURE</a>, <a ext:cls="Ext.form.Action" ext:member="Ext.form.Action.LOAD_FAILURE" href="output/Ext.form.Action.html#Ext.form.Action.LOAD_FAILURE">LOAD_FAILURE</a> </div>
|
|
|
162 |
</td>
|
|
|
163 |
<td class="msource"><a ext:cls="Ext.form.Action" ext:member="#failureType" href="output/Ext.form.Action.html#failureType">Action</a></td>
|
|
|
164 |
</tr>
|
|
|
165 |
<tr class="property-row inherited alt">
|
|
|
166 |
<td class="micon"><a class="exi" href="#expand"> </a></td>
|
|
|
167 |
<td class="sig">
|
|
|
168 |
<a id="Ext.form.Action.Submit-response"></a>
|
|
|
169 |
<b>response</b> : Object <div class="mdesc">
|
|
|
170 |
|
|
|
171 |
The XMLHttpRequest object used to perform the action. </div>
|
|
|
172 |
</td>
|
|
|
173 |
<td class="msource"><a ext:cls="Ext.form.Action" ext:member="#response" href="output/Ext.form.Action.html#response">Action</a></td>
|
|
|
174 |
</tr>
|
|
|
175 |
<tr class="property-row inherited">
|
|
|
176 |
<td class="micon"><a class="exi" href="#expand"> </a></td>
|
|
|
177 |
<td class="sig">
|
|
|
178 |
<a id="Ext.form.Action.Submit-result"></a>
|
|
|
179 |
<b>result</b> : Object <div class="mdesc">
|
|
|
180 |
|
|
|
181 |
The decoded response object containing a boolean <tt style="font-weight:bold">success</tt> property and
|
|
|
182 |
other, action-specific properties. </div>
|
|
|
183 |
</td>
|
|
|
184 |
<td class="msource"><a ext:cls="Ext.form.Action" ext:member="#result" href="output/Ext.form.Action.html#result">Action</a></td>
|
|
|
185 |
</tr>
|
|
|
186 |
<tr class="property-row inherited alt">
|
|
|
187 |
<td class="micon"><a class="exi" href="#expand"> </a></td>
|
|
|
188 |
<td class="sig">
|
|
|
189 |
<a id="Ext.form.Action.Submit-type"></a>
|
|
|
190 |
<b>type</b> : String <div class="mdesc">
|
|
|
191 |
|
|
|
192 |
The type of action this Action instance performs.
|
|
|
193 |
Currently only "submit" and "load" are supported. </div>
|
|
|
194 |
</td>
|
|
|
195 |
<td class="msource"><a ext:cls="Ext.form.Action" ext:member="#type" href="output/Ext.form.Action.html#type">Action</a></td>
|
|
|
196 |
</tr>
|
|
|
197 |
</table>
|
|
|
198 |
<a id="Ext.form.Action.Submit-methods"></a>
|
|
|
199 |
<h2>Public Methods</h2>
|
|
|
200 |
<div class="no-members">This class has no public methods.</div> <a id="Ext.form.Action.Submit-events"></a>
|
|
|
201 |
<h2>Public Events</h2>
|
|
|
202 |
<div class="no-members">This class has no public events.</div>
|
|
|
203 |
</div>
|