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