Subversion Repositories eFlore/Applications.cel

Rev

Go to most recent revision | Details | Last modification | View Log | RSS feed

Rev Author Line No. Line
2 aperonnet 1 
        <div class="body-wrap">
2 
        <div class="top-tools">
3 
            <a class="inner-link" href="#Ext.form.Action-props"><img src="../resources/images/default/s.gif" class="item-icon icon-prop">Properties</a>
4 
            <a class="inner-link" href="#Ext.form.Action-methods"><img src="../resources/images/default/s.gif" class="item-icon icon-method">Methods</a>
5 
            <a class="inner-link" href="#Ext.form.Action-events"><img src="../resources/images/default/s.gif" class="item-icon icon-event">Events</a>
6 
                            <a class="inner-link" href="#Ext.form.Action-configs"><img src="../resources/images/default/s.gif" class="item-icon icon-config">Config Options</a>
7 
                        <a class="bookmark" href="../docs/?class=Ext.form.Action"><img src="../resources/images/default/s.gif" class="item-icon icon-fav">Direct Link</a>
8 
        </div>
9 
                <h1>Class Ext.form.Action</h1>
10 
        <table cellspacing="0">
11 
            <tr><td class="label">Package:</td><td class="hd-info">Ext.form</td></tr>
12 
            <tr><td class="label">Defined In:</td><td class="hd-info"><a href="../source/widgets/form/Action.js" target="_blank">Action.js</a></td></tr>
13 
            <tr><td class="label">Class:</td><td class="hd-info">Action</td></tr>
14 
                        <tr><td class="label">Subclasses:</td><td class="hd-info"><a ext:cls="Ext.form.Action.Load" href="output/Ext.form.Action.Load.html">Action.Load</a>, <a ext:cls="Ext.form.Action.Submit" href="output/Ext.form.Action.Submit.html">Action.Submit</a></td></tr>
15 
                                    <tr><td class="label">Extends:</td><td class="hd-info">Object</td></tr>
16 
                    </table>
17 
        <div class="description">
18 
            The subclasses of this class provide actions to perform upon <a ext:cls="Ext.form.BasicForm" href="output/Ext.form.BasicForm.html">Form</a>s.
19 
<br><br>
20 
Instances of this class are only created by a <a ext:cls="Ext.form.BasicForm" href="output/Ext.form.BasicForm.html">Form</a> when
21 
the Form needs to perform an action such as submit or load. The Configuration options
22 
listed for this class are set through the Form's action methods: <a ext:cls="Ext.form.BasicForm" ext:member="submit" href="output/Ext.form.BasicForm.html#submit">submit</a>,
23 
<a ext:cls="Ext.form.BasicForm" ext:member="load" href="output/Ext.form.BasicForm.html#load">load</a> and <a ext:cls="Ext.form.BasicForm" ext:member="doAction" href="output/Ext.form.BasicForm.html#doAction">doAction</a>.
24 
<br><br>
25 
The instance of Action which performed the action is passed to the success
26 
and failure callbacks of the Form's action methods (<a ext:cls="Ext.form.BasicForm" ext:member="submit" href="output/Ext.form.BasicForm.html#submit">submit</a>,
27 
<a ext:cls="Ext.form.BasicForm" ext:member="load" href="output/Ext.form.BasicForm.html#load">load</a> and <a ext:cls="Ext.form.BasicForm" ext:member="doAction" href="output/Ext.form.BasicForm.html#doAction">doAction</a>),
28 
and to the <a ext:cls="Ext.form.BasicForm" ext:member="actioncomplete" href="output/Ext.form.BasicForm.html#actioncomplete">actioncomplete</a> and
29 
<a ext:cls="Ext.form.BasicForm" ext:member="actionfailed" href="output/Ext.form.BasicForm.html#actionfailed">actionfailed</a> event handlers.        </div>
30 
 
31 
        <div class="hr"></div>
32 
                <a id="Ext.form.Action-configs"></a>
33 
        <h2>Config Options</h2>
34 
        <table cellspacing="0" class="member-table">
35 
            <tr>
36 
                <th class="sig-header" colspan="2">Config Options</th>
37 
                <th class="msource-header">Defined By</th>
38 
            </tr>
39 
                <tr class="config-row expandable">
40 
        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
41 
        <td class="sig">
42 
        <a id="Ext.form.Action-failure"></a>
43 
            <b>failure</b> : Function            <div class="mdesc">
44 
                        <div class="short">The function to call when a failure packet was recieved, or when an error ocurred in the Ajax communication. The func...</div>
45 
            <div class="long">
46 
                The function to call when a failure packet was recieved, or when an error ocurred in the Ajax communication. The function is passed the following parameters:<ul class="mdetail-params"> <li><b>form</b> : Ext.form.BasicForm<div class="sub-desc">The form that requested the action</div></li> <li><b>action</b> : Ext.form.Action<div class="sub-desc">The Action class. If an Ajax error ocurred, the failure type will be in <a ext:cls="Ext.form.Action" ext:member="failureType" href="output/Ext.form.Action.html#failureType">failureType</a>. The <a ext:cls="Ext.form.Action" ext:member="result" href="output/Ext.form.Action.html#result">result</a> property of this object may be examined to perform custom postprocessing.</div></li> </ul>            </div>
