source: trunk/web/addons/job_monarch/lib/extjs/docs/output/Ext.sql.Proxy.html @ 619

Last change on this file since 619 was 619, checked in by ramonb, 15 years ago

lib/:

  • added new AJAX dependancies: ExtJS, pChart, Lightbox2
File size: 23.9 KB
Line 
1        <div class="body-wrap">
2        <div class="top-tools">
3            <a class="inner-link" href="#Ext.sql.Proxy-props"><img src="../resources/images/default/s.gif" class="item-icon icon-prop">Properties</a>
4            <a class="inner-link" href="#Ext.sql.Proxy-methods"><img src="../resources/images/default/s.gif" class="item-icon icon-method">Methods</a>
5            <a class="inner-link" href="#Ext.sql.Proxy-events"><img src="../resources/images/default/s.gif" class="item-icon icon-event">Events</a>
6                            <a class="inner-link" href="#Ext.sql.Proxy-configs"><img src="../resources/images/default/s.gif" class="item-icon icon-config">Config Options</a>
7                        <a class="bookmark" href="../docs/?class=Ext.sql.Proxy"><img src="../resources/images/default/s.gif" class="item-icon icon-fav">Direct Link</a>
8        </div>
9                <div class="inheritance res-block">
10<pre class="res-block-inner"><a ext:cls="Ext.util.Observable" ext:member="" href="output/Ext.util.Observable.html">Observable</a>
11  <img src="resources/elbow-end.gif"/><a ext:cls="Ext.data.DataProxy" ext:member="" href="output/Ext.data.DataProxy.html">DataProxy</a>
12    <img src="resources/elbow-end.gif"/>Proxy</pre></div>
13                <h1>Class Ext.sql.Proxy</h1>
14        <table cellspacing="0">
15            <tr><td class="label">Package:</td><td class="hd-info">Ext.sql</td></tr>
16            <tr><td class="label">Defined In:</td><td class="hd-info"><a href="../src/Proxy.js" target="_blank">Proxy.js</a></td></tr>
17            <tr><td class="label">Class:</td><td class="hd-info">Proxy</td></tr>
18                                    <tr><td class="label">Extends:</td><td class="hd-info"><a ext:cls="Ext.data.DataProxy" ext:member="" href="output/Ext.data.DataProxy.html">DataProxy</a></td></tr>
19                    </table>
20        <div class="description">
21            *
22An implementation of <a ext:cls="Ext.data.DataProxy" href="output/Ext.data.DataProxy.html">Ext.data.DataProxy</a> that reads from a SQLLite
23database.        </div>
24       
25        <div class="hr"></div>
26                <a id="Ext.sql.Proxy-configs"></a>
27        <h2>Config Options</h2>
28        <table cellspacing="0" class="member-table">
29            <tr>
30                <th class="sig-header" colspan="2">Config Options</th>
31                <th class="msource-header">Defined By</th>
32            </tr>
33                <tr class="config-row inherited expandable">
34        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
35        <td class="sig">
36        <a id="Ext.sql.Proxy-listeners"></a>
37            <b>listeners</b> : Object            <div class="mdesc">
38                        <div class="short">(optional) A config object containing one or more event handlers to be added to this object during initialization. Th...</div>
39            <div class="long">
40                (optional) 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>
41                        </div>
42        </td>
43        <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#listeners" href="output/Ext.util.Observable.html#listeners">Observable</a></td>
44    </tr>
45            </table>
46                <a id="Ext.sql.Proxy-props"></a>
47        <h2>Public Properties</h2>
48        <div class="no-members">This class has no public properties.</div>        <a id="Ext.sql.Proxy-methods"></a>
49        <h2>Public Methods</h2>
50                <table cellspacing="0" class="member-table">
51            <tr>
52                <th class="sig-header" colspan="2">Method</th>
53                <th class="msource-header">Defined By</th>
54            </tr>
55                <tr class="method-row expandable">
56        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
57        <td class="sig">
58        <a id="Ext.sql.Proxy-Proxy"></a>
59            <b>Proxy</b>(&nbsp;<code>Object conn</code>, <code>String table</code>, <code>String keyName</code>, <code>Ext.data.Store store</code>, <code>Boolean readonly</code>&nbsp;)            <div class="mdesc">
60                        <div class="short"></div>
61            <div class="long">
62                    <div class="mdetail-params">
63        <strong>Parameters:</strong>
64        <ul><li><code>conn</code> : Object<div class="sub-desc">an <a ext:cls="Ext.sql.Connection" href="output/Ext.sql.Connection.html">Ext.sql.Connection</a> object</div></li><li><code>table</code> : String<div class="sub-desc">The name of the database table</div></li><li><code>keyName</code> : String<div class="sub-desc">The primary key of the table</div></li><li><code>store</code> : Ext.data.Store<div class="sub-desc">The datastore to bind to</div></li><li><code>readonly</code> : Boolean<div class="sub-desc">By default all changes to the store will be persisted
65to the database. Set this to true to override to make the store readonly.</div></li>        </ul>
66        <strong>Returns:</strong>
67        <ul>
68            <li><code></code></li>
69        </ul>
70    </div>
71                </div>
72                        </div>
73        </td>
74        <td class="msource">Proxy</td>
75    </tr>
76        <tr class="method-row inherited alt expandable">
77        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
78        <td class="sig">
79        <a id="Ext.sql.Proxy-addEvents"></a>
80            <b>addEvents</b>(&nbsp;<code>Object object</code>&nbsp;) : void            <div class="mdesc">
81                        <div class="short">Used to define events on this Observable</div>
82            <div class="long">
83                Used to define events on this Observable    <div class="mdetail-params">
84        <strong>Parameters:</strong>
85        <ul><li><code>object</code> : Object<div class="sub-desc">The object with the events defined</div></li>        </ul>
86        <strong>Returns:</strong>
87        <ul>
88            <li><code>void</code></li>
89        </ul>
90    </div>
91                </div>
92                        </div>
93        </td>
94        <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#addEvents" href="output/Ext.util.Observable.html#addEvents">Observable</a></td>
95    </tr>
96        <tr class="method-row inherited expandable">
97        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
98        <td class="sig">
99        <a id="Ext.sql.Proxy-addListener"></a>
100            <b>addListener</b>(&nbsp;<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>&nbsp;) : void            <div class="mdesc">
101                        <div class="short">Appends an event handler to this component</div>
102            <div class="long">
103                Appends an event handler to this component    <div class="mdetail-params">
104        <strong>Parameters:</strong>
105        <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
106function. The handler function's "this" context.</div></li><li><code>options</code> : Object<div class="sub-desc">(optional) An object containing handler configuration
107properties. This may contain any of the following properties:<ul>
108<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>
109<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>
110<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>
111<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
112by the specified number of milliseconds. If the event fires again within that time, the original
113handler is <em>not</em> invoked, but the new handler is scheduled in its place.</p></li>
114</ul><br>
115<p>
116<b>Combining Options</b><br>
117Using the options argument, it is possible to combine different types of listeners:<br>
118<br>
119A normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)
120<pre><code>el.on(<em>'click'</em>, <b>this</b>.onClick, <b>this</b>, {
121    single: true,
122    delay: 100,
123    forumId: 4
124});</code></pre>
125<p>
126<b>Attaching multiple handlers in 1 call</b><br>
127The method also allows for a single argument to be passed which is a config object containing properties
128which specify multiple handlers.
129<p>
130<pre><code>foo.on({
131    <em>'click'</em> : {
132        fn: <b>this</b>.onClick,
133        scope: <b>this</b>,
134        delay: 100
135    },
136    <em>'mouseover'</em> : {
137        fn: <b>this</b>.onMouseOver,
138        scope: <b>this</b>
139    },
140    <em>'mouseout'</em> : {
141        fn: <b>this</b>.onMouseOut,
142        scope: <b>this</b>
143    }
144});</code></pre>
145<p>
146Or a shorthand syntax:<br>
147<pre><code>foo.on({
148    <em>'click'</em> : <b>this</b>.onClick,
149    <em>'mouseover'</em> : <b>this</b>.onMouseOver,
150    <em>'mouseout'</em> : <b>this</b>.onMouseOut,
151     scope: <b>this</b>
152});</code></pre></div></li>        </ul>
153        <strong>Returns:</strong>
154        <ul>
155            <li><code>void</code></li>
156        </ul>
157    </div>
158                </div>
159                        </div>
160        </td>
161        <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#addListener" href="output/Ext.util.Observable.html#addListener">Observable</a></td>
162    </tr>
163        <tr class="method-row inherited alt expandable">
164        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
165        <td class="sig">
166        <a id="Ext.sql.Proxy-fireEvent"></a>
167            <b>fireEvent</b>(&nbsp;<code>String eventName</code>, <code>Object... args</code>&nbsp;) : Boolean            <div class="mdesc">
168                        <div class="short">Fires the specified event with the passed parameters (minus the event name).</div>
169            <div class="long">
170                Fires the specified event with the passed parameters (minus the event name).    <div class="mdetail-params">
171        <strong>Parameters:</strong>
172        <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>
173        <strong>Returns:</strong>
174        <ul>
175            <li><code>Boolean</code><div class="sub-desc">returns false if any of the handlers return false otherwise it returns true</div></li>
176        </ul>
177    </div>
178                </div>
179                        </div>
180        </td>
181        <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#fireEvent" href="output/Ext.util.Observable.html#fireEvent">Observable</a></td>
182    </tr>
183        <tr class="method-row inherited expandable">
184        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
185        <td class="sig">
186        <a id="Ext.sql.Proxy-hasListener"></a>
187            <b>hasListener</b>(&nbsp;<code>String eventName</code>&nbsp;) : Boolean            <div class="mdesc">
188                        <div class="short">Checks to see if this object has any listeners for a specified event</div>
189            <div class="long">
190                Checks to see if this object has any listeners for a specified event    <div class="mdetail-params">
191        <strong>Parameters:</strong>
192        <ul><li><code>eventName</code> : String<div class="sub-desc">The name of the event to check for</div></li>        </ul>
193        <strong>Returns:</strong>
194        <ul>
195            <li><code>Boolean</code><div class="sub-desc">True if the event is being listened for, else false</div></li>
196        </ul>
197    </div>
198                </div>
199                        </div>
200        </td>
201        <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#hasListener" href="output/Ext.util.Observable.html#hasListener">Observable</a></td>
202    </tr>
203        <tr class="method-row inherited alt expandable">
204        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
205        <td class="sig">
206        <a id="Ext.sql.Proxy-on"></a>
207            <b>on</b>(&nbsp;<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>&nbsp;) : void            <div class="mdesc">
208                        <div class="short">Appends an event handler to this element (shorthand for addListener)</div>
209            <div class="long">
210                Appends an event handler to this element (shorthand for addListener)    <div class="mdetail-params">
211        <strong>Parameters:</strong>
212        <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
213function. The handler function's "this" context.</div></li><li><code>options</code> : Object<div class="sub-desc">(optional)</div></li>        </ul>
214        <strong>Returns:</strong>
215        <ul>
216            <li><code>void</code></li>
217        </ul>
218    </div>
219                </div>
220                        </div>
221        </td>
222        <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#on" href="output/Ext.util.Observable.html#on">Observable</a></td>
223    </tr>
224        <tr class="method-row inherited expandable">
225        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
226        <td class="sig">
227        <a id="Ext.sql.Proxy-purgeListeners"></a>
228            <b>purgeListeners</b>() : void            <div class="mdesc">
229                        <div class="short">Removes all listeners for this object</div>
230            <div class="long">
231                Removes all listeners for this object    <div class="mdetail-params">
232        <strong>Parameters:</strong>
233        <ul><li>None.</li>        </ul>
234        <strong>Returns:</strong>
235        <ul>
236            <li><code>void</code></li>
237        </ul>
238    </div>
239                </div>
240                        </div>
241        </td>
242        <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#purgeListeners" href="output/Ext.util.Observable.html#purgeListeners">Observable</a></td>
243    </tr>
244        <tr class="method-row inherited alt expandable">
245        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
246        <td class="sig">
247        <a id="Ext.sql.Proxy-relayEvents"></a>
248            <b>relayEvents</b>(&nbsp;<code>Object o</code>, <code>Array events</code>&nbsp;) : void            <div class="mdesc">
249                        <div class="short">Relays selected events from the specified Observable as if the events were fired by <tt><b>this</b></tt>.</div>
250            <div class="long">
251                Relays selected events from the specified Observable as if the events were fired by <tt><b>this</b></tt>.    <div class="mdetail-params">
252        <strong>Parameters:</strong>
253        <ul><li><code>o</code> : Object<div class="sub-desc">The Observable whose events this object is to relay.</div></li><li><code>events</code> : Array<div class="sub-desc">Array of event names to relay.</div></li>        </ul>
254        <strong>Returns:</strong>
255        <ul>
256            <li><code>void</code></li>
257        </ul>
258    </div>
259                </div>
260                        </div>
261        </td>
262        <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#relayEvents" href="output/Ext.util.Observable.html#relayEvents">Observable</a></td>
263    </tr>
264        <tr class="method-row inherited expandable">
265        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
266        <td class="sig">
267        <a id="Ext.sql.Proxy-removeListener"></a>
268            <b>removeListener</b>(&nbsp;<code>String eventName</code>, <code>Function handler</code>, <span class="optional" title="Optional">[<code>Object scope</code>]</span>&nbsp;) : void            <div class="mdesc">
269                        <div class="short">Removes a listener</div>
270            <div class="long">
271                Removes a listener    <div class="mdetail-params">
272        <strong>Parameters:</strong>
273        <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>
274        <strong>Returns:</strong>
275        <ul>
276            <li><code>void</code></li>
277        </ul>
278    </div>
279                </div>
280                        </div>
281        </td>
282        <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#removeListener" href="output/Ext.util.Observable.html#removeListener">Observable</a></td>
283    </tr>
284        <tr class="method-row inherited alt expandable">
285        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
286        <td class="sig">
287        <a id="Ext.sql.Proxy-resumeEvents"></a>
288            <b>resumeEvents</b>() : void            <div class="mdesc">
289                        <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>
290            <div class="long">
291                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">
292        <strong>Parameters:</strong>
293        <ul><li>None.</li>        </ul>
294        <strong>Returns:</strong>
295        <ul>
296            <li><code>void</code></li>
297        </ul>
298    </div>
299                </div>
300                        </div>
301        </td>
302        <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#resumeEvents" href="output/Ext.util.Observable.html#resumeEvents">Observable</a></td>
303    </tr>
304        <tr class="method-row inherited expandable">
305        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
306        <td class="sig">
307        <a id="Ext.sql.Proxy-suspendEvents"></a>
308            <b>suspendEvents</b>() : void            <div class="mdesc">
309                        <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>
310            <div class="long">
311                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">
312        <strong>Parameters:</strong>
313        <ul><li>None.</li>        </ul>
314        <strong>Returns:</strong>
315        <ul>
316            <li><code>void</code></li>
317        </ul>
318    </div>
319                </div>
320                        </div>
321        </td>
322        <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#suspendEvents" href="output/Ext.util.Observable.html#suspendEvents">Observable</a></td>
323    </tr>
324        <tr class="method-row inherited alt expandable">
325        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
326        <td class="sig">
327        <a id="Ext.sql.Proxy-un"></a>
328            <b>un</b>(&nbsp;<code>String eventName</code>, <code>Function handler</code>, <span class="optional" title="Optional">[<code>Object scope</code>]</span>&nbsp;) : void            <div class="mdesc">
329                        <div class="short">Removes a listener (shorthand for removeListener)</div>
330            <div class="long">
331                Removes a listener (shorthand for removeListener)    <div class="mdetail-params">
332        <strong>Parameters:</strong>
333        <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>
334        <strong>Returns:</strong>
335        <ul>
336            <li><code>void</code></li>
337        </ul>
338    </div>
339                </div>
340                        </div>
341        </td>
342        <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#un" href="output/Ext.util.Observable.html#un">Observable</a></td>
343    </tr>
344            </table>
345                <a id="Ext.sql.Proxy-events"></a>
346        <h2>Public Events</h2>
347                <table cellspacing="0" class="member-table">
348            <tr>
349                <th class="sig-header" colspan="2">Event</th>
350                <th class="msource-header">Defined By</th>
351            </tr>
352                <tr class="event-row inherited expandable">
353        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
354        <td class="sig">
355        <a id="Ext.sql.Proxy-beforeload"></a>
356            <b>beforeload</b> : (&nbsp;<code>Object this</code>, <code>Object params</code>&nbsp;)            <div class="mdesc">
357                        <div class="short">Fires before a network request is made to retrieve a data object.</div>
358            <div class="long">
359                Fires before a network request is made to retrieve a data object.    <div class="mdetail-params">
360        <strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>
361        <ul><li><code>this</code> : Object<div class="sub-desc"></div></li><li><code>params</code> : Object<div class="sub-desc">The params object passed to the <a ext:cls="Ext.data.DataProxy" ext:member="load" href="output/Ext.data.DataProxy.html#load">load</a> function</div></li>        </ul>
362    </div>
363                </div>
364                        </div>
365        </td>
366        <td class="msource"><a ext:cls="Ext.data.DataProxy" ext:member="#event-beforeload" href="output/Ext.data.DataProxy.html#event-beforeload">DataProxy</a></td>
367    </tr>
368        <tr class="event-row inherited alt expandable">
369        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
370        <td class="sig">
371        <a id="Ext.sql.Proxy-load"></a>
372            <b>load</b> : (&nbsp;<code>Object this</code>, <code>Object o</code>, <code>Object arg</code>&nbsp;)            <div class="mdesc">
373                        <div class="short">Fires before the load method's callback is called.</div>
374            <div class="long">
375                Fires before the load method's callback is called.    <div class="mdetail-params">
376        <strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>
377        <ul><li><code>this</code> : Object<div class="sub-desc"></div></li><li><code>o</code> : Object<div class="sub-desc">The data object</div></li><li><code>arg</code> : Object<div class="sub-desc">The callback's arg object passed to the <a ext:cls="Ext.data.DataProxy" ext:member="load" href="output/Ext.data.DataProxy.html#load">load</a> function</div></li>        </ul>
378    </div>
379                </div>
380                        </div>
381        </td>
382        <td class="msource"><a ext:cls="Ext.data.DataProxy" ext:member="#event-load" href="output/Ext.data.DataProxy.html#event-load">DataProxy</a></td>
383    </tr>
384            </table>
385       
386        </div>
Note: See TracBrowser for help on using the repository browser.