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