47 
                        </div>
48 
        </td>
49 
        <td class="msource">Action</td>
50 
    </tr>
51 
        <tr class="config-row alt expandable">
52 
        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
53 
        <td class="sig">
54 
        <a id="Ext.form.Action-method"></a>
55 
            <b>method</b> : String            <div class="mdesc">
56 
                        <div class="short">The HTTP method to use to access the requested URL. Defaults to the Ext.form.BasicForm's method, or if that is not sp...</div>
57 
            <div class="long">
58 
                The HTTP method to use to access the requested URL. Defaults to the <a ext:cls="Ext.form.BasicForm" href="output/Ext.form.BasicForm.html">Ext.form.BasicForm</a>'s method, or if that is not specified, the underlying DOM form's method.            </div>
59 
                        </div>
60 
        </td>
61 
        <td class="msource">Action</td>
62 
    </tr>
63 
        <tr class="config-row expandable">
64 
        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
65 
        <td class="sig">
66 
        <a id="Ext.form.Action-params"></a>
67 
            <b>params</b> : Mixed            <div class="mdesc">
68 
                        <div class="short">Extra parameter values to pass. These are added to the Form's Ext.form.BasicForm.baseParams and passed to the specifi...</div>
69 
            <div class="long">
70 
                Extra parameter values to pass. These are added to the Form's <a ext:cls="Ext.form.BasicForm" ext:member="baseParams" href="output/Ext.form.BasicForm.html#baseParams">Ext.form.BasicForm.baseParams</a> and passed to the specified URL along with the Form's input fields.            </div>
71 
                        </div>
72 
        </td>
73 
        <td class="msource">Action</td>
74 
    </tr>
75 
        <tr class="config-row alt">
76 
        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
77 
        <td class="sig">
78 
        <a id="Ext.form.Action-scope"></a>
79 
            <b>scope</b> : Object            <div class="mdesc">
80 
                            The scope in which to call the callback functions (The <tt>this</tt> reference for the callback functions).                        </div>
81 
        </td>
82 
        <td class="msource">Action</td>
83 
    </tr>
84 
        <tr class="config-row expandable">
85 
        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
86 
        <td class="sig">
87 
        <a id="Ext.form.Action-success"></a>
88 
            <b>success</b> : Function            <div class="mdesc">
89 
                        <div class="short">The function to call when a valid success return packet is recieved. The function is passed the following parameters:...</div>
90 
            <div class="long">
91 
                The function to call when a valid success return packet is recieved. The function is passed the following parameters:<ul class="mdetail-params"> <li><b>form</b> : Ext.form.BasicForm<div class="sub-desc">The form that requested the action</div></li> <li><b>action</b> : Ext.form.Action<div class="sub-desc">The Action class. The <a ext:cls="Ext.form.Action" ext:member="result" href="output/Ext.form.Action.html#result">result</a> property of this object may be examined to perform custom postprocessing.</div></li> </ul>            </div>
92 
                        </div>
93 
        </td>
94 
        <td class="msource">Action</td>
95 
    </tr>
96 
        <tr class="config-row alt">
97 
        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
98 
        <td class="sig">
99 
        <a id="Ext.form.Action-url"></a>
100 
            <b>url</b> : String            <div class="mdesc">
101 
                            The URL that the Action is to invoke.                        </div>
102 
        </td>
103 
        <td class="msource">Action</td>
104 
    </tr>
105 
        <tr class="config-row">
106 
        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
107 
        <td class="sig">
108 
        <a id="Ext.form.Action-waitMsg"></a>
109 
            <b>waitMsg</b> : String            <div class="mdesc">
110 
                            The message to be displayed by a call to <a ext:cls="Ext.MessageBox" ext:member="wait" href="output/Ext.MessageBox.html#wait">Ext.MessageBox.wait</a> during the time the action is being processed.                        </div>
111 
        </td>
112 
        <td class="msource">Action</td>
113 
    </tr>
114 
        <tr class="config-row alt">
115 
        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
116 
        <td class="sig">
117 
        <a id="Ext.form.Action-waitTitle"></a>
118 
            <b>waitTitle</b> : String            <div class="mdesc">
119 
                            The title to be displayed by a call to <a ext:cls="Ext.MessageBox" ext:member="wait" href="output/Ext.MessageBox.html#wait">Ext.MessageBox.wait</a> during the time the action is being processed.                        </div>
120 
        </td>
121 
        <td class="msource">Action</td>
122 
    </tr>
123 
            </table>
124 
                <a id="Ext.form.Action-props"></a>
125 
        <h2>Public Properties</h2>
126 
                <table cellspacing="0" class="member-table">
127 
            <tr>
128 
                <th class="sig-header" colspan="2">Property</th>
129 
                <th class="msource-header">Defined By</th>
130 
            </tr>
131 
                <tr class="property-row">
132 
        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
133 
        <td class="sig">
