<!-- ============================== class summary ========================== -->
<div class="description">
- Shortcut class to create a JSON + {<b>link</b> Roo.UpdateManager} template view. Usage:<br/><pre><code><br/>var view = new Roo.JsonView("my-element",<br/> '<div id="{id}">{foo} - {bar}</div>', // auto create template<br/> { multiSelect: true, jsonRoot: "data" }<br/>);<br/><br/>// listen for node click?<br/>view.on("click", function(vw, index, node, e){<br/> alert('Node "' + node.id + '" at index: ' + index + " was clicked.");<br/>});<br/><br/>// direct load of JSON data<br/>view.load("foobar.php");<br/><br/>// Example from my blog list<br/>var tpl = new Roo.Template(<br/> '<div class="entry">' +<br/> '<a class="entry-title" href="{link}">{title}</a>' +<br/> "<h4>{date} by {author} | {comments} Comments</h4>{description}" +<br/> "</div><hr />"<br/>);<br/><br/>var moreView = new Roo.JsonView("entry-list", tpl, {<br/> jsonRoot: "posts"<br/>});<br/>moreView.on("beforerender", this.sortEntries, this);<br/>moreView.load({<br/> url: "/blog/get-posts.php",<br/> params: "allposts=true",<br/> text: "Loading Blog Entries..."<br/>});<br/></code></pre>
+ Shortcut class to create a JSON + {<b>link</b> Roo.UpdateManager} template view. Usage:<br/><pre><code><br/>var view = new Roo.JsonView({<br/> container: "my-element",<br/> tpl: '<div id="{id}">{foo} - {bar}</div>', // auto create template<br/> multiSelect: true, <br/> jsonRoot: "data" <br/>});<br/><br/>// listen for node click?<br/>view.on("click", function(vw, index, node, e){<br/> alert('Node "' + node.id + '" at index: ' + index + " was clicked.");<br/>});<br/><br/>// direct load of JSON data<br/>view.load("foobar.php");<br/><br/>// Example from my blog list<br/>var tpl = new Roo.Template(<br/> '<div class="entry">' +<br/> '<a class="entry-title" href="{link}">{title}</a>' +<br/> "<h4>{date} by {author} | {comments} Comments</h4>{description}" +<br/> "</div><hr />"<br/>);<br/><br/>var moreView = new Roo.JsonView({<br/> container : "entry-list", <br/> template : tpl,<br/> jsonRoot: "posts"<br/>});<br/>moreView.on("beforerender", this.sortEntries, this);<br/>moreView.load({<br/> url: "/blog/get-posts.php",<br/> params: "allposts=true",<br/> text: "Loading Blog Entries..."<br/>});<br/></code></pre><br/><br/>Note: old code is supported with arguments : (container, template, config)
</div>
+ <tr class="config-row expandable config-row-alt0">
+ <td class="micon"><a class="exi" href="#expand"> </a></td>
+ <td class="sig">
+
+ <a id="Roo.View-cfg-el" name=".el"></a>
+ <div class="fixedFont">
+ <b class="itemname">el</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>|<a href="./Roo.Element.html#constructor" roo:cls="Roo.Element.html#constructor">Roo.Element</a>
+
+
+ </div>
+
+ <div class="mdesc">
+ <div class="short">The container element.</div>
+ </div>
+
+ <div class="mdesc">
+ <div class="long">The container element.</div>
+ </div>
+
+
+
+ </td>
+ <td class="msource">
+
+ <a href="./Roo.View.html#constructor" roo:cls="Roo.View.html#constructor">Roo.View</a>
+
+ </td>
+ </tr>
+
+
+ <tr class="config-row expandable config-row-alt1">
+ <td class="micon"><a class="exi" href="#expand"> </a></td>
+ <td class="sig">
+
+ <a id="Roo.View-cfg-emptyText" name=".emptyText"></a>
+ <div class="fixedFont">
+ <b class="itemname">emptyText</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
+
+
+ </div>
+
+ <div class="mdesc">
+ <div class="short">The empty text to show when nothing is loaded.</div>
+ </div>
+
+ <div class="mdesc">
+ <div class="long">The empty text to show when nothing is loaded.</div>
+ </div>
+
+
+
+ </td>
+ <td class="msource">
+
+ <a href="./Roo.View.html#constructor" roo:cls="Roo.View.html#constructor">Roo.View</a>
+
+ </td>
+ </tr>
+
+
<tr class="config-row expandable config-row-alt0">
<td class="micon"><a class="exi" href="#expand"> </a></td>
<td class="sig">
</td>
</tr>
+
+ <tr class="config-row expandable config-row-alt1">
+ <td class="micon"><a class="exi" href="#expand"> </a></td>
+ <td class="sig">
+
+ <a id="Roo.View-cfg-multiSelect" name=".multiSelect"></a>
+ <div class="fixedFont">
+ <b class="itemname">multiSelect</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
+
+
+ </div>
+
+ <div class="mdesc">
+ <div class="short">Allow multiple selection</div>
+ </div>
+
+ <div class="mdesc">
+ <div class="long">Allow multiple selection</div>
+ </div>
+
+
+
+ </td>
+ <td class="msource">
+
+ <a href="./Roo.View.html#constructor" roo:cls="Roo.View.html#constructor">Roo.View</a>
+
+ </td>
+ </tr>
+
+
+ <tr class="config-row expandable config-row-alt0">
+ <td class="micon"><a class="exi" href="#expand"> </a></td>
+ <td class="sig">
+
+ <a id="Roo.View-cfg-selectedClass" name=".selectedClass"></a>
+ <div class="fixedFont">
+ <b class="itemname">selectedClass</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
+
+
+ </div>
+
+ <div class="mdesc">
+ <div class="short">The css class to add to selected nodes</div>
+ </div>
+
+ <div class="mdesc">
+ <div class="long">The css class to add to selected nodes</div>
+ </div>
+
+
+
+ </td>
+ <td class="msource">
+
+ <a href="./Roo.View.html#constructor" roo:cls="Roo.View.html#constructor">Roo.View</a>
+
+ </td>
+ </tr>
+
+
+ <tr class="config-row expandable config-row-alt1">
+ <td class="micon"><a class="exi" href="#expand"> </a></td>
+ <td class="sig">
+
+ <a id="Roo.View-cfg-singleSelect" name=".singleSelect"></a>
+ <div class="fixedFont">
+ <b class="itemname">singleSelect</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
+
+
+ </div>
+
+ <div class="mdesc">
+ <div class="short">Allow single selection</div>
+ </div>
+
+ <div class="mdesc">
+ <div class="long">Allow single selection</div>
+ </div>
+
+
+
+ </td>
+ <td class="msource">
+
+ <a href="./Roo.View.html#constructor" roo:cls="Roo.View.html#constructor">Roo.View</a>
+
+ </td>
+ </tr>
+
+
+ <tr class="config-row expandable config-row-alt0">
+ <td class="micon"><a class="exi" href="#expand"> </a></td>
+ <td class="sig">
+
+ <a id="Roo.View-cfg-store" name=".store"></a>
+ <div class="fixedFont">
+ <b class="itemname">store</b> : <a href="./Roo.data.Store.html#constructor" roo:cls="Roo.data.Store.html#constructor">Roo.data.Store</a>
+
+
+ </div>
+
+ <div class="mdesc">
+ <div class="short">Data store to load data from.</div>
+ </div>
+
+ <div class="mdesc">
+ <div class="long">Data store to load data from.</div>
+ </div>
+
+
+
+ </td>
+ <td class="msource">
+
+ <a href="./Roo.View.html#constructor" roo:cls="Roo.View.html#constructor">Roo.View</a>
+
+ </td>
+ </tr>
+
+
+ <tr class="config-row expandable config-row-alt1">
+ <td class="micon"><a class="exi" href="#expand"> </a></td>
+ <td class="sig">
+
+ <a id="Roo.View-cfg-toggleSelect" name=".toggleSelect"></a>
+ <div class="fixedFont">
+ <b class="itemname">toggleSelect</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
+
+
+ </div>
+
+ <div class="mdesc">
+ <div class="short">- selecting</div>
+ </div>
+
+ <div class="mdesc">
+ <div class="long">- selecting</div>
+ </div>
+
+
+
+ </td>
+ <td class="msource">
+
+ <a href="./Roo.View.html#constructor" roo:cls="Roo.View.html#constructor">Roo.View</a>
+
+ </td>
+ </tr>
+
+
+ <tr class="config-row expandable config-row-alt0">
+ <td class="micon"><a class="exi" href="#expand"> </a></td>
+ <td class="sig">
+
+ <a id="Roo.View-cfg-tpl" name=".tpl"></a>
+ <div class="fixedFont">
+ <b class="itemname">tpl</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>|<a href="./Roo.Template.html#constructor" roo:cls="Roo.Template.html#constructor">Roo.Template</a>
+
+
+ </div>
+
+ <div class="mdesc">
+ <div class="short">The template used by this View</div>
+ </div>
+
+ <div class="mdesc">
+ <div class="long">The template used by this View</div>
+ </div>
+
+
+
+ </td>
+ <td class="msource">
+
+ <a href="./Roo.View.html#constructor" roo:cls="Roo.View.html#constructor">Roo.View</a>
+
+ </td>
+ </tr>
+
</table>
<div class="fixedFont">
<span class="attributes">new <B>Roo.</B></span><b class="itemname">JsonView</b>
- (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/HTMLElement/Element <B><i>container</i></B>, Template <B><i>tpl</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>config</i></B>)
+ (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>config</i></B>)
<dl class="detailList">
<dt class="heading">Parameters:</dt>
- <dt>
- <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/HTMLElement/Element</span> <b>container</b>
-
- </dt>
- <dd>The container element where the view is to be rendered.</dd>
-
- <dt>
- <span class="fixedFont">Template</span> <b>tpl</b>
-
- </dt>
- <dd>The rendering template</dd>
-
<dt>
<span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span> <b>config</b>
</td>
</tr>
+
+ <tr class="method-row config-row-alt1 expandable">
+ <td class="micon"><a class="exi" href="#expand"> </a></td>
+
+
+ <td class="sig">
+ <a id="Roo.View-method-unselect" name=".unselect"></a>
+ <div class="fixedFont">
+ <span class="attributes"></span><b class="itemname">unselect</b>
+
+ (<a href="./Array.html#constructor" roo:cls="Array.html#constructor">Array</a>/HTMLElement/String/Number <B><i>nodeInfo</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a> <B><i>keepExisting</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a> <B><i>suppressEvent</i></B>)
+
+
+
+ </div>
+ <div class="mdesc">
+
+ <div class="short">Unselects nodes.</div>
+
+
+
+ <div class="long">
+
+ Unselects nodes.
+
+
+
+
+
+
+ <dl class="detailList">
+ <dt class="heading">Parameters:</dt>
+
+ <dt>
+ <span class="fixedFont"><a href="./Array.html#constructor" roo:cls="Array.html#constructor">Array</a>/HTMLElement/String/Number</span> <b>nodeInfo</b>
+
+ </dt>
+ <dd>An HTMLElement template node, index of a template node, id of a template node or an array of any of those to select</dd>
+
+ <dt>
+ <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span> <b>keepExisting</b>
+
+ </dt>
+ <dd>(optional) true IGNORED (for campatibility with select)</dd>
+
+ <dt>
+ <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span> <b>suppressEvent</b>
+
+ </dt>
+ <dd>(optional) true to skip firing of the selectionchange vent</dd>
+
+ </dl>
+
+
+
+
+
+
+
+
+
+
+
+ </div>
+ </div>
+
+ </td>
+ <td class="msource">
+
+ <a href="./Roo.View.html#constructor" roo:cls="Roo.View.html#constructor">Roo.View</a>
+
+ </td>
+ </tr>
+
</table>
<tr class="method-row expandable config-row-alt0">
<td class="micon"><a class="exi" href="#expand"> </a></td>
+ <td class="sig">
+ <a id="Roo.View-event-*preparedata"></a>
+
+ <div class="fixedFont">
+ <b class="itemname">preparedata</b> (<a href="./Roo.View.html#constructor" roo:cls="Roo.View.html#constructor">Roo.View</a> <B><i>this</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>data</i></B>)
+
+ </div>
+
+ <div class="mdesc">
+
+ <div class="short">Fires on every row to render, to allow you to change the data.
+
+ </div>
+
+ <div class="long">
+
+ Fires on every row to render, to allow you to change the data.
+
+
+
+
+
+ <dl class="detailList">
+ <dt class="heading">Parameters:</dt>
+
+ <dt>
+ <span class="fixedFont"><a href="./Roo.View.html#constructor" roo:cls="Roo.View.html#constructor">Roo.View</a></span> <b>this</b>
+
+ </dt>
+ <dd></dd>
+
+ <dt>
+ <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span> <b>data</b>
+
+ </dt>
+ <dd>to be rendered (change this)</dd>
+
+ </dl>
+
+
+
+
+
+
+
+
+
+
+
+ </div>
+ </div>
+
+ </td>
+ <td class="msource">
+ <a href="./Roo.View.html#constructor" roo:cls="Roo.View.html#constructor">Roo.View</a>
+ </td>
+ </tr>
+
+ <tr class="method-row expandable config-row-alt1">
+ <td class="micon"><a class="exi" href="#expand"> </a></td>
+
<td class="sig">
<a id="Roo.View-event-*selectionchange"></a>
<!-- ============================== footer ================================= -->
<div class="fineprint" style="clear:both">
- Documentation generated by <a href="http://www.akbkhome.com" target="_blankt">Introspection Doc Generator</a> on Thu Jul 22 2010 00:24:27 GMT+0800 (HKT)
+ Documentation generated by <a href="http://www.akbkhome.com" target="_blankt">Introspection Doc Generator</a> on Fri Dec 16 2011 12:05:59 GMT+0800 (HKT)
Based on
<a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a>
</div>
projects / roojs1 / blobdiff