webgui/www/extras/extjs/docs/output/Ext.data.MemoryProxy.html

106 lines
No EOL
5.9 KiB
HTML

<!doctype html public "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
<html>
<head>
<title>Ext.data.MemoryProxy</title>
<link rel="stylesheet" type="text/css" href="../resources/reset.css"/>
<link rel="stylesheet" type="text/css" href="../resources/style.css" media="screen"/>
<link rel="stylesheet" type="text/css" href="../resources/print.css" media="print">
<!-- GC -->
</head>
<body>
<div class="body-wrap">
<div class="top-tools">
<img src="../resources/print.gif" width="16" height="16" align="absmiddle">&nbsp;<a href="Ext.data.MemoryProxy.html" target="_blank">Print Friendly</a><br/>
</div>
<h1>Class Ext.data.MemoryProxy</h1>
<table cellspacing="0">
<tr><td class="label">Package:</td><td>Ext.data</td></tr>
<tr><td class="label">Class:</td><td>MemoryProxy</td></tr>
<tr><td class="label">Extends:</td><td>Object</td></tr>
<tr><td class="label">Defined In:</td><td><a href="MemoryProxy.jss.html">MemoryProxy.js</a></td></tr>
</table>
<div class="description">
An implementation of Ext.data.DataProxy that simply passes the data specified in its constructor
to the Reader when its load method is called. </div>
<br />
<a href="#properties">Properties</a>
&nbsp;&nbsp;-&nbsp;&nbsp;<a href="#methods">Methods</a>
&nbsp;&nbsp;-&nbsp;&nbsp;<a href="#events">Events</a>
<hr />
<a name="properties"></a>
<h2>Public Properties</h2>
<div class="no-members">This class has no public properties.</div> <a name="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>
<td class="micon" rowspan="2">&nbsp;</td>
<td class="sig"><a class="mlink" href="#MemoryProxy">MemoryProxy</a>(<code>Object data</code>)</td>
<td class="msource" rowspan="2">MemoryProxy</td>
</tr>
<tr>
<td class="mdesc"></td>
</tr>
<tr class="alt">
<td class="micon" rowspan="2">&nbsp;</td>
<td class="sig"><a class="mlink" href="#load">load</a>(<code>Object params</code>, <code>Ext.data.DataReader) reader</code>, <code>Function callback</code>, <code>Object scope</code>, <code>Object arg</code>) : void</td>
<td class="msource" rowspan="2">MemoryProxy</td>
</tr>
<tr class="alt">
<td class="mdesc">Load data from the requested source (in this case an in-memory
data object passed to the constructor), read the data ...</td>
</tr>
</table>
<a name="events"></a>
<h2>Public Events</h2>
<div class="no-members">This class has no public events.</div>
<a name="MemoryProxy"></a>
<h2 class="mdetail-head">Constructor Details</h2>
<div class="detail-wrap">
<div class="mdetail">
<h3>MemoryProxy</i></h3>
<code>public function MemoryProxy(<code>Object data</code>)</code>
<div class="mdetail-desc">
<div class="mdetail-params">
<strong>Parameters:</strong>
<ul><li><code>data</code> : Object<div class="sub-desc">The data object which the Reader uses to construct a block of Ext.data.Records.</div></li> </ul>
</div>
</div>
</div>
</div>
<h2 class="mdetail-head">Method Details</h2>
<div class="detail-wrap">
<a name="load"></a>
<div class="mdetail">
<h3>load</i></h3>
<code>public function load(<code>Object params</code>, <code>Ext.data.DataReader) reader</code>, <code>Function callback</code>, <code>Object scope</code>, <code>Object arg</code>)</code>
<div class="mdetail-desc">
Load data from the requested source (in this case an in-memory
data object passed to the constructor), read the data object into
a block of Ext.data.Records using the passed Ext.data.DataReader implementation, and
process that block using the passed callback.
<div class="mdetail-params">
<strong>Parameters:</strong>
<ul><li><code>params</code> : Object<div class="sub-desc">This parameter is not used by the MemoryProxy class.</div></li><li><code>reader</code> : Ext.data.DataReader)<div class="sub-desc">The Reader object which converts the data object into a block of Ext.data.Records.</div></li><li><code>callback</code> : Function<div class="sub-desc">The function into which to pass the block of Ext.data.records. The function must be passed <ul> <li>The Record block object</li> <li>The "arg" argument from the load function</li> <li>A boolean success indicator</li> </ul></div></li><li><code>scope</code> : Object<div class="sub-desc">The scope in which to call the callback</div></li><li><code>arg</code> : Object<div class="sub-desc">An optional argument which is passed to the callback as its second parameter.</div></li> </ul>
<strong>Returns:</strong>
<ul>
<li><code>void</code></li>
</ul>
</div>
</div>
<div class="mdetail-def">This method is defined by MemoryProxy.</div>
</div>
</div>
</div>
<hr>
<div style="font-size:10px;text-align:center;color:gray;">Ext - Copyright &copy; 2006-2007 Ext JS, LLC<br />All rights reserved.</div>
</body>
</html>