134 
        <a id="Ext.form.Action-Action.CLIENT_INVALID"></a>
135 
            <b>Action.CLIENT_INVALID</b> : String            <div class="mdesc">
136 
                            &lt;static&gt; Failure type returned when client side validation of the Form fails
137 
thus aborting a submit action.                        </div>
138 
        </td>
139 
        <td class="msource">Action</td>
140 
    </tr>
141 
        <tr class="property-row alt expandable">
142 
        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
143 
        <td class="sig">
144 
        <a id="Ext.form.Action-Action.CONNECT_FAILURE"></a>
145 
            <b>Action.CONNECT_FAILURE</b> : String            <div class="mdesc">
146 
                        <div class="short">&lt;static&gt; Failure type returned when a communication error happens when attempting
147 
to send a request to the remo...</div>
148 
            <div class="long">
149 
                &lt;static&gt; Failure type returned when a communication error happens when attempting
150 
to send a request to the remote server.            </div>
151 
                        </div>
152 
        </td>
153 
        <td class="msource">Action</td>
154 
    </tr>
155 
        <tr class="property-row">
156 
        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
157 
        <td class="sig">
158 
        <a id="Ext.form.Action-Action.LOAD_FAILURE"></a>
159 
            <b>Action.LOAD_FAILURE</b> : String            <div class="mdesc">
160 
                            &lt;static&gt; Failure type returned when no field values are returned in the response's
161 
<tt style="font-weight:bold">data</tt> property.                        </div>
162 
        </td>
163 
        <td class="msource">Action</td>
164 
    </tr>
165 
        <tr class="property-row alt expandable">
166 
        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
167 
        <td class="sig">
168 
        <a id="Ext.form.Action-Action.SERVER_INVALID"></a>
169 
            <b>Action.SERVER_INVALID</b> : String            <div class="mdesc">
170 
                        <div class="short">&lt;static&gt; Failure type returned when server side validation of the Form fails
171 
indicating that field-specific err...</div>
172 
            <div class="long">
173 
                &lt;static&gt; Failure type returned when server side validation of the Form fails
174 
indicating that field-specific error messages have been returned in the
175 
response's <tt style="font-weight:bold">errors</tt> property.            </div>
176 
                        </div>
177 
        </td>
178 
        <td class="msource">Action</td>
179 
    </tr>
180 
        <tr class="property-row">
181 
        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
182 
        <td class="sig">
183 
        <a id="Ext.form.Action-failureType"></a>
184 
            <b>failureType</b> : String            <div class="mdesc">
185 
                            The type of failure detected. See <a ext:cls="Ext.form.Action" ext:member="Ext.form.Action.CLIENT_INVALID" href="output/Ext.form.Action.html#Ext.form.Action.CLIENT_INVALID">CLIENT_INVALID</a>, <a ext:cls="Ext.form.Action" ext:member="Ext.form.Action.SERVER_INVALID" href="output/Ext.form.Action.html#Ext.form.Action.SERVER_INVALID">SERVER_INVALID</a>,
186 
<a ext:cls="Ext.form.Action" ext:member="Ext.form.Action.CONNECT_FAILURE" href="output/Ext.form.Action.html#Ext.form.Action.CONNECT_FAILURE">CONNECT_FAILURE</a>, <a ext:cls="Ext.form.Action" ext:member="Ext.form.Action.LOAD_FAILURE" href="output/Ext.form.Action.html#Ext.form.Action.LOAD_FAILURE">LOAD_FAILURE</a>                        </div>
187 
        </td>
188 
        <td class="msource">Action</td>
189 
    </tr>
190 
        <tr class="property-row alt">
191 
        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
192 
        <td class="sig">
193 
        <a id="Ext.form.Action-response"></a>
194 
            <b>response</b> : Object            <div class="mdesc">
195 
 
196 
The XMLHttpRequest object used to perform the action.                        </div>
197 
        </td>
198 
        <td class="msource">Action</td>
199 
    </tr>
200 
        <tr class="property-row">
201 
        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
202 
        <td class="sig">
203 
        <a id="Ext.form.Action-result"></a>
204 
            <b>result</b> : Object            <div class="mdesc">
205 
 
206 
The decoded response object containing a boolean <tt style="font-weight:bold">success</tt> property and
207 
other, action-specific properties.                        </div>
208 
        </td>
209 
        <td class="msource">Action</td>
210 
    </tr>
211 
        <tr class="property-row alt">
212 
        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
213 
        <td class="sig">
214 
        <a id="Ext.form.Action-type"></a>
215 
            <b>type</b> : String            <div class="mdesc">
216 
 
217 
The type of action this Action instance performs.
218 
Currently only "submit" and "load" are supported.                        </div>
219 
        </td>
220 
        <td class="msource">Action</td>
221 
    </tr>
222 
            </table>
223 
                <a id="Ext.form.Action-methods"></a>
224 
        <h2>Public Methods</h2>
225 
        <div class="no-members">This class has no public methods.</div>        <a id="Ext.form.Action-events"></a>
226 
        <h2>Public Events</h2>
227 
        <div class="no-members">This class has no public events.</div>
228 
        </div>