<tr><td class="label">Class:</td><td class="hd-info">View</td></tr>
+ <tr><td class="label">Subclasses:</td><td class="hd-info">
+ <a href="./Roo.JsonView.html#constructor" roo:cls="Roo.JsonView.html#constructor">Roo.JsonView</a>
+
+
+
+ </td></tr>
+
<tr><td class="label">Extends:</td><td class="hd-info">
<!-- ============================== class summary ========================== -->
<div class="description">
- Create a "View" for an element based on a data model or UpdateManager and the supplied DomHelper template. <br/>This class also supports single and multi selection modes. <br><br/>Create a data model bound view:<br/> <pre><code><br/> var store = new Roo.data.Store(...);<br/><br/> var view = new Roo.View("my-element",<br/> '<div id="{0}">{2} - {1}</div>', // auto create template<br/> {<br/> singleSelect: true,<br/> selectedClass: "ydataview-selected",<br/> store: store<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/> // load XML data<br/> dataModel.load("foobar.xml");<br/> </code></pre><br/> For an example of creating a JSON/UpdateManager view, see {<b>link</b> Roo.JsonView}.<br/><br><br><br/><b>Note: The root of your template must be a single node. Table/row implementations may work but are not supported due to<br/>IE"s limited insertion support with tables and Opera"s faulty event bubbling.</b>
+ Create a "View" for an element based on a data model or UpdateManager and the supplied DomHelper template. <br/>This class also supports single and multi selection modes. <br><br/>Create a data model bound view:<br/> <pre><code><br/> var store = new Roo.data.Store(...);<br/><br/> var view = new Roo.View({<br/> el : "my-element",<br/> template : '<div id="{0}">{2} - {1}</div>', // auto create template<br/> <br/> singleSelect: true,<br/> selectedClass: "ydataview-selected",<br/> store: store<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/> // load XML data<br/> dataModel.load("foobar.xml");<br/> </code></pre><br/> For an example of creating a JSON/UpdateManager view, see {<b>link</b> Roo.JsonView}.<br/><br><br><br/><b>Note: The root of your template must be a single node. Table/row implementations may work but are not supported due to<br/>IE"s limited insertion support with tables and Opera"s faulty event bubbling.</b><br/><br/>Note: old style constructor is still suported (container, template, config)
</div>
<a id="Roo.View-configs"></a>
+
- <table cellspacing="0" class="member-table">
- <caption class="Empty">Config Options - Has None</caption>
- </table>
-
+
+ <table cellspacing="0" class="member-table">
+ <caption>Config Options (Usually are also Properties)</caption>
-
-
+
+ <tr>
+ <th class="sig-header" colspan="2">Options</th>
+
+ <th class="msource-header">Defined By</th>
+ </tr>
+
+
+
+
+
+ <tr class="config-row expandable config-row-alt0 notInherited">
+ <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">
+
+ Roo.View
+
+ </td>
+ </tr>
+
+
+ <tr class="config-row expandable config-row-alt1 notInherited">
+ <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">
+
+ Roo.View
+
+ </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.util.Observable-cfg-listeners" name=".listeners"></a>
+ <div class="fixedFont">
+ <b class="itemname">listeners</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a>
+
+
+ </div>
+
+ <div class="mdesc">
+ <div class="short">list of events and functions to call for this object, <br/>For example :<br/><pre><code><br/> listeners : { <br/> 'click' : function(e) {<br/> .</div>
+ </div>
+
+ <div class="mdesc">
+ <div class="long">list of events and functions to call for this object, <br/>For example :<br/><pre><code><br/> listeners : { <br/> 'click' : function(e) {<br/> ..... <br/> } ,<br/> .... <br/> } <br/> </code></pre></div>
+ </div>
+
+
+
+ </td>
+ <td class="msource">
+
+ <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
+
+ </td>
+ </tr>
+
+
+ <tr class="config-row expandable config-row-alt1 notInherited">
+ <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">
+
+ Roo.View
+
+ </td>
+ </tr>
+
+
+ <tr class="config-row expandable config-row-alt0 notInherited">
+ <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">
+
+ Roo.View
+
+ </td>
+ </tr>
+
+
+ <tr class="config-row expandable config-row-alt1 notInherited">
+ <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">
+
+ Roo.View
+
+ </td>
+ </tr>
+
+
+ </table>
+
<div class="fixedFont">
<span class="attributes">new <B>Roo.</B></span><b class="itemname">View</b>
- (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/HTMLElement/Element <B><i>container</i></B>, <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/DomHelper.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"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/DomHelper.Template</span> <b>tpl</b>
-
- </dt>
- <dd>The rendering template or a string to create a template with</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>
</tr>
- <tr class="method-row config-row-alt1 expandable notInherited">
+ <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-clearSelections" name=".clearSelections"></a>
+ <a id="Roo.util.Observable-method-addEvents" name=".addEvents"></a>
<div class="fixedFont">
- <span class="attributes"></span><b class="itemname">clearSelections</b>
+ <span class="attributes"></span><b class="itemname">addEvents</b>
- (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a> <B><i>suppressEvent</i></B>)
+ (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>object</i></B>)
</div>
<div class="mdesc">
- <div class="short">Clear all selections</div>
+ <div class="short">Used to define events on this Observable</div>
<div class="long">
- Clear all selections
+ Used to define events on this Observable
<dt class="heading">Parameters:</dt>
<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>
+ <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span> <b>object</b>
</dt>
- <dd>(optional) true to skip firing of the selectionchange event</dd>
+ <dd>The object with the events defined</dd>
</dl>
</td>
<td class="msource">
- Roo.View
+ <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
</td>
</tr>
- <tr class="method-row config-row-alt0 expandable notInherited">
+ <tr class="method-row config-row-alt0 expandable">
<td class="micon"><a class="exi" href="#expand"> </a></td>
<td class="sig">
- <a id="Roo.View-method-findItemFromChild" name=".findItemFromChild"></a>
+ <a id="Roo.util.Observable-method-addListener" name=".addListener"></a>
<div class="fixedFont">
- <span class="attributes"></span><b class="itemname">findItemFromChild</b>
+ <span class="attributes"></span><b class="itemname">addListener</b>
- (<a href="http://www.w3.org/TR/DOM-Level-2-HTML/html.html#ID-58190037">HTMLElement</a> <B><i>node</i></B>)
+ (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>eventName</i></B>, <a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a> <B><i>handler</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>scope</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>options</i></B>)
- :
-
-
- <a href="http://www.w3.org/TR/DOM-Level-2-HTML/html.html#ID-58190037">HTMLElement</a>
-
-
-
-
</div>
<div class="mdesc">
- <div class="short">Returns the template node the passed child belongs to or null if it doesn't belong to one.</div>
+ <div class="short">Appends an event handler to this component</div>
<div class="long">
- Returns the template node the passed child belongs to or null if it doesn't belong to one.
+ Appends an event handler to this component
<dt class="heading">Parameters:</dt>
<dt>
- <span class="fixedFont"><a href="http://www.w3.org/TR/DOM-Level-2-HTML/html.html#ID-58190037">HTMLElement</a></span> <b>node</b>
+ <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
</dt>
- <dd></dd>
+ <dd>The type of event to listen for</dd>
+
+ <dt>
+ <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>handler</b>
+
+ </dt>
+ <dd>The method the event invokes</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>scope</b>
+
+ </dt>
+ <dd>(optional) The scope in which to execute the handler<br/>function. The handler function's "this" context.</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>options</b>
+
+ </dt>
+ <dd>(optional) An object containing handler configuration<br/>properties. This may contain any of the following properties:<ul><br/><li>scope {Object} The scope in which to execute the handler function. The handler function's "this" context.</li><br/><li>delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.</li><br/><li>single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.</li><br/><li>buffer {Number} Causes the handler to be scheduled to run in an {<b>link</b> Roo.util.DelayedTask} delayed<br/>by the specified number of milliseconds. If the event fires again within that time, the original<br/>handler is <em>not</em> invoked, but the new handler is scheduled in its place.</li><br/></ul><br><br/><p><br/><b>Combining Options</b><br><br/>Using the options argument, it is possible to combine different types of listeners:<br><br/><br><br/>A normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)<br/> <pre><code><br/> el.on('click', this.onClick, this, {<br/> single: true,<br/> delay: 100,<br/> forumId: 4<br/> });<br/> </code></pre><br/><p><br/><b>Attaching multiple handlers in 1 call</b><br><br/>The method also allows for a single argument to be passed which is a config object containing properties<br/>which specify multiple handlers.<br/><pre><code><br/> el.on({<br/> 'click': {<br/> fn: this.onClick,<br/> scope: this,<br/> delay: 100<br/> }, <br/> 'mouseover': {<br/> fn: this.onMouseOver,<br/> scope: this<br/> },<br/> 'mouseout': {<br/> fn: this.onMouseOut,<br/> scope: this<br/> }<br/> });<br/> </code></pre><br/><p><br/>Or a shorthand syntax which passes the same scope object to all handlers:<br/> <pre><code><br/> el.on({<br/> 'click': this.onClick,<br/> 'mouseover': this.onMouseOver,<br/> 'mouseout': this.onMouseOut,<br/> scope: this<br/> });<br/> </code></pre></dd>
</dl>
- <dl class="detailList">
- <dt class="heading">Returns:</dt>
-
- <dd><span class="fixedFont"><a href="http://www.w3.org/TR/DOM-Level-2-HTML/html.html#ID-58190037">HTMLElement</a></span> The template node</dd>
-
- </dl>
-
</td>
<td class="msource">
- Roo.View
+ <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
</td>
</tr>
<td class="sig">
- <a id="Roo.View-method-getEl" name=".getEl"></a>
+ <a id="Roo.View-method-clearSelections" name=".clearSelections"></a>
<div class="fixedFont">
- <span class="attributes"></span><b class="itemname">getEl</b>
+ <span class="attributes"></span><b class="itemname">clearSelections</b>
- ()
+ (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a> <B><i>suppressEvent</i></B>)
- :
-
-
- <a href="./Roo.Element.html#constructor" roo:cls="Roo.Element.html#constructor">Roo.Element</a>
-
-
-
-
</div>
<div class="mdesc">
- <div class="short">Returns the element this view is bound to.</div>
+ <div class="short">Clear all selections</div>
<div class="long">
- Returns the element this view is bound to.
+ Clear all selections
-
-
-
-
<dl class="detailList">
- <dt class="heading">Returns:</dt>
+ <dt class="heading">Parameters:</dt>
- <dd><span class="fixedFont"><a href="./Roo.Element.html#constructor" roo:cls="Roo.Element.html#constructor">Roo.Element</a></span> </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 event</dd>
</dl>
+
+
+
+
<td class="sig">
- <a id="Roo.View-method-getNode" name=".getNode"></a>
+ <a id="Roo.View-method-findItemFromChild" name=".findItemFromChild"></a>
<div class="fixedFont">
- <span class="attributes"></span><b class="itemname">getNode</b>
+ <span class="attributes"></span><b class="itemname">findItemFromChild</b>
- (<a href="http://www.w3.org/TR/DOM-Level-2-HTML/html.html#ID-58190037">HTMLElement</a>/String/Number <B><i>nodeInfo</i></B>)
+ (<a href="http://www.w3.org/TR/DOM-Level-2-HTML/html.html#ID-58190037">HTMLElement</a> <B><i>node</i></B>)
:
</div>
<div class="mdesc">
- <div class="short">Gets a template node.</div>
+ <div class="short">Returns the template node the passed child belongs to or null if it doesn't belong to one.</div>
<div class="long">
- Gets a template node.
+ Returns the template node the passed child belongs to or null if it doesn't belong to one.
<dt class="heading">Parameters:</dt>
<dt>
- <span class="fixedFont"><a href="http://www.w3.org/TR/DOM-Level-2-HTML/html.html#ID-58190037">HTMLElement</a>/String/Number</span> <b>nodeInfo</b>
+ <span class="fixedFont"><a href="http://www.w3.org/TR/DOM-Level-2-HTML/html.html#ID-58190037">HTMLElement</a></span> <b>node</b>
</dt>
- <dd>An HTMLElement template node, index of a template node or the id of a template node</dd>
+ <dd></dd>
</dl>
<dl class="detailList">
<dt class="heading">Returns:</dt>
- <dd><span class="fixedFont"><a href="http://www.w3.org/TR/DOM-Level-2-HTML/html.html#ID-58190037">HTMLElement</a></span> The node or null if it wasn't found</dd>
+ <dd><span class="fixedFont"><a href="http://www.w3.org/TR/DOM-Level-2-HTML/html.html#ID-58190037">HTMLElement</a></span> The template node</dd>
</dl>
</tr>
- <tr class="method-row config-row-alt1 expandable notInherited">
+ <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-getNodes" name=".getNodes"></a>
+ <a id="Roo.util.Observable-method-fireEvent" name=".fireEvent"></a>
<div class="fixedFont">
- <span class="attributes"></span><b class="itemname">getNodes</b>
+ <span class="attributes"></span><b class="itemname">fireEvent</b>
- (<a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a> <B><i>startIndex</i></B>, <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a> <B><i>endIndex</i></B>)
+ (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>eventName</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object...</a> <B><i>args</i></B>)
:
- <a href="./Array.html#constructor" roo:cls="Array.html#constructor">Array</a>
+ <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">Gets a range template nodes.</div>
+ <div class="short">Fires the specified event with the passed parameters (minus the event name).</div>
<div class="long">
- Gets a range template nodes.
+ Fires the specified event with the passed parameters (minus the event name).
<dt class="heading">Parameters:</dt>
<dt>
- <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>startIndex</b>
+ <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
</dt>
<dd></dd>
<dt>
- <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>endIndex</b>
+ <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object...</a></span> <b>args</b>
</dt>
- <dd></dd>
+ <dd>Variable number of parameters are passed to handlers</dd>
</dl>
<dl class="detailList">
<dt class="heading">Returns:</dt>
- <dd><span class="fixedFont"><a href="./Array.html#constructor" roo:cls="Array.html#constructor">Array</a></span> An array of nodes</dd>
+ <dd><span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span> returns false if any of the handlers return false otherwise it returns true</dd>
</dl>
</td>
<td class="msource">
- Roo.View
+ <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
</td>
</tr>
<td class="sig">
- <a id="Roo.View-method-getSelectedIndexes" name=".getSelectedIndexes"></a>
+ <a id="Roo.View-method-getEl" name=".getEl"></a>
<div class="fixedFont">
- <span class="attributes"></span><b class="itemname">getSelectedIndexes</b>
+ <span class="attributes"></span><b class="itemname">getEl</b>
()
:
- <a href="./Array.html#constructor" roo:cls="Array.html#constructor">Array</a>
+ <a href="./Roo.Element.html#constructor" roo:cls="Roo.Element.html#constructor">Roo.Element</a>
</div>
<div class="mdesc">
- <div class="short">Get the indexes of the selected nodes.</div>
+ <div class="short">Returns the element this view is bound to.</div>
<div class="long">
- Get the indexes of the selected nodes.
+ Returns the element this view is bound to.
<dl class="detailList">
<dt class="heading">Returns:</dt>
- <dd><span class="fixedFont"><a href="./Array.html#constructor" roo:cls="Array.html#constructor">Array</a></span> </dd>
+ <dd><span class="fixedFont"><a href="./Roo.Element.html#constructor" roo:cls="Roo.Element.html#constructor">Roo.Element</a></span> </dd>
</dl>
<td class="sig">
- <a id="Roo.View-method-getSelectedNodes" name=".getSelectedNodes"></a>
+ <a id="Roo.View-method-getNode" name=".getNode"></a>
<div class="fixedFont">
- <span class="attributes"></span><b class="itemname">getSelectedNodes</b>
+ <span class="attributes"></span><b class="itemname">getNode</b>
- ()
+ (<a href="http://www.w3.org/TR/DOM-Level-2-HTML/html.html#ID-58190037">HTMLElement</a>/String/Number <B><i>nodeInfo</i></B>)
:
- <a href="./Array.html#constructor" roo:cls="Array.html#constructor">Array</a>
+ <a href="http://www.w3.org/TR/DOM-Level-2-HTML/html.html#ID-58190037">HTMLElement</a>
</div>
<div class="mdesc">
- <div class="short">Get the currently selected nodes.</div>
+ <div class="short">Gets a template node.</div>
<div class="long">
- Get the currently selected nodes.
+ Gets a template node.
+ <dl class="detailList">
+ <dt class="heading">Parameters:</dt>
+
+ <dt>
+ <span class="fixedFont"><a href="http://www.w3.org/TR/DOM-Level-2-HTML/html.html#ID-58190037">HTMLElement</a>/String/Number</span> <b>nodeInfo</b>
+
+ </dt>
+ <dd>An HTMLElement template node, index of a template node or the id of a template node</dd>
+
+ </dl>
+
<dl class="detailList">
<dt class="heading">Returns:</dt>
- <dd><span class="fixedFont"><a href="./Array.html#constructor" roo:cls="Array.html#constructor">Array</a></span> An array of HTMLElements</dd>
+ <dd><span class="fixedFont"><a href="http://www.w3.org/TR/DOM-Level-2-HTML/html.html#ID-58190037">HTMLElement</a></span> The node or null if it wasn't found</dd>
</dl>
<td class="micon"><a class="exi" href="#expand"> </a></td>
+ <td class="sig">
+ <a id="Roo.View-method-getNodes" name=".getNodes"></a>
+ <div class="fixedFont">
+ <span class="attributes"></span><b class="itemname">getNodes</b>
+
+ (<a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a> <B><i>startIndex</i></B>, <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a> <B><i>endIndex</i></B>)
+
+
+ :
+
+
+ <a href="./Array.html#constructor" roo:cls="Array.html#constructor">Array</a>
+
+
+
+
+
+ </div>
+ <div class="mdesc">
+
+ <div class="short">Gets a range template nodes.</div>
+
+
+
+ <div class="long">
+
+ Gets a range template nodes.
+
+
+
+
+
+
+ <dl class="detailList">
+ <dt class="heading">Parameters:</dt>
+
+ <dt>
+ <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>startIndex</b>
+
+ </dt>
+ <dd></dd>
+
+ <dt>
+ <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>endIndex</b>
+
+ </dt>
+ <dd></dd>
+
+ </dl>
+
+
+
+
+
+ <dl class="detailList">
+ <dt class="heading">Returns:</dt>
+
+ <dd><span class="fixedFont"><a href="./Array.html#constructor" roo:cls="Array.html#constructor">Array</a></span> An array of nodes</dd>
+
+ </dl>
+
+
+
+
+
+
+
+ </div>
+ </div>
+
+ </td>
+ <td class="msource">
+
+ Roo.View
+
+ </td>
+ </tr>
+
+
+ <tr class="method-row config-row-alt1 expandable notInherited">
+ <td class="micon"><a class="exi" href="#expand"> </a></td>
+
+
+ <td class="sig">
+ <a id="Roo.View-method-getSelectedIndexes" name=".getSelectedIndexes"></a>
+ <div class="fixedFont">
+ <span class="attributes"></span><b class="itemname">getSelectedIndexes</b>
+
+ ()
+
+
+ :
+
+
+ <a href="./Array.html#constructor" roo:cls="Array.html#constructor">Array</a>
+
+
+
+
+
+ </div>
+ <div class="mdesc">
+
+ <div class="short">Get the indexes of the selected nodes.</div>
+
+
+
+ <div class="long">
+
+ Get the indexes of the selected nodes.
+
+
+
+
+
+
+
+
+
+
+ <dl class="detailList">
+ <dt class="heading">Returns:</dt>
+
+ <dd><span class="fixedFont"><a href="./Array.html#constructor" roo:cls="Array.html#constructor">Array</a></span> </dd>
+
+ </dl>
+
+
+
+
+
+
+
+ </div>
+ </div>
+
+ </td>
+ <td class="msource">
+
+ Roo.View
+
+ </td>
+ </tr>
+
+
+ <tr class="method-row config-row-alt0 expandable notInherited">
+ <td class="micon"><a class="exi" href="#expand"> </a></td>
+
+
+ <td class="sig">
+ <a id="Roo.View-method-getSelectedNodes" name=".getSelectedNodes"></a>
+ <div class="fixedFont">
+ <span class="attributes"></span><b class="itemname">getSelectedNodes</b>
+
+ ()
+
+
+ :
+
+
+ <a href="./Array.html#constructor" roo:cls="Array.html#constructor">Array</a>
+
+
+
+
+
+ </div>
+ <div class="mdesc">
+
+ <div class="short">Get the currently selected nodes.</div>
+
+
+
+ <div class="long">
+
+ Get the currently selected nodes.
+
+
+
+
+
+
+
+
+
+
+ <dl class="detailList">
+ <dt class="heading">Returns:</dt>
+
+ <dd><span class="fixedFont"><a href="./Array.html#constructor" roo:cls="Array.html#constructor">Array</a></span> An array of HTMLElements</dd>
+
+ </dl>
+
+
+
+
+
+
+
+ </div>
+ </div>
+
+ </td>
+ <td class="msource">
+
+ Roo.View
+
+ </td>
+ </tr>
+
+
+ <tr class="method-row config-row-alt1 expandable notInherited">
+ <td class="micon"><a class="exi" href="#expand"> </a></td>
+
+
<td class="sig">
<a id="Roo.View-method-getSelectionCount" name=".getSelectionCount"></a>
<div class="fixedFont">
</div>
<div class="mdesc">
- <div class="short">Get the number of selected nodes.</div>
+ <div class="short">Get the number of selected nodes.</div>
+
+
+
+ <div class="long">
+
+ Get the number of selected nodes.
+
+
+
+
+
+
+
+
+
+
+ <dl class="detailList">
+ <dt class="heading">Returns:</dt>
+
+ <dd><span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> </dd>
+
+ </dl>
+
+
+
+
+
+
+
+ </div>
+ </div>
+
+ </td>
+ <td class="msource">
+
+ Roo.View
+
+ </td>
+ </tr>
+
+
+ <tr class="method-row config-row-alt0 expandable">
+ <td class="micon"><a class="exi" href="#expand"> </a></td>
+
+
+ <td class="sig">
+ <a id="Roo.util.Observable-method-hasListener" name=".hasListener"></a>
+ <div class="fixedFont">
+ <span class="attributes"></span><b class="itemname">hasListener</b>
+
+ (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>eventName</i></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">Checks to see if this object has any listeners for a specified event</div>
<div class="long">
- Get the number of selected nodes.
+ Checks to see if this object has any listeners for a specified event
+ <dl class="detailList">
+ <dt class="heading">Parameters:</dt>
+
+ <dt>
+ <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
+
+ </dt>
+ <dd>The name of the event to check for</dd>
+
+ </dl>
+
<dl class="detailList">
<dt class="heading">Returns:</dt>
- <dd><span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> </dd>
+ <dd><span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span> True if the event is being listened for, else false</dd>
</dl>
</td>
<td class="msource">
- Roo.View
+ <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
</td>
</tr>
</tr>
- <tr class="method-row config-row-alt1 expandable notInherited">
+ <tr class="method-row config-row-alt1 expandable">
+ <td class="micon"><a class="exi" href="#expand"> </a></td>
+
+
+ <td class="sig">
+ <a id="Roo.util.Observable-method-on" name=".on"></a>
+ <div class="fixedFont">
+ <span class="attributes"></span><b class="itemname">on</b>
+
+ (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>eventName</i></B>, <a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a> <B><i>handler</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>scope</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>options</i></B>)
+
+
+
+ </div>
+ <div class="mdesc">
+
+ <div class="short">Appends an event handler to this element (shorthand for addListener)</div>
+
+
+
+ <div class="long">
+
+ Appends an event handler to this element (shorthand for addListener)
+
+
+
+
+
+
+ <dl class="detailList">
+ <dt class="heading">Parameters:</dt>
+
+ <dt>
+ <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
+
+ </dt>
+ <dd>The type of event to listen for</dd>
+
+ <dt>
+ <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>handler</b>
+
+ </dt>
+ <dd>The method the event invokes</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>scope</b>
+
+ </dt>
+ <dd>(optional) The scope in which to execute the handler<br/>function. The handler function's "this" context.</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>options</b>
+
+ </dt>
+ <dd>(optional)</dd>
+
+ </dl>
+
+
+
+
+
+
+
+
+
+
+
+ </div>
+ </div>
+
+ </td>
+ <td class="msource">
+
+ <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
+
+ </td>
+ </tr>
+
+
+ <tr class="method-row config-row-alt0 expandable notInherited">
<td class="micon"><a class="exi" href="#expand"> </a></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.util.Observable-method-purgeListeners" name=".purgeListeners"></a>
+ <div class="fixedFont">
+ <span class="attributes"></span><b class="itemname">purgeListeners</b>
+
+ ()
+
+
+
+ </div>
+ <div class="mdesc">
+
+ <div class="short">Removes all listeners for this object</div>
+
+
+
+ <div class="long">
+
+ Removes all listeners for this object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ </div>
+ </div>
+
+ </td>
+ <td class="msource">
+
+ <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
+
+ </td>
+ </tr>
+
+
<tr class="method-row config-row-alt0 expandable notInherited">
<td class="micon"><a class="exi" href="#expand"> </a></td>
</tr>
- <tr class="method-row config-row-alt0 expandable notInherited">
+ <tr class="method-row config-row-alt0 expandable">
+ <td class="micon"><a class="exi" href="#expand"> </a></td>
+
+
+ <td class="sig">
+ <a id="Roo.util.Observable-method-removeListener" name=".removeListener"></a>
+ <div class="fixedFont">
+ <span class="attributes"></span><b class="itemname">removeListener</b>
+
+ (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>eventName</i></B>, <a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a> <B><i>handler</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>scope</i></B>)
+
+
+
+ </div>
+ <div class="mdesc">
+
+ <div class="short">Removes a listener</div>
+
+
+
+ <div class="long">
+
+ Removes a listener
+
+
+
+
+
+
+ <dl class="detailList">
+ <dt class="heading">Parameters:</dt>
+
+ <dt>
+ <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
+
+ </dt>
+ <dd>The type of event to listen for</dd>
+
+ <dt>
+ <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>handler</b>
+
+ </dt>
+ <dd>The handler to remove</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>scope</b>
+
+ </dt>
+ <dd>(optional) The scope (this object) for the handler</dd>
+
+ </dl>
+
+
+
+
+
+
+
+
+
+
+
+ </div>
+ </div>
+
+ </td>
+ <td class="msource">
+
+ <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
+
+ </td>
+ </tr>
+
+
+ <tr class="method-row config-row-alt1 expandable notInherited">
<td class="micon"><a class="exi" href="#expand"> </a></td>
</tr>
- <tr class="method-row config-row-alt1 expandable notInherited">
+ <tr class="method-row config-row-alt0 expandable notInherited">
<td class="micon"><a class="exi" href="#expand"> </a></td>
</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.util.Observable-method-un" name=".un"></a>
+ <div class="fixedFont">
+ <span class="attributes"></span><b class="itemname">un</b>
+
+ (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>eventName</i></B>, <a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a> <B><i>handler</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>scope</i></B>)
+
+
+
+ </div>
+ <div class="mdesc">
+
+ <div class="short">Removes a listener (shorthand for removeListener)</div>
+
+
+
+ <div class="long">
+
+ Removes a listener (shorthand for removeListener)
+
+
+
+
+
+
+ <dl class="detailList">
+ <dt class="heading">Parameters:</dt>
+
+ <dt>
+ <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
+
+ </dt>
+ <dd>The type of event to listen for</dd>
+
+ <dt>
+ <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>handler</b>
+
+ </dt>
+ <dd>The handler to remove</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>scope</b>
+
+ </dt>
+ <dd>(optional) The scope (this object) for the handler</dd>
+
+ </dl>
+
+
+
+
+
+
+
+
+
+
+
+ </div>
+ </div>
+
+ </td>
+ <td class="msource">
+
+ <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
+
+ </td>
+ </tr>
+
</table>
<!-- ============================== footer ================================= -->
<div class="fineprint" style="clear:both">
- Documentation generated by <a href="http://www.akbkhome.com" target="_blankt">Introspection Doc Generator</a> on Fri Jul 16 2010 19:32:48 GMT+0800 (HKT)
+ Documentation generated by <a href="http://www.akbkhome.com" target="_blankt">Introspection Doc Generator</a> on Tue Jul 27 2010 11:05:07 GMT+0800 (HKT)
Based on
<a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a>
</div>
projects / roojs1 / blobdiff