| 2 |
aperonnet |
1 |
<div class="body-wrap">
|
|
|
2 |
<div class="top-tools">
|
|
|
3 |
<a class="inner-link" href="#Ext.form.BasicForm-props"><img src="../resources/images/default/s.gif" class="item-icon icon-prop">Properties</a>
|
|
|
4 |
<a class="inner-link" href="#Ext.form.BasicForm-methods"><img src="../resources/images/default/s.gif" class="item-icon icon-method">Methods</a>
|
|
|
5 |
<a class="inner-link" href="#Ext.form.BasicForm-events"><img src="../resources/images/default/s.gif" class="item-icon icon-event">Events</a>
|
|
|
6 |
<a class="inner-link" href="#Ext.form.BasicForm-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.BasicForm"><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.util.Observable" ext:member="" href="output/Ext.util.Observable.html">Observable</a>
|
|
|
11 |
<img src="resources/elbow-end.gif"/>BasicForm</pre></div>
|
|
|
12 |
<h1>Class Ext.form.BasicForm</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/BasicForm.js" target="_blank">BasicForm.js</a></td></tr>
|
|
|
16 |
<tr><td class="label">Class:</td><td class="hd-info">BasicForm</td></tr>
|
|
|
17 |
<tr><td class="label">Extends:</td><td class="hd-info"><a ext:cls="Ext.util.Observable" ext:member="" href="output/Ext.util.Observable.html">Observable</a></td></tr>
|
|
|
18 |
</table>
|
|
|
19 |
<div class="description">
|
|
|
20 |
Supplies the functionality to do "actions" on forms and initialize Ext.form.Field types on existing markup.
|
|
|
21 |
<br><br>
|
|
|
22 |
By default, Ext Forms are submitted through Ajax, using <a ext:cls="Ext.form.Action" href="output/Ext.form.Action.html">Ext.form.Action</a>.
|
|
|
23 |
To enable normal browser submission of an Ext Form, use the <a ext:cls="Ext.form.BasicForm" ext:member="standardSubmit" href="output/Ext.form.BasicForm.html#standardSubmit">standardSubmit</a> config option. </div>
|
|
|
24 |
|
|
|
25 |
<div class="hr"></div>
|
|
|
26 |
<a id="Ext.form.BasicForm-configs"></a>
|
|
|
27 |
<h2>Config Options</h2>
|
|
|
28 |
<table cellspacing="0" class="member-table">
|
|
|
29 |
<tr>
|
|
|
30 |
<th class="sig-header" colspan="2">Config Options</th>
|
|
|
31 |
<th class="msource-header">Defined By</th>
|
|
|
32 |
</tr>
|
|
|
33 |
<tr class="config-row">
|
|
|
34 |
<td class="micon"><a class="exi" href="#expand"> </a></td>
|
|
|
35 |
<td class="sig">
|
|
|
36 |
<a id="Ext.form.BasicForm-baseParams"></a>
|
|
|
37 |
<b>baseParams</b> : Object <div class="mdesc">
|
|
|
38 |
Parameters to pass with all requests. e.g. baseParams: {id: '123', foo: 'bar'}. </div>
|
|
|
39 |
</td>
|
|
|
40 |
<td class="msource">BasicForm</td>
|
|
|
41 |
</tr>
|
|
|
42 |
<tr class="config-row alt expandable">
|
|
|
43 |
<td class="micon"><a class="exi" href="#expand"> </a></td>
|
|
|
44 |
<td class="sig">
|
|
|
45 |
<a id="Ext.form.BasicForm-errorReader"></a>
|
|
|
46 |
<b>errorReader</b> : DataReader <div class="mdesc">
|
|
|
47 |
<div class="short">An Ext.data.DataReader (e.g. Ext.data.XmlReader) to be used to read data when reading validation errors on "submit" a...</div>
|
|
|
48 |
<div class="long">
|
|
|
49 |
An Ext.data.DataReader (e.g. <a ext:cls="Ext.data.XmlReader" href="output/Ext.data.XmlReader.html">Ext.data.XmlReader</a>) to be used to read data when reading validation errors on "submit" actions. This is completely optional as there is built-in support for processing JSON. </div>
|
|
|
50 |
</div>
|
|
|
51 |
</td>
|
|
|
52 |
<td class="msource">BasicForm</td>
|
|
|
53 |
</tr>
|
|
|
54 |
<tr class="config-row">
|
|
|
55 |
<td class="micon"><a class="exi" href="#expand"> </a></td>
|
|
|
56 |
<td class="sig">
|
|
|
57 |
<a id="Ext.form.BasicForm-fileUpload"></a>
|
|
|
58 |
<b>fileUpload</b> : Boolean <div class="mdesc">
|
|
|
59 |
Set to true if this form is a file upload. </div>
|
|
|
60 |
</td>
|
|
|
61 |
<td class="msource">BasicForm</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.BasicForm-listeners"></a>
|
|
|
67 |
<b>listeners</b> : Object <div class="mdesc">
|
|
|
68 |
<div class="short">A config object containing one or more event handlers to be added to this object during initialization. This should b...</div>
|
|
|
69 |
<div class="long">
|
|
|
70 |
A config object containing one or more event handlers to be added to this object during initialization. This should be a valid listeners config object as specified in the <a ext:cls="Ext.util.Observable" ext:member="addListener" href="output/Ext.util.Observable.html#addListener">addListener</a> example for attaching multiple handlers at once. </div>
|
|
|
71 |
</div>
|
|
|
72 |
</td>
|
|
|
73 |
<td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#listeners" href="output/Ext.util.Observable.html#listeners">Observable</a></td>
|
|
|
74 |
</tr>
|
|
|
75 |
<tr class="config-row">
|
|
|
76 |
<td class="micon"><a class="exi" href="#expand"> </a></td>
|
|
|
77 |
<td class="sig">
|
|
|
78 |
<a id="Ext.form.BasicForm-method"></a>
|
|
|
79 |
<b>method</b> : String <div class="mdesc">
|
|
|
80 |
The request method to use (GET or POST) for form actions if one isn't supplied in the action options. </div>
|
|
|
81 |
</td>
|
|
|
82 |
<td class="msource">BasicForm</td>
|
|
|
83 |
</tr>
|
|
|
84 |
<tr class="config-row alt expandable">
|
|
|
85 |
<td class="micon"><a class="exi" href="#expand"> </a></td>
|
|
|
86 |
<td class="sig">
|
|
|
87 |
<a id="Ext.form.BasicForm-reader"></a>
|
|
|
88 |
<b>reader</b> : DataReader <div class="mdesc">
|
|
|
89 |
<div class="short">An Ext.data.DataReader (e.g. Ext.data.XmlReader) to be used to read data when executing "load" actions. This is optio...</div>
|
|
|
90 |
<div class="long">
|
|
|
91 |
An Ext.data.DataReader (e.g. <a ext:cls="Ext.data.XmlReader" href="output/Ext.data.XmlReader.html">Ext.data.XmlReader</a>) to be used to read data when executing "load" actions. This is optional as there is built-in support for processing JSON. </div>
|
|
|
92 |
</div>
|
|
|
93 |
</td>
|
|
|
94 |
<td class="msource">BasicForm</td>
|
|
|
95 |
</tr>
|
|
|
96 |
<tr class="config-row">
|
|
|
97 |
<td class="micon"><a class="exi" href="#expand"> </a></td>
|
|
|
98 |
<td class="sig">
|
|
|
99 |
<a id="Ext.form.BasicForm-standardSubmit"></a>
|
|
|
100 |
<b>standardSubmit</b> : Boolean <div class="mdesc">
|
|
|
101 |
If set to true, standard HTML form submits are used instead of XHR (Ajax) style form submissions. (defaults to false) </div>
|
|
|
102 |
</td>
|
|
|
103 |
<td class="msource">BasicForm</td>
|
|
|
104 |
</tr>
|
|
|
105 |
<tr class="config-row alt">
|
|
|
106 |
<td class="micon"><a class="exi" href="#expand"> </a></td>
|
|
|
107 |
<td class="sig">
|
|
|
108 |
<a id="Ext.form.BasicForm-timeout"></a>
|
|
|
109 |
<b>timeout</b> : Number <div class="mdesc">
|
|
|
110 |
Timeout for form actions in seconds (default is 30 seconds). </div>
|
|
|
111 |
</td>
|
|
|
112 |
<td class="msource">BasicForm</td>
|
|
|
113 |
</tr>
|
|
|
114 |
<tr class="config-row">
|
|
|
115 |
<td class="micon"><a class="exi" href="#expand"> </a></td>
|
|
|
116 |
<td class="sig">
|
|
|
117 |
<a id="Ext.form.BasicForm-trackResetOnLoad"></a>
|
|
|
118 |
<b>trackResetOnLoad</b> : Boolean <div class="mdesc">
|
|
|
119 |
If set to true, form.reset() resets to the last loaded or setValues() data instead of when the form was first created. </div>
|
|
|
120 |
</td>
|
|
|
121 |
<td class="msource">BasicForm</td>
|
|
|
122 |
</tr>
|
|
|
123 |
<tr class="config-row alt">
|
|
|
124 |
<td class="micon"><a class="exi" href="#expand"> </a></td>
|
|
|
125 |
<td class="sig">
|
|
|
126 |
<a id="Ext.form.BasicForm-url"></a>
|
|
|
127 |
<b>url</b> : String <div class="mdesc">
|
|
|
128 |
The URL to use for form actions if one isn't supplied in the action options. </div>
|
|
|
129 |
</td>
|
|
|
130 |
<td class="msource">BasicForm</td>
|
|
|
131 |
</tr>
|
|
|
132 |
</table>
|
|
|
133 |
<a id="Ext.form.BasicForm-props"></a>
|
|
|
134 |
<h2>Public Properties</h2>
|
|
|
135 |
<table cellspacing="0" class="member-table">
|
|
|
136 |
<tr>
|
|
|
137 |
<th class="sig-header" colspan="2">Property</th>
|
|
|
138 |
<th class="msource-header">Defined By</th>
|
|
|
139 |
</tr>
|
|
|
140 |
<tr class="property-row expandable">
|
|
|
141 |
<td class="micon"><a class="exi" href="#expand"> </a></td>
|
|
|
142 |
<td class="sig">
|
|
|
143 |
<a id="Ext.form.BasicForm-waitMsgTarget"></a>
|
|
|
144 |
<b>waitMsgTarget</b> : Mixed <div class="mdesc">
|
|
|
145 |
<div class="short">
|
|
|
146 |
By default wait messages are displayed with Ext.MessageBox.wait. You can target a specific
|
|
|
147 |
element by passing it or ...</div>
|
|
|
148 |
<div class="long">
|
|
|
149 |
|
|
|
150 |
By default wait messages are displayed with Ext.MessageBox.wait. You can target a specific
|
|
|
151 |
element by passing it or its id or mask the form itself by passing in true. </div>
|
|
|
152 |
</div>
|
|
|
153 |
</td>
|
|
|
154 |
<td class="msource">BasicForm</td>
|
|
|
155 |
</tr>
|
|
|
156 |
</table>
|
|
|
157 |
<a id="Ext.form.BasicForm-methods"></a>
|
|
|
158 |
<h2>Public Methods</h2>
|
|
|
159 |
<table cellspacing="0" class="member-table">
|
|
|
160 |
<tr>
|
|
|
161 |
<th class="sig-header" colspan="2">Method</th>
|
|
|
162 |
<th class="msource-header">Defined By</th>
|
|
|
163 |
</tr>
|
|
|
164 |
<tr class="method-row expandable">
|
|
|
165 |
<td class="micon"><a class="exi" href="#expand"> </a></td>
|
|
|
166 |
<td class="sig">
|
|
|
167 |
<a id="Ext.form.BasicForm-BasicForm"></a>
|
|
|
168 |
<b>BasicForm</b>( <code>Mixed el</code>, <code>Object config</code> ) <div class="mdesc">
|
|
|
169 |
<div class="short"></div>
|
|
|
170 |
<div class="long">
|
|
|
171 |
<div class="mdetail-params">
|
|
|
172 |
<strong>Parameters:</strong>
|
|
|
173 |
<ul><li><code>el</code> : Mixed<div class="sub-desc">The form element or its id</div></li><li><code>config</code> : Object<div class="sub-desc">Configuration options</div></li> </ul>
|
|
|
174 |
<strong>Returns:</strong>
|
|
|
175 |
<ul>
|
|
|
176 |
<li><code></code></li>
|
|
|
177 |
</ul>
|
|
|
178 |
</div>
|
|
|
179 |
</div>
|
|
|
180 |
</div>
|
|
|
181 |
</td>
|
|
|
182 |
<td class="msource">BasicForm</td>
|
|
|
183 |
</tr>
|
|
|
184 |
<tr class="method-row alt expandable">
|
|
|
185 |
<td class="micon"><a class="exi" href="#expand"> </a></td>
|
|
|
186 |
<td class="sig">
|
|
|
187 |
<a id="Ext.form.BasicForm-add"></a>
|
|
|
188 |
<b>add</b>( <code>Field field1</code>, <span class="optional" title="Optional">[<code>Field field2</code>]</span>, <span class="optional" title="Optional">[<code>Field etc</code>]</span> ) : BasicForm <div class="mdesc">
|
|
|
189 |
<div class="short">Add Ext.form components to this form.</div>
|
|
|
190 |
<div class="long">
|
|
|
191 |
Add Ext.form components to this form. <div class="mdetail-params">
|
|
|
192 |
<strong>Parameters:</strong>
|
|
|
193 |
<ul><li><code>field1</code> : Field<div class="sub-desc"></div></li><li><code>field2</code> : Field<div class="sub-desc">(optional)</div></li><li><code>etc</code> : Field<div class="sub-desc">(optional)</div></li> </ul>
|
|
|
194 |
<strong>Returns:</strong>
|
|
|
195 |
<ul>
|
|
|
196 |
<li><code>BasicForm</code><div class="sub-desc">this</div></li>
|
|
|
197 |
</ul>
|
|
|
198 |
</div>
|
|
|
199 |
</div>
|
|
|
200 |
</div>
|
|
|
201 |
</td>
|
|
|
202 |
<td class="msource">BasicForm</td>
|
|
|
203 |
</tr>
|
|
|
204 |
<tr class="method-row inherited expandable">
|
|
|
205 |
<td class="micon"><a class="exi" href="#expand"> </a></td>
|
|
|
206 |
<td class="sig">
|
|
|
207 |
<a id="Ext.form.BasicForm-addEvents"></a>
|
|
|
208 |
<b>addEvents</b>( <code>Object object</code> ) : void <div class="mdesc">
|
|
|
209 |
<div class="short">Used to define events on this Observable</div>
|
|
|
210 |
<div class="long">
|
|
|
211 |
Used to define events on this Observable <div class="mdetail-params">
|
|
|
212 |
<strong>Parameters:</strong>
|
|
|
213 |
<ul><li><code>object</code> : Object<div class="sub-desc">The object with the events defined</div></li> </ul>
|
|
|
214 |
<strong>Returns:</strong>
|
|
|
215 |
<ul>
|
|
|
216 |
<li><code>void</code></li>
|
|
|
217 |
</ul>
|
|
|
218 |
</div>
|
|
|
219 |
</div>
|
|
|
220 |
</div>
|
|
|
221 |
</td>
|
|
|
222 |
<td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#addEvents" href="output/Ext.util.Observable.html#addEvents">Observable</a></td>
|
|
|
223 |
</tr>
|
|
|
224 |
<tr class="method-row inherited alt expandable">
|
|
|
225 |
<td class="micon"><a class="exi" href="#expand"> </a></td>
|
|
|
226 |
<td class="sig">
|
|
|
227 |
<a id="Ext.form.BasicForm-addListener"></a>
|
|
|
228 |
<b>addListener</b>( <code>String eventName</code>, <code>Function handler</code>, <span class="optional" title="Optional">[<code>Object scope</code>]</span>, <span class="optional" title="Optional">[<code>Object options</code>]</span> ) : void <div class="mdesc">
|
|
|
229 |
<div class="short">Appends an event handler to this component</div>
|
|
|
230 |
<div class="long">
|
|
|
231 |
Appends an event handler to this component <div class="mdetail-params">
|
|
|
232 |
<strong>Parameters:</strong>
|
|
|
233 |
<ul><li><code>eventName</code> : String<div class="sub-desc">The type of event to listen for</div></li><li><code>handler</code> : Function<div class="sub-desc">The method the event invokes</div></li><li><code>scope</code> : Object<div class="sub-desc">(optional) The scope in which to execute the handler
|
|
|
234 |
function. The handler function's "this" context.</div></li><li><code>options</code> : Object<div class="sub-desc">(optional) An object containing handler configuration
|
|
|
235 |
properties. This may contain any of the following properties:<ul>
|
|
|
236 |
<li><b>scope</b> : Object<p class="sub-desc">The scope in which to execute the handler function. The handler function's "this" context.</p></li>
|
|
|
237 |
<li><b>delay</b> : Number<p class="sub-desc">The number of milliseconds to delay the invocation of the handler after the event fires.</p></li>
|
|
|
238 |
<li><b>single</b> : Boolean<p class="sub-desc">True to add a handler to handle just the next firing of the event, and then remove itself.</p></li>
|
|
|
239 |
<li><b>buffer</b> : Number<p class="sub-desc">Causes the handler to be scheduled to run in an <a ext:cls="Ext.util.DelayedTask" href="output/Ext.util.DelayedTask.html">Ext.util.DelayedTask</a> delayed
|
|
|
240 |
by the specified number of milliseconds. If the event fires again within that time, the original
|
|
|
241 |
handler is <em>not</em> invoked, but the new handler is scheduled in its place.</p></li>
|
|
|
242 |
</ul><br>
|
|
|
243 |
<p>
|
|
|
244 |
<b>Combining Options</b><br>
|
|
|
245 |
Using the options argument, it is possible to combine different types of listeners:<br>
|
|
|
246 |
<br>
|
|
|
247 |
A normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)
|
|
|
248 |
<pre><code>el.on(<em>'click'</em>, <b>this</b>.onClick, <b>this</b>, {
|
|
|
249 |
single: true,
|
|
|
250 |
delay: 100,
|
|
|
251 |
forumId: 4
|
|
|
252 |
});</code></pre>
|
|
|
253 |
<p>
|
|
|
254 |
<b>Attaching multiple handlers in 1 call</b><br>
|
|
|
255 |
The method also allows for a single argument to be passed which is a config object containing properties
|
|
|
256 |
which specify multiple handlers.
|
|
|
257 |
<p>
|
|
|
258 |
<pre><code>foo.on({
|
|
|
259 |
<em>'click'</em> : {
|
|
|
260 |
fn: <b>this</b>.onClick,
|
|
|
261 |
scope: <b>this</b>,
|
|
|
262 |
delay: 100
|
|
|
263 |
},
|
|
|
264 |
<em>'mouseover'</em> : {
|
|
|
265 |
fn: <b>this</b>.onMouseOver,
|
|
|
266 |
scope: <b>this</b>
|
|
|
267 |
},
|
|
|
268 |
<em>'mouseout'</em> : {
|
|
|
269 |
fn: <b>this</b>.onMouseOut,
|
|
|
270 |
scope: <b>this</b>
|
|
|
271 |
}
|
|
|
272 |
});</code></pre>
|
|
|
273 |
<p>
|
|
|
274 |
Or a shorthand syntax:<br>
|
|
|
275 |
<pre><code>foo.on({
|
|
|
276 |
<em>'click'</em> : <b>this</b>.onClick,
|
|
|
277 |
<em>'mouseover'</em> : <b>this</b>.onMouseOver,
|
|
|
278 |
<em>'mouseout'</em> : <b>this</b>.onMouseOut,
|
|
|
279 |
scope: <b>this</b>
|
|
|
280 |
});</code></pre></div></li> </ul>
|
|
|
281 |
<strong>Returns:</strong>
|
|
|
282 |
<ul>
|
|
|
283 |
<li><code>void</code></li>
|
|
|
284 |
</ul>
|
|
|
285 |
</div>
|
|
|
286 |
</div>
|
|
|
287 |
</div>
|
|
|
288 |
</td>
|
|
|
289 |
<td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#addListener" href="output/Ext.util.Observable.html#addListener">Observable</a></td>
|
|
|
290 |
</tr>
|
|
|
291 |
<tr class="method-row expandable">
|
|
|
292 |
<td class="micon"><a class="exi" href="#expand"> </a></td>
|
|
|
293 |
<td class="sig">
|
|
|
294 |
<a id="Ext.form.BasicForm-applyIfToFields"></a>
|
|
|
295 |
<b>applyIfToFields</b>( <code>Object values</code> ) : BasicForm <div class="mdesc">
|
|
|
296 |
<div class="short">Calls <a ext:cls="Ext" ext:member="applyIf" href="output/Ext.html#applyIf">Ext.applyIf</a> for all field in this form with the passed object.</div>
|
|
|
297 |
<div class="long">
|
|
|
298 |
Calls <a ext:cls="Ext" ext:member="applyIf" href="output/Ext.html#applyIf">Ext.applyIf</a> for all field in this form with the passed object. <div class="mdetail-params">
|
|
|
299 |
<strong>Parameters:</strong>
|
|
|
300 |
<ul><li><code>values</code> : Object<div class="sub-desc"></div></li> </ul>
|
|
|
301 |
<strong>Returns:</strong>
|
|
|
302 |
<ul>
|
|
|
303 |
<li><code>BasicForm</code><div class="sub-desc">this</div></li>
|
|
|
304 |
</ul>
|
|
|
305 |
</div>
|
|
|
306 |
</div>
|
|
|
307 |
</div>
|
|
|
308 |
</td>
|
|
|
309 |
<td class="msource">BasicForm</td>
|
|
|
310 |
</tr>
|
|
|
311 |
<tr class="method-row alt expandable">
|
|
|
312 |
<td class="micon"><a class="exi" href="#expand"> </a></td>
|
|
|
313 |
<td class="sig">
|
|
|
314 |
<a id="Ext.form.BasicForm-applyToFields"></a>
|
|
|
315 |
<b>applyToFields</b>( <code>Object values</code> ) : BasicForm <div class="mdesc">
|
|
|
316 |
<div class="short">Calls <a ext:cls="Ext" ext:member="apply" href="output/Ext.html#apply">Ext.apply</a> for all fields in this form with the passed object.</div>
|
|
|
317 |
<div class="long">
|
|
|
318 |
Calls <a ext:cls="Ext" ext:member="apply" href="output/Ext.html#apply">Ext.apply</a> for all fields in this form with the passed object. <div class="mdetail-params">
|
|
|
319 |
<strong>Parameters:</strong>
|
|
|
320 |
<ul><li><code>values</code> : Object<div class="sub-desc"></div></li> </ul>
|
|
|
321 |
<strong>Returns:</strong>
|
|
|
322 |
<ul>
|
|
|
323 |
<li><code>BasicForm</code><div class="sub-desc">this</div></li>
|
|
|
324 |
</ul>
|
|
|
325 |
</div>
|
|
|
326 |
</div>
|
|
|
327 |
</div>
|
|
|
328 |
</td>
|
|
|
329 |
<td class="msource">BasicForm</td>
|
|
|
330 |
</tr>
|
|
|
331 |
<tr class="method-row expandable">
|
|
|
332 |
<td class="micon"><a class="exi" href="#expand"> </a></td>
|
|
|
333 |
<td class="sig">
|
|
|
334 |
<a id="Ext.form.BasicForm-clearInvalid"></a>
|
|
|
335 |
<b>clearInvalid</b>() : BasicForm <div class="mdesc">
|
|
|
336 |
<div class="short">Clears all invalid messages in this form.</div>
|
|
|
337 |
<div class="long">
|
|
|
338 |
Clears all invalid messages in this form. <div class="mdetail-params">
|
|
|
339 |
<strong>Parameters:</strong>
|
|
|
340 |
<ul><li>None.</li> </ul>
|
|
|
341 |
<strong>Returns:</strong>
|
|
|
342 |
<ul>
|
|
|
343 |
<li><code>BasicForm</code><div class="sub-desc">this</div></li>
|
|
|
344 |
</ul>
|
|
|
345 |
</div>
|
|
|
346 |
</div>
|
|
|
347 |
</div>
|
|
|
348 |
</td>
|
|
|
349 |
<td class="msource">BasicForm</td>
|
|
|
350 |
</tr>
|
|
|
351 |
<tr class="method-row alt expandable">
|
|
|
352 |
<td class="micon"><a class="exi" href="#expand"> </a></td>
|
|
|
353 |
<td class="sig">
|
|
|
354 |
<a id="Ext.form.BasicForm-doAction"></a>
|
|
|
355 |
<b>doAction</b>( <code>String/Object actionName</code>, <span class="optional" title="Optional">[<code>Object options</code>]</span> ) : BasicForm <div class="mdesc">
|
|
|
356 |
<div class="short">Performs a predefined action (Ext.form.Action.Submit or
|
|
|
357 |
Ext.form.Action.Load) or a custom extension of Ext.form.Actio...</div>
|
|
|
358 |
<div class="long">
|
|
|
359 |
Performs a predefined action (<a ext:cls="Ext.form.Action.Submit" href="output/Ext.form.Action.Submit.html">Ext.form.Action.Submit</a> or
|
|
|
360 |
<a ext:cls="Ext.form.Action.Load" href="output/Ext.form.Action.Load.html">Ext.form.Action.Load</a>) or a custom extension of <a ext:cls="Ext.form.Action" href="output/Ext.form.Action.html">Ext.form.Action</a>
|
|
|
361 |
to perform application-specific processing. <div class="mdetail-params">
|
|
|
362 |
<strong>Parameters:</strong>
|
|
|
363 |
<ul><li><code>actionName</code> : String/Object<div class="sub-desc">The name of the predefined action type,
|
|
|
364 |
or instance of <a ext:cls="Ext.form.Action" href="output/Ext.form.Action.html">Ext.form.Action</a> to perform.</div></li><li><code>options</code> : Object<div class="sub-desc">(optional) The options to pass to the <a ext:cls="Ext.form.Action" href="output/Ext.form.Action.html">Ext.form.Action</a>.
|
|
|
365 |
All of the config options listed below are supported by both the submit
|
|
|
366 |
and load actions unless otherwise noted (custom actions could also accept
|
|
|
367 |
other config options):<ul>
|
|
|
368 |
<li><b>url</b> : String<p style="margin-left:1em">The url for the action (defaults
|
|
|
369 |
to the form's url.)</p></li>
|
|
|
370 |
<li><b>method</b> : String<p style="margin-left:1em">The form method to use (defaults
|
|
|
371 |
to the form's method, or POST if not defined)</p></li>
|
|
|
372 |
<li><b>params</b> : String/Object<p style="margin-left:1em">The params to pass
|
|
|
373 |
(defaults to the form's baseParams, or none if not defined)</p></li>
|
|
|
374 |
<li><b>success</b> : Function<p style="margin-left:1em">The callback that will
|
|
|
375 |
be invoked after a successful response. Note that this is HTTP success
|
|
|
376 |
(the transaction was sent and received correctly), but the resulting response data
|
|
|
377 |
can still contain data errors. The function is passed the following parameters:<ul>
|
|
|
378 |
<li><code>form</code> : Ext.form.BasicForm<div class="sub-desc">The form that requested the action</div></li>
|
|
|
379 |
<li><code>action</code> : 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>
|
|
|
380 |
property of this object may be examined to perform custom postprocessing.</div></li>
|
|
|
381 |
</ul></p></li>
|
|
|
382 |
<li><b>failure</b> : Function<p style="margin-left:1em">The callback that will
|
|
|
383 |
be invoked after a failed transaction attempt. Note that this is HTTP failure,
|
|
|
384 |
which means a non-successful HTTP code was returned from the server. The function
|
|
|
385 |
is passed the following parameters:<ul>
|
|
|
386 |
<li><code>form</code> : Ext.form.BasicForm<div class="sub-desc">The form that requested the action</div></li>
|
|
|
387 |
<li><code>action</code> : Ext.form.Action<div class="sub-desc">The Action class. If an Ajax
|
|
|
388 |
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>
|
|
|
389 |
property of this object may be examined to perform custom postprocessing.</div></li>
|
|
|
390 |
</ul></p></li>
|
|
|
391 |
<li><b>scope</b> : Object<p style="margin-left:1em">The scope in which to call the
|
|
|
392 |
callback functions (The <tt>this</tt> reference for the callback functions).</p></li>
|
|
|
393 |
<li><b>clientValidation</b> : Boolean<p style="margin-left:1em">Submit Action only.
|
|
|
394 |
Determines whether a Form's fields are validated in a final call to
|
|
|
395 |
<a ext:cls="Ext.form.BasicForm" ext:member="isValid" href="output/Ext.form.BasicForm.html#isValid">isValid</a> prior to submission. Set to <tt>false</tt>
|
|
|
396 |
to prevent this. If undefined, pre-submission field validation is performed.</p></li></ul></div></li> </ul>
|
|
|
397 |
<strong>Returns:</strong>
|
|
|
398 |
<ul>
|
|
|
399 |
<li><code>BasicForm</code><div class="sub-desc">this</div></li>
|
|
|
400 |
</ul>
|
|
|
401 |
</div>
|
|
|
402 |
</div>
|
|
|
403 |
</div>
|
|
|
404 |
</td>
|
|
|
405 |
<td class="msource">BasicForm</td>
|
|
|
406 |
</tr>
|
|
|
407 |
<tr class="method-row expandable">
|
|
|
408 |
<td class="micon"><a class="exi" href="#expand"> </a></td>
|
|
|
409 |
<td class="sig">
|
|
|
410 |
<a id="Ext.form.BasicForm-findField"></a>
|
|
|
411 |
<b>findField</b>( <code>String id</code> ) : Field <div class="mdesc">
|
|
|
412 |
<div class="short">Find a Ext.form.Field in this form by id, dataIndex, name or hiddenName.</div>
|
|
|
413 |
<div class="long">
|
|
|
414 |
Find a Ext.form.Field in this form by id, dataIndex, name or hiddenName. <div class="mdetail-params">
|
|
|
415 |
<strong>Parameters:</strong>
|
|
|
416 |
<ul><li><code>id</code> : String<div class="sub-desc">The value to search for</div></li> </ul>
|
|
|
417 |
<strong>Returns:</strong>
|
|
|
418 |
<ul>
|
|
|
419 |
<li><code>Field</code></li>
|
|
|
420 |
</ul>
|
|
|
421 |
</div>
|
|
|
422 |
</div>
|
|
|
423 |
</div>
|
|
|
424 |
</td>
|
|
|
425 |
<td class="msource">BasicForm</td>
|
|
|
426 |
</tr>
|
|
|
427 |
<tr class="method-row inherited alt expandable">
|
|
|
428 |
<td class="micon"><a class="exi" href="#expand"> </a></td>
|
|
|
429 |
<td class="sig">
|
|
|
430 |
<a id="Ext.form.BasicForm-fireEvent"></a>
|
|
|
431 |
<b>fireEvent</b>( <code>String eventName</code>, <code>Object... args</code> ) : Boolean <div class="mdesc">
|
|
|
432 |
<div class="short">Fires the specified event with the passed parameters (minus the event name).</div>
|
|
|
433 |
<div class="long">
|
|
|
434 |
Fires the specified event with the passed parameters (minus the event name). <div class="mdetail-params">
|
|
|
435 |
<strong>Parameters:</strong>
|
|
|
436 |
<ul><li><code>eventName</code> : String<div class="sub-desc"></div></li><li><code>args</code> : Object...<div class="sub-desc">Variable number of parameters are passed to handlers</div></li> </ul>
|
|
|
437 |
<strong>Returns:</strong>
|
|
|
438 |
<ul>
|
|
|
439 |
<li><code>Boolean</code><div class="sub-desc">returns false if any of the handlers return false otherwise it returns true</div></li>
|
|
|
440 |
</ul>
|
|
|
441 |
</div>
|
|
|
442 |
</div>
|
|
|
443 |
</div>
|
|
|
444 |
</td>
|
|
|
445 |
<td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#fireEvent" href="output/Ext.util.Observable.html#fireEvent">Observable</a></td>
|
|
|
446 |
</tr>
|
|
|
447 |
<tr class="method-row expandable">
|
|
|
448 |
<td class="micon"><a class="exi" href="#expand"> </a></td>
|
|
|
449 |
<td class="sig">
|
|
|
450 |
<a id="Ext.form.BasicForm-getEl"></a>
|
|
|
451 |
<b>getEl</b>() : Ext.Element <div class="mdesc">
|
|
|
452 |
<div class="short">Get the HTML form Element</div>
|
|
|
453 |
<div class="long">
|
|
|
454 |
Get the HTML form Element <div class="mdetail-params">
|
|
|
455 |
<strong>Parameters:</strong>
|
|
|
456 |
<ul><li>None.</li> </ul>
|
|
|
457 |
<strong>Returns:</strong>
|
|
|
458 |
<ul>
|
|
|
459 |
<li><code>Ext.Element</code></li>
|
|
|
460 |
</ul>
|
|
|
461 |
</div>
|
|
|
462 |
</div>
|
|
|
463 |
</div>
|
|
|
464 |
</td>
|
|
|
465 |
<td class="msource">BasicForm</td>
|
|
|
466 |
</tr>
|
|
|
467 |
<tr class="method-row alt expandable">
|
|
|
468 |
<td class="micon"><a class="exi" href="#expand"> </a></td>
|
|
|
469 |
<td class="sig">
|
|
|
470 |
<a id="Ext.form.BasicForm-getValues"></a>
|
|
|
471 |
<b>getValues</b>( <span class="optional" title="Optional">[<code>Boolean asString</code>]</span> ) : String/Object <div class="mdesc">
|
|
|
472 |
<div class="short">Returns the fields in this form as an object with key/value pairs as they would be submitted using a standard form su...</div>
|
|
|
473 |
<div class="long">
|
|
|
474 |
Returns the fields in this form as an object with key/value pairs as they would be submitted using a standard form submit.
|
|
|
475 |
If multiple fields exist with the same name they are returned as an array. <div class="mdetail-params">
|
|
|
476 |
<strong>Parameters:</strong>
|
|
|
477 |
<ul><li><code>asString</code> : Boolean<div class="sub-desc">(optional) false to return the the values as an object (defaults to returning as a string)</div></li> </ul>
|
|
|
478 |
<strong>Returns:</strong>
|
|
|
479 |
<ul>
|
|
|
480 |
<li><code>String/Object</code></li>
|
|
|
481 |
</ul>
|
|
|
482 |
</div>
|
|
|
483 |
</div>
|
|
|
484 |
</div>
|
|
|
485 |
</td>
|
|
|
486 |
<td class="msource">BasicForm</td>
|
|
|
487 |
</tr>
|
|
|
488 |
<tr class="method-row inherited expandable">
|
|
|
489 |
<td class="micon"><a class="exi" href="#expand"> </a></td>
|
|
|
490 |
<td class="sig">
|
|
|
491 |
<a id="Ext.form.BasicForm-hasListener"></a>
|
|
|
492 |
<b>hasListener</b>( <code>String eventName</code> ) : Boolean <div class="mdesc">
|
|
|
493 |
<div class="short">Checks to see if this object has any listeners for a specified event</div>
|
|
|
494 |
<div class="long">
|
|
|
495 |
Checks to see if this object has any listeners for a specified event <div class="mdetail-params">
|
|
|
496 |
<strong>Parameters:</strong>
|
|
|
497 |
<ul><li><code>eventName</code> : String<div class="sub-desc">The name of the event to check for</div></li> </ul>
|
|
|
498 |
<strong>Returns:</strong>
|
|
|
499 |
<ul>
|
|
|
500 |
<li><code>Boolean</code><div class="sub-desc">True if the event is being listened for, else false</div></li>
|
|
|
501 |
</ul>
|
|
|
502 |
</div>
|
|
|
503 |
</div>
|
|
|
504 |
</div>
|
|
|
505 |
</td>
|
|
|
506 |
<td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#hasListener" href="output/Ext.util.Observable.html#hasListener">Observable</a></td>
|
|
|
507 |
</tr>
|
|
|
508 |
<tr class="method-row alt expandable">
|
|
|
509 |
<td class="micon"><a class="exi" href="#expand"> </a></td>
|
|
|
510 |
<td class="sig">
|
|
|
511 |
<a id="Ext.form.BasicForm-isDirty"></a>
|
|
|
512 |
<b>isDirty</b>() : Boolean <div class="mdesc">
|
|
|
513 |
<div class="short">Returns true if any fields in this form have changed since their original load.</div>
|
|
|
514 |
<div class="long">
|
|
|
515 |
Returns true if any fields in this form have changed since their original load. <div class="mdetail-params">
|
|
|
516 |
<strong>Parameters:</strong>
|
|
|
517 |
<ul><li>None.</li> </ul>
|
|
|
518 |
<strong>Returns:</strong>
|
|
|
519 |
<ul>
|
|
|
520 |
<li><code>Boolean</code></li>
|
|
|
521 |
</ul>
|
|
|
522 |
</div>
|
|
|
523 |
</div>
|
|
|
524 |
</div>
|
|
|
525 |
</td>
|
|
|
526 |
<td class="msource">BasicForm</td>
|
|
|
527 |
</tr>
|
|
|
528 |
<tr class="method-row expandable">
|
|
|
529 |
<td class="micon"><a class="exi" href="#expand"> </a></td>
|
|
|
530 |
<td class="sig">
|
|
|
531 |
<a id="Ext.form.BasicForm-isValid"></a>
|
|
|
532 |
<b>isValid</b>() : Boolean <div class="mdesc">
|
|
|
533 |
<div class="short">Returns true if client-side validation on the form is successful.</div>
|
|
|
534 |
<div class="long">
|
|
|
535 |
Returns true if client-side validation on the form is successful. <div class="mdetail-params">
|
|
|
536 |
<strong>Parameters:</strong>
|
|
|
537 |
<ul><li>None.</li> </ul>
|
|
|
538 |
<strong>Returns:</strong>
|
|
|
539 |
<ul>
|
|
|
540 |
<li><code>Boolean</code></li>
|
|
|
541 |
</ul>
|
|
|
542 |
</div>
|
|
|
543 |
</div>
|
|
|
544 |
</div>
|
|
|
545 |
</td>
|
|
|
546 |
<td class="msource">BasicForm</td>
|
|
|
547 |
</tr>
|
|
|
548 |
<tr class="method-row alt expandable">
|
|
|
549 |
<td class="micon"><a class="exi" href="#expand"> </a></td>
|
|
|
550 |
<td class="sig">
|
|
|
551 |
<a id="Ext.form.BasicForm-load"></a>
|
|
|
552 |
<b>load</b>( <code>Object options</code> ) : BasicForm <div class="mdesc">
|
|
|
553 |
<div class="short">Shortcut to do a load action.</div>
|
|
|
554 |
<div class="long">
|
|
|
555 |
Shortcut to do a load action. <div class="mdetail-params">
|
|
|
556 |
<strong>Parameters:</strong>
|
|
|
557 |
<ul><li><code>options</code> : Object<div class="sub-desc">The options to pass to the action (see <a ext:cls="Ext.form.BasicForm" ext:member="doAction" href="output/Ext.form.BasicForm.html#doAction">doAction</a> for details)</div></li> </ul>
|
|
|
558 |
<strong>Returns:</strong>
|
|
|
559 |
<ul>
|
|
|
560 |
<li><code>BasicForm</code><div class="sub-desc">this</div></li>
|
|
|
561 |
</ul>
|
|
|
562 |
</div>
|
|
|
563 |
</div>
|
|
|
564 |
</div>
|
|
|
565 |
</td>
|
|
|
566 |
<td class="msource">BasicForm</td>
|
|
|
567 |
</tr>
|
|
|
568 |
<tr class="method-row expandable">
|
|
|
569 |
<td class="micon"><a class="exi" href="#expand"> </a></td>
|
|
|
570 |
<td class="sig">
|
|
|
571 |
<a id="Ext.form.BasicForm-loadRecord"></a>
|
|
|
572 |
<b>loadRecord</b>( <code>Record record</code> ) : BasicForm <div class="mdesc">
|
|
|
573 |
<div class="short">Loads an Ext.data.Record into this form.</div>
|
|
|
574 |
<div class="long">
|
|
|
575 |
Loads an Ext.data.Record into this form. <div class="mdetail-params">
|
|
|
576 |
<strong>Parameters:</strong>
|
|
|
577 |
<ul><li><code>record</code> : Record<div class="sub-desc">The record to load</div></li> </ul>
|
|
|
578 |
<strong>Returns:</strong>
|
|
|
579 |
<ul>
|
|
|
580 |
<li><code>BasicForm</code><div class="sub-desc">this</div></li>
|
|
|
581 |
</ul>
|
|
|
582 |
</div>
|
|
|
583 |
</div>
|
|
|
584 |
</div>
|
|
|
585 |
</td>
|
|
|
586 |
<td class="msource">BasicForm</td>
|
|
|
587 |
</tr>
|
|
|
588 |
<tr class="method-row alt expandable">
|
|
|
589 |
<td class="micon"><a class="exi" href="#expand"> </a></td>
|
|
|
590 |
<td class="sig">
|
|
|
591 |
<a id="Ext.form.BasicForm-markInvalid"></a>
|
|
|
592 |
<b>markInvalid</b>( <code>Array/Object errors</code> ) : BasicForm <div class="mdesc">
|
|
|
593 |
<div class="short">Mark fields in this form invalid in bulk.</div>
|
|
|
594 |
<div class="long">
|
|
|
595 |
Mark fields in this form invalid in bulk. <div class="mdetail-params">
|
|
|
596 |
<strong>Parameters:</strong>
|
|
|
597 |
<ul><li><code>errors</code> : Array/Object<div class="sub-desc">Either an array in the form [{id:'fieldId', msg:'The message'},...] or an object hash of {id: msg, id2: msg2}</div></li> </ul>
|
|
|
598 |
<strong>Returns:</strong>
|
|
|
599 |
<ul>
|
|
|
600 |
<li><code>BasicForm</code><div class="sub-desc">this</div></li>
|
|
|
601 |
</ul>
|
|
|
602 |
</div>
|
|
|
603 |
</div>
|
|
|
604 |
</div>
|
|
|
605 |
</td>
|
|
|
606 |
<td class="msource">BasicForm</td>
|
|
|
607 |
</tr>
|
|
|
608 |
<tr class="method-row inherited expandable">
|
|
|
609 |
<td class="micon"><a class="exi" href="#expand"> </a></td>
|
|
|
610 |
<td class="sig">
|
|
|
611 |
<a id="Ext.form.BasicForm-on"></a>
|
|
|
612 |
<b>on</b>( <code>String eventName</code>, <code>Function handler</code>, <span class="optional" title="Optional">[<code>Object scope</code>]</span>, <span class="optional" title="Optional">[<code>Object options</code>]</span> ) : void <div class="mdesc">
|
|
|
613 |
<div class="short">Appends an event handler to this element (shorthand for addListener)</div>
|
|
|
614 |
<div class="long">
|
|
|
615 |
Appends an event handler to this element (shorthand for addListener) <div class="mdetail-params">
|
|
|
616 |
<strong>Parameters:</strong>
|
|
|
617 |
<ul><li><code>eventName</code> : String<div class="sub-desc">The type of event to listen for</div></li><li><code>handler</code> : Function<div class="sub-desc">The method the event invokes</div></li><li><code>scope</code> : Object<div class="sub-desc">(optional) The scope in which to execute the handler
|
|
|
618 |
function. The handler function's "this" context.</div></li><li><code>options</code> : Object<div class="sub-desc">(optional)</div></li> </ul>
|
|
|
619 |
<strong>Returns:</strong>
|
|
|
620 |
<ul>
|
|
|
621 |
<li><code>void</code></li>
|
|
|
622 |
</ul>
|
|
|
623 |
</div>
|
|
|
624 |
</div>
|
|
|
625 |
</div>
|
|
|
626 |
</td>
|
|
|
627 |
<td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#on" href="output/Ext.util.Observable.html#on">Observable</a></td>
|
|
|
628 |
</tr>
|
|
|
629 |
<tr class="method-row inherited alt expandable">
|
|
|
630 |
<td class="micon"><a class="exi" href="#expand"> </a></td>
|
|
|
631 |
<td class="sig">
|
|
|
632 |
<a id="Ext.form.BasicForm-purgeListeners"></a>
|
|
|
633 |
<b>purgeListeners</b>() : void <div class="mdesc">
|
|
|
634 |
<div class="short">Removes all listeners for this object</div>
|
|
|
635 |
<div class="long">
|
|
|
636 |
Removes all listeners for this object <div class="mdetail-params">
|
|
|
637 |
<strong>Parameters:</strong>
|
|
|
638 |
<ul><li>None.</li> </ul>
|
|
|
639 |
<strong>Returns:</strong>
|
|
|
640 |
<ul>
|
|
|
641 |
<li><code>void</code></li>
|
|
|
642 |
</ul>
|
|
|
643 |
</div>
|
|
|
644 |
</div>
|
|
|
645 |
</div>
|
|
|
646 |
</td>
|
|
|
647 |
<td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#purgeListeners" href="output/Ext.util.Observable.html#purgeListeners">Observable</a></td>
|
|
|
648 |
</tr>
|
|
|
649 |
<tr class="method-row expandable">
|
|
|
650 |
<td class="micon"><a class="exi" href="#expand"> </a></td>
|
|
|
651 |
<td class="sig">
|
|
|
652 |
<a id="Ext.form.BasicForm-remove"></a>
|
|
|
653 |
<b>remove</b>( <code>Field field</code> ) : BasicForm <div class="mdesc">
|
|
|
654 |
<div class="short">Removes a field from the items collection (does NOT remove its markup).</div>
|
|
|
655 |
<div class="long">
|
|
|
656 |
Removes a field from the items collection (does NOT remove its markup). <div class="mdetail-params">
|
|
|
657 |
<strong>Parameters:</strong>
|
|
|
658 |
<ul><li><code>field</code> : Field<div class="sub-desc"></div></li> </ul>
|
|
|
659 |
<strong>Returns:</strong>
|
|
|
660 |
<ul>
|
|
|
661 |
<li><code>BasicForm</code><div class="sub-desc">this</div></li>
|
|
|
662 |
</ul>
|
|
|
663 |
</div>
|
|
|
664 |
</div>
|
|
|
665 |
</div>
|
|
|
666 |
</td>
|
|
|
667 |
<td class="msource">BasicForm</td>
|
|
|
668 |
</tr>
|
|
|
669 |
<tr class="method-row inherited alt expandable">
|
|
|
670 |
<td class="micon"><a class="exi" href="#expand"> </a></td>
|
|
|
671 |
<td class="sig">
|
|
|
672 |
<a id="Ext.form.BasicForm-removeListener"></a>
|
|
|
673 |
<b>removeListener</b>( <code>String eventName</code>, <code>Function handler</code>, <span class="optional" title="Optional">[<code>Object scope</code>]</span> ) : void <div class="mdesc">
|
|
|
674 |
<div class="short">Removes a listener</div>
|
|
|
675 |
<div class="long">
|
|
|
676 |
Removes a listener <div class="mdetail-params">
|
|
|
677 |
<strong>Parameters:</strong>
|
|
|
678 |
<ul><li><code>eventName</code> : String<div class="sub-desc">The type of event to listen for</div></li><li><code>handler</code> : Function<div class="sub-desc">The handler to remove</div></li><li><code>scope</code> : Object<div class="sub-desc">(optional) The scope (this object) for the handler</div></li> </ul>
|
|
|
679 |
<strong>Returns:</strong>
|
|
|
680 |
<ul>
|
|
|
681 |
<li><code>void</code></li>
|
|
|
682 |
</ul>
|
|
|
683 |
</div>
|
|
|
684 |
</div>
|
|
|
685 |
</div>
|
|
|
686 |
</td>
|
|
|
687 |
<td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#removeListener" href="output/Ext.util.Observable.html#removeListener">Observable</a></td>
|
|
|
688 |
</tr>
|
|
|
689 |
<tr class="method-row expandable">
|
|
|
690 |
<td class="micon"><a class="exi" href="#expand"> </a></td>
|
|
|
691 |
<td class="sig">
|
|
|
692 |
<a id="Ext.form.BasicForm-render"></a>
|
|
|
693 |
<b>render</b>() : BasicForm <div class="mdesc">
|
|
|
694 |
<div class="short">Looks at the fields in this form, checks them for an id attribute,
|
|
|
695 |
and calls applyTo on the existing dom element with...</div>
|
|
|
696 |
<div class="long">
|
|
|
697 |
Looks at the fields in this form, checks them for an id attribute,
|
|
|
698 |
and calls applyTo on the existing dom element with that id. <div class="mdetail-params">
|
|
|
699 |
<strong>Parameters:</strong>
|
|
|
700 |
<ul><li>None.</li> </ul>
|
|
|
701 |
<strong>Returns:</strong>
|
|
|
702 |
<ul>
|
|
|
703 |
<li><code>BasicForm</code><div class="sub-desc">this</div></li>
|
|
|
704 |
</ul>
|
|
|
705 |
</div>
|
|
|
706 |
</div>
|
|
|
707 |
</div>
|
|
|
708 |
</td>
|
|
|
709 |
<td class="msource">BasicForm</td>
|
|
|
710 |
</tr>
|
|
|
711 |
<tr class="method-row alt expandable">
|
|
|
712 |
<td class="micon"><a class="exi" href="#expand"> </a></td>
|
|
|
713 |
<td class="sig">
|
|
|
714 |
<a id="Ext.form.BasicForm-reset"></a>
|
|
|
715 |
<b>reset</b>() : BasicForm <div class="mdesc">
|
|
|
716 |
<div class="short">Resets this form.</div>
|
|
|
717 |
<div class="long">
|
|
|
718 |
Resets this form. <div class="mdetail-params">
|
|
|
719 |
<strong>Parameters:</strong>
|
|
|
720 |
<ul><li>None.</li> </ul>
|
|
|
721 |
<strong>Returns:</strong>
|
|
|
722 |
<ul>
|
|
|
723 |
<li><code>BasicForm</code><div class="sub-desc">this</div></li>
|
|
|
724 |
</ul>
|
|
|
725 |
</div>
|
|
|
726 |
</div>
|
|
|
727 |
</div>
|
|
|
728 |
</td>
|
|
|
729 |
<td class="msource">BasicForm</td>
|
|
|
730 |
</tr>
|
|
|
731 |
<tr class="method-row inherited expandable">
|
|
|
732 |
<td class="micon"><a class="exi" href="#expand"> </a></td>
|
|
|
733 |
<td class="sig">
|
|
|
734 |
<a id="Ext.form.BasicForm-resumeEvents"></a>
|
|
|
735 |
<b>resumeEvents</b>() : void <div class="mdesc">
|
|
|
736 |
<div class="short">Resume firing events. (see <a ext:cls="Ext.util.Observable" ext:member="suspendEvents" href="output/Ext.util.Observable.html#suspendEvents">suspendEvents</a>)</div>
|
|
|
737 |
<div class="long">
|
|
|
738 |
Resume firing events. (see <a ext:cls="Ext.util.Observable" ext:member="suspendEvents" href="output/Ext.util.Observable.html#suspendEvents">suspendEvents</a>) <div class="mdetail-params">
|
|
|
739 |
<strong>Parameters:</strong>
|
|
|
740 |
<ul><li>None.</li> </ul>
|
|
|
741 |
<strong>Returns:</strong>
|
|
|
742 |
<ul>
|
|
|
743 |
<li><code>void</code></li>
|
|
|
744 |
</ul>
|
|
|
745 |
</div>
|
|
|
746 |
</div>
|
|
|
747 |
</div>
|
|
|
748 |
</td>
|
|
|
749 |
<td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#resumeEvents" href="output/Ext.util.Observable.html#resumeEvents">Observable</a></td>
|
|
|
750 |
</tr>
|
|
|
751 |
<tr class="method-row alt expandable">
|
|
|
752 |
<td class="micon"><a class="exi" href="#expand"> </a></td>
|
|
|
753 |
<td class="sig">
|
|
|
754 |
<a id="Ext.form.BasicForm-setValues"></a>
|
|
|
755 |
<b>setValues</b>( <code>Array/Object values</code> ) : BasicForm <div class="mdesc">
|
|
|
756 |
<div class="short">Set values for fields in this form in bulk.</div>
|
|
|
757 |
<div class="long">
|
|
|
758 |
Set values for fields in this form in bulk. <div class="mdetail-params">
|
|
|
759 |
<strong>Parameters:</strong>
|
|
|
760 |
<ul><li><code>values</code> : Array/Object<div class="sub-desc">Either an array in the form:<br><br><code><pre>[{id:'clientName', value:'Fred. Olsen Lines'},
|
|
|
761 |
{id:'portOfLoading', value:'FXT'},
|
|
|
762 |
{id:'portOfDischarge', value:'OSL'} ]</pre></code><br><br>
|
|
|
763 |
or an object hash of the form:<br><br><code><pre>{
|
|
|
764 |
clientName: 'Fred. Olsen Lines',
|
|
|
765 |
portOfLoading: 'FXT',
|
|
|
766 |
portOfDischarge: 'OSL'
|
|
|
767 |
}</pre></code><br></div></li> </ul>
|
|
|
768 |
<strong>Returns:</strong>
|
|
|
769 |
<ul>
|
|
|
770 |
<li><code>BasicForm</code><div class="sub-desc">this</div></li>
|
|
|
771 |
</ul>
|
|
|
772 |
</div>
|
|
|
773 |
</div>
|
|
|
774 |
</div>
|
|
|
775 |
</td>
|
|
|
776 |
<td class="msource">BasicForm</td>
|
|
|
777 |
</tr>
|
|
|
778 |
<tr class="method-row expandable">
|
|
|
779 |
<td class="micon"><a class="exi" href="#expand"> </a></td>
|
|
|
780 |
<td class="sig">
|
|
|
781 |
<a id="Ext.form.BasicForm-submit"></a>
|
|
|
782 |
<b>submit</b>( <code>Object options</code> ) : BasicForm <div class="mdesc">
|
|
|
783 |
<div class="short">Shortcut to do a submit action.</div>
|
|
|
784 |
<div class="long">
|
|
|
785 |
Shortcut to do a submit action. <div class="mdetail-params">
|
|
|
786 |
<strong>Parameters:</strong>
|
|
|
787 |
<ul><li><code>options</code> : Object<div class="sub-desc">The options to pass to the action (see <a ext:cls="Ext.form.BasicForm" ext:member="doAction" href="output/Ext.form.BasicForm.html#doAction">doAction</a> for details)</div></li> </ul>
|
|
|
788 |
<strong>Returns:</strong>
|
|
|
789 |
<ul>
|
|
|
790 |
<li><code>BasicForm</code><div class="sub-desc">this</div></li>
|
|
|
791 |
</ul>
|
|
|
792 |
</div>
|
|
|
793 |
</div>
|
|
|
794 |
</div>
|
|
|
795 |
</td>
|
|
|
796 |
<td class="msource">BasicForm</td>
|
|
|
797 |
</tr>
|
|
|
798 |
<tr class="method-row inherited alt expandable">
|
|
|
799 |
<td class="micon"><a class="exi" href="#expand"> </a></td>
|
|
|
800 |
<td class="sig">
|
|
|
801 |
<a id="Ext.form.BasicForm-suspendEvents"></a>
|
|
|
802 |
<b>suspendEvents</b>() : void <div class="mdesc">
|
|
|
803 |
<div class="short">Suspend the firing of all events. (see <a ext:cls="Ext.util.Observable" ext:member="resumeEvents" href="output/Ext.util.Observable.html#resumeEvents">resumeEvents</a>)</div>
|
|
|
804 |
<div class="long">
|
|
|
805 |
Suspend the firing of all events. (see <a ext:cls="Ext.util.Observable" ext:member="resumeEvents" href="output/Ext.util.Observable.html#resumeEvents">resumeEvents</a>) <div class="mdetail-params">
|
|
|
806 |
<strong>Parameters:</strong>
|
|
|
807 |
<ul><li>None.</li> </ul>
|
|
|
808 |
<strong>Returns:</strong>
|
|
|
809 |
<ul>
|
|
|
810 |
<li><code>void</code></li>
|
|
|
811 |
</ul>
|
|
|
812 |
</div>
|
|
|
813 |
</div>
|
|
|
814 |
</div>
|
|
|
815 |
</td>
|
|
|
816 |
<td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#suspendEvents" href="output/Ext.util.Observable.html#suspendEvents">Observable</a></td>
|
|
|
817 |
</tr>
|
|
|
818 |
<tr class="method-row inherited expandable">
|
|
|
819 |
<td class="micon"><a class="exi" href="#expand"> </a></td>
|
|
|
820 |
<td class="sig">
|
|
|
821 |
<a id="Ext.form.BasicForm-un"></a>
|
|
|
822 |
<b>un</b>( <code>String eventName</code>, <code>Function handler</code>, <span class="optional" title="Optional">[<code>Object scope</code>]</span> ) : void <div class="mdesc">
|
|
|
823 |
<div class="short">Removes a listener (shorthand for removeListener)</div>
|
|
|
824 |
<div class="long">
|
|
|
825 |
Removes a listener (shorthand for removeListener) <div class="mdetail-params">
|
|
|
826 |
<strong>Parameters:</strong>
|
|
|
827 |
<ul><li><code>eventName</code> : String<div class="sub-desc">The type of event to listen for</div></li><li><code>handler</code> : Function<div class="sub-desc">The handler to remove</div></li><li><code>scope</code> : Object<div class="sub-desc">(optional) The scope (this object) for the handler</div></li> </ul>
|
|
|
828 |
<strong>Returns:</strong>
|
|
|
829 |
<ul>
|
|
|
830 |
<li><code>void</code></li>
|
|
|
831 |
</ul>
|
|
|
832 |
</div>
|
|
|
833 |
</div>
|
|
|
834 |
</div>
|
|
|
835 |
</td>
|
|
|
836 |
<td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#un" href="output/Ext.util.Observable.html#un">Observable</a></td>
|
|
|
837 |
</tr>
|
|
|
838 |
<tr class="method-row alt expandable">
|
|
|
839 |
<td class="micon"><a class="exi" href="#expand"> </a></td>
|
|
|
840 |
<td class="sig">
|
|
|
841 |
<a id="Ext.form.BasicForm-updateRecord"></a>
|
|
|
842 |
<b>updateRecord</b>( <code>Record record</code> ) : BasicForm <div class="mdesc">
|
|
|
843 |
<div class="short">Persists the values in this form into the passed Ext.data.Record object in a beginEdit/endEdit block.</div>
|
|
|
844 |
<div class="long">
|
|
|
845 |
Persists the values in this form into the passed Ext.data.Record object in a beginEdit/endEdit block. <div class="mdetail-params">
|
|
|
846 |
<strong>Parameters:</strong>
|
|
|
847 |
<ul><li><code>record</code> : Record<div class="sub-desc">The record to edit</div></li> </ul>
|
|
|
848 |
<strong>Returns:</strong>
|
|
|
849 |
<ul>
|
|
|
850 |
<li><code>BasicForm</code><div class="sub-desc">this</div></li>
|
|
|
851 |
</ul>
|
|
|
852 |
</div>
|
|
|
853 |
</div>
|
|
|
854 |
</div>
|
|
|
855 |
</td>
|
|
|
856 |
<td class="msource">BasicForm</td>
|
|
|
857 |
</tr>
|
|
|
858 |
</table>
|
|
|
859 |
<a id="Ext.form.BasicForm-events"></a>
|
|
|
860 |
<h2>Public Events</h2>
|
|
|
861 |
<table cellspacing="0" class="member-table">
|
|
|
862 |
<tr>
|
|
|
863 |
<th class="sig-header" colspan="2">Event</th>
|
|
|
864 |
<th class="msource-header">Defined By</th>
|
|
|
865 |
</tr>
|
|
|
866 |
<tr class="event-row expandable">
|
|
|
867 |
<td class="micon"><a class="exi" href="#expand"> </a></td>
|
|
|
868 |
<td class="sig">
|
|
|
869 |
<a id="Ext.form.BasicForm-actioncomplete"></a>
|
|
|
870 |
<b>actioncomplete</b> : ( <code>Form this</code>, <code>Action action</code> ) <div class="mdesc">
|
|
|
871 |
<div class="short">Fires when an action is completed.</div>
|
|
|
872 |
<div class="long">
|
|
|
873 |
Fires when an action is completed. <div class="mdetail-params">
|
|
|
874 |
<strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>
|
|
|
875 |
<ul><li><code>this</code> : Form<div class="sub-desc"></div></li><li><code>action</code> : Action<div class="sub-desc">The <a ext:cls="Ext.form.Action" href="output/Ext.form.Action.html">Ext.form.Action</a> that completed</div></li> </ul>
|
|
|
876 |
</div>
|
|
|
877 |
</div>
|
|
|
878 |
</div>
|
|
|
879 |
</td>
|
|
|
880 |
<td class="msource">BasicForm</td>
|
|
|
881 |
</tr>
|
|
|
882 |
<tr class="event-row alt expandable">
|
|
|
883 |
<td class="micon"><a class="exi" href="#expand"> </a></td>
|
|
|
884 |
<td class="sig">
|
|
|
885 |
<a id="Ext.form.BasicForm-actionfailed"></a>
|
|
|
886 |
<b>actionfailed</b> : ( <code>Form this</code>, <code>Action action</code> ) <div class="mdesc">
|
|
|
887 |
<div class="short">Fires when an action fails.</div>
|
|
|
888 |
<div class="long">
|
|
|
889 |
Fires when an action fails. <div class="mdetail-params">
|
|
|
890 |
<strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>
|
|
|
891 |
<ul><li><code>this</code> : Form<div class="sub-desc"></div></li><li><code>action</code> : Action<div class="sub-desc">The <a ext:cls="Ext.form.Action" href="output/Ext.form.Action.html">Ext.form.Action</a> that failed</div></li> </ul>
|
|
|
892 |
</div>
|
|
|
893 |
</div>
|
|
|
894 |
</div>
|
|
|
895 |
</td>
|
|
|
896 |
<td class="msource">BasicForm</td>
|
|
|
897 |
</tr>
|
|
|
898 |
<tr class="event-row expandable">
|
|
|
899 |
<td class="micon"><a class="exi" href="#expand"> </a></td>
|
|
|
900 |
<td class="sig">
|
|
|
901 |
<a id="Ext.form.BasicForm-beforeaction"></a>
|
|
|
902 |
<b>beforeaction</b> : ( <code>Form this</code>, <code>Action action</code> ) <div class="mdesc">
|
|
|
903 |
<div class="short">Fires before any action is performed. Return false to cancel the action.</div>
|
|
|
904 |
<div class="long">
|
|
|
905 |
Fires before any action is performed. Return false to cancel the action. <div class="mdetail-params">
|
|
|
906 |
<strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>
|
|
|
907 |
<ul><li><code>this</code> : Form<div class="sub-desc"></div></li><li><code>action</code> : Action<div class="sub-desc">The <a ext:cls="Ext.form.Action" href="output/Ext.form.Action.html">Ext.form.Action</a> to be performed</div></li> </ul>
|
|
|
908 |
</div>
|
|
|
909 |
</div>
|
|
|
910 |
</div>
|
|
|
911 |
</td>
|
|
|
912 |
<td class="msource">BasicForm</td>
|
|
|
913 |
</tr>
|
|
|
914 |
</table>
|
|
|
915 |
|
|
|
916 |
</div>
|