- <div class="body-wrap">
- <div class="top-tools">
- <a class="inner-link" href="#Ext.grid.CheckboxSelectionModel-props"><img src="../resources/images/default/s.gif" class="item-icon icon-prop">Properties</a>
- <a class="inner-link" href="#Ext.grid.CheckboxSelectionModel-methods"><img src="../resources/images/default/s.gif" class="item-icon icon-method">Methods</a>
- <a class="inner-link" href="#Ext.grid.CheckboxSelectionModel-events"><img src="../resources/images/default/s.gif" class="item-icon icon-event">Events</a>
- <a class="inner-link" href="#Ext.grid.CheckboxSelectionModel-configs"><img src="../resources/images/default/s.gif" class="item-icon icon-config">Config Options</a>
- <a class="bookmark" href="../docs/?class=Ext.grid.CheckboxSelectionModel"><img src="../resources/images/default/s.gif" class="item-icon icon-fav">Direct Link</a>
- </div>
- <div class="inheritance res-block">
-<pre class="res-block-inner"><a ext:cls="Ext.util.Observable" ext:member="" href="output/Ext.util.Observable.html">Observable</a>
- <img src="resources/elbow-end.gif"/><a ext:cls="Ext.grid.AbstractSelectionModel" ext:member="" href="output/Ext.grid.AbstractSelectionModel.html">AbstractSelectionModel</a>
- <img src="resources/elbow-end.gif"/><a ext:cls="Ext.grid.RowSelectionModel" ext:member="" href="output/Ext.grid.RowSelectionModel.html">RowSelectionModel</a>
- <img src="resources/elbow-end.gif"/>CheckboxSelectionModel</pre></div>
- <h1>Class Ext.grid.CheckboxSelectionModel</h1>
- <table cellspacing="0">
- <tr><td class="label">Package:</td><td class="hd-info">Ext.grid</td></tr>
- <tr><td class="label">Defined In:</td><td class="hd-info"><a href="../src/CheckboxSelectionModel.js" target="_blank">CheckboxSelectionModel.js</a></td></tr>
- <tr><td class="label">Class:</td><td class="hd-info">CheckboxSelectionModel</td></tr>
- <tr><td class="label">Extends:</td><td class="hd-info"><a ext:cls="Ext.grid.RowSelectionModel" ext:member="" href="output/Ext.grid.RowSelectionModel.html">RowSelectionModel</a></td></tr>
- </table>
- <div class="description">
- *
-A custom selection model that renders a column of checkboxes that can be toggled to select or deselect rows. </div>
-
- <div class="hr"></div>
- <a id="Ext.grid.CheckboxSelectionModel-configs"></a>
- <h2>Config Options</h2>
- <table cellspacing="0" class="member-table">
- <tr>
- <th class="sig-header" colspan="2">Config Options</th>
- <th class="msource-header">Defined By</th>
- </tr>
- <tr class="config-row expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.grid.CheckboxSelectionModel-header"></a>\r
- <b>header</b> : String <div class="mdesc">\r
- <div class="short">Any valid text or HTML fragment to display in the header cell for the checkbox column (defaults to '<div class="x-...</div>\r
- <div class="long">\r
- Any valid text or HTML fragment to display in the header cell for the checkbox column (defaults to '<div class="x-grid3-hd-checker"> </div>'). The default CSS class of 'x-grid3-hd-checker' displays a checkbox in the header and provides support for automatic check all/none behavior on header click. This string can be replaced by any valid HTML fragment, including a simple text string (e.g., 'Select Rows'), but the automatic check all/none behavior will only work if the 'x-grid3-hd-checker' class is supplied. </div>\r
- </div>\r
- </td>\r
- <td class="msource">CheckboxSelectionModel</td>\r
- </tr>\r
- <tr class="config-row inherited alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.grid.CheckboxSelectionModel-listeners"></a>\r
- <b>listeners</b> : Object <div class="mdesc">\r
- <div class="short">(optional) A config object containing one or more event handlers to be added to this object during initialization. Th...</div>\r
- <div class="long">\r
- (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>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#listeners" href="output/Ext.util.Observable.html#listeners">Observable</a></td>\r
- </tr>\r
- <tr class="config-row inherited">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.grid.CheckboxSelectionModel-moveEditorOnEnter"></a>\r
- <b>moveEditorOnEnter</b> : Boolean <div class="mdesc">\r
- False to turn off moving the editor to the next cell when the enter key is pressed </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.grid.RowSelectionModel" ext:member="#moveEditorOnEnter" href="output/Ext.grid.RowSelectionModel.html#moveEditorOnEnter">RowSelectionModel</a></td>\r
- </tr>\r
- <tr class="config-row inherited alt">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.grid.CheckboxSelectionModel-singleSelect"></a>\r
- <b>singleSelect</b> : Boolean <div class="mdesc">\r
- True to allow selection of only one row at a time (defaults to false) </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.grid.RowSelectionModel" ext:member="#singleSelect" href="output/Ext.grid.RowSelectionModel.html#singleSelect">RowSelectionModel</a></td>\r
- </tr>\r
- <tr class="config-row">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.grid.CheckboxSelectionModel-sortable"></a>\r
- <b>sortable</b> : Boolean <div class="mdesc">\r
- True if the checkbox column is sortable (defaults to false). </div>\r
- </td>\r
- <td class="msource">CheckboxSelectionModel</td>\r
- </tr>\r
- <tr class="config-row alt">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.grid.CheckboxSelectionModel-width"></a>\r
- <b>width</b> : Number <div class="mdesc">\r
- The default width in pixels of the checkbox column (defaults to 20). </div>\r
- </td>\r
- <td class="msource">CheckboxSelectionModel</td>\r
- </tr>\r
- </table>
- <a id="Ext.grid.CheckboxSelectionModel-props"></a>
- <h2>Public Properties</h2>
- <div class="no-members">This class has no public properties.</div> <a id="Ext.grid.CheckboxSelectionModel-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 class="method-row expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.grid.CheckboxSelectionModel-CheckboxSelectionModel"></a>\r
- <b>CheckboxSelectionModel</b>( <code>Object config</code> ) <div class="mdesc">\r
- <div class="short"></div>\r
- <div class="long">\r
- <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>config</code> : Object<div class="sub-desc">The configuration options</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code></code></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">CheckboxSelectionModel</td>\r
- </tr>\r
- <tr class="method-row inherited alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.grid.CheckboxSelectionModel-addEvents"></a>\r
- <b>addEvents</b>( <code>Object object</code> ) : void <div class="mdesc">\r
- <div class="short">Used to define events on this Observable</div>\r
- <div class="long">\r
- Used to define events on this Observable <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>object</code> : Object<div class="sub-desc">The object with the events defined</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>void</code></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#addEvents" href="output/Ext.util.Observable.html#addEvents">Observable</a></td>\r
- </tr>\r
- <tr class="method-row inherited expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.grid.CheckboxSelectionModel-addListener"></a>\r
- <b>addListener</b>( <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> ) : void <div class="mdesc">\r
- <div class="short">Appends an event handler to this component</div>\r
- <div class="long">\r
- Appends an event handler to this component <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <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
-function. The handler function's "this" context.</div></li><li><code>options</code> : Object<div class="sub-desc">(optional) An object containing handler configuration
+<div class="body-wrap" xmlns:ext="http://www.extjs.com"><div class="top-tools"><a class="inner-link" href="#Ext.grid.CheckboxSelectionModel-props"><img src="resources/images/default/s.gif" class="item-icon icon-prop">Properties</a> <a class="inner-link" href="#Ext.grid.CheckboxSelectionModel-methods"><img src="resources/images/default/s.gif" class="item-icon icon-method">Methods</a> <a class="inner-link" href="#Ext.grid.CheckboxSelectionModel-events"><img src="resources/images/default/s.gif" class="item-icon icon-event">Events</a> <a class="inner-link" href="#Ext.grid.CheckboxSelectionModel-configs"><img src="resources/images/default/s.gif" class="item-icon icon-config">Config Options</a> <a class="bookmark" href="../docs/?class=Ext.grid.CheckboxSelectionModel"><img src="resources/images/default/s.gif" class="item-icon icon-fav">Direct Link</a> </div><div class="inheritance res-block"><pre class="res-block-inner"><a href="output/Ext.util.Observable.html" ext:member="" ext:cls="Ext.util.Observable">Observable</a> <img src="resources/elbow-end.gif"><a href="output/Ext.grid.AbstractSelectionModel.html" ext:member="" ext:cls="Ext.grid.AbstractSelectionModel">AbstractSelectionModel</a> <img src="resources/elbow-end.gif"><a href="output/Ext.grid.RowSelectionModel.html" ext:member="" ext:cls="Ext.grid.RowSelectionModel">RowSelectionModel</a> <img src="resources/elbow-end.gif">CheckboxSelectionModel</pre></div><h1>Class <a href="source/CheckboxSelectionModel.html#cls-Ext.grid.CheckboxSelectionModel">Ext.grid.CheckboxSelectionModel</a></h1><table cellspacing="0"><tr><td class="label">Package:</td><td class="hd-info">Ext.grid</td></tr><tr><td class="label">Defined In:</td><td class="hd-info">CheckboxSelectionModel.js</td></tr><tr><td class="label">Class:</td><td class="hd-info"><a href="source/CheckboxSelectionModel.html#cls-Ext.grid.CheckboxSelectionModel">CheckboxSelectionModel</a></td></tr><tr><td class="label">Extends:</td><td class="hd-info"><a href="output/Ext.grid.RowSelectionModel.html" ext:cls="Ext.grid.RowSelectionModel" ext:member="">RowSelectionModel</a></td></tr><tr><td class="hd-info"></td></tr></table><div class="description">A custom selection model that renders a column of checkboxes that can be toggled to select or deselect rows.</div><div class="hr"></div><a id="Ext.grid.CheckboxSelectionModel-configs"></a><h2>Config Options</h2><table cellspacing="0" class="member-table"><tbody><tr><th colspan="2" class="sig-header">Config Options</th><th class="msource-header">Defined By</th></tr><tr class="config-row "><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.grid.CheckboxSelectionModel-checkOnly"></a><b><a href="source/CheckboxSelectionModel.html#cfg-Ext.grid.CheckboxSelectionModel-checkOnly">checkOnly</a></b> : Boolean<div class="mdesc"><tt>true</tt> if rows can only be selected by clicking on the\r
+checkbox column (defaults to <tt>false</tt>).</div></td><td class="msource">CheckboxSelectionModel</td></tr><tr class="config-row expandable "><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.grid.CheckboxSelectionModel-header"></a><b><a href="source/CheckboxSelectionModel.html#cfg-Ext.grid.CheckboxSelectionModel-header">header</a></b> : String<div class="mdesc"><div class="short">Any valid text or HTML fragment to display in the header cell for the \r
+checkbox column. Defaults to:'&lt;div class="...</div><div class="long">Any valid text or HTML fragment to display in the header cell for the\r
+checkbox column. Defaults to:<pre><code><em>'<div class=<em>"x-grid3-hd-checker"</em>>&#160;</div>'</em></tt></code></pre>\r
+The default CSS class of <tt>'x-grid3-hd-checker'</tt> displays a checkbox in the header\r
+and provides support for automatic check all/none behavior on header click. This string\r
+can be replaced by any valid HTML fragment, including a simple text string (e.g.,\r
+<tt>'Select Rows'</tt>), but the automatic check all/none behavior will only work if the\r
+<tt>'x-grid3-hd-checker'</tt> class is supplied.</div></div></td><td class="msource">CheckboxSelectionModel</td></tr><tr class="config-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.util.Observable-listeners"></a><b><a href="source/Observable.html#cfg-Ext.util.Observable-listeners">listeners</a></b> : Object<div class="mdesc"><div class="short">A config object containing one or more event handlers to be added to this\r
+object during initialization. This should ...</div><div class="long"><p>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 href="output/Ext.util.Observable.html#Ext.util.Observable-addListener" ext:member="addListener" ext:cls="Ext.util.Observable">addListener</a> example for attaching multiple handlers at once.</p>
+<br><p><b><u>DOM events from ExtJs <a href="output/Ext.Component.html" ext:cls="Ext.Component">Components</a></u></b></p>
+<br><p>While <i>some</i> ExtJs Component classes export selected DOM events (e.g. "click", "mouseover" etc), this
+is usually only done when extra value can be added. For example the <a href="output/Ext.DataView.html" ext:cls="Ext.DataView">DataView</a>'s
+<b><code><a href="output/Ext.DataView.html#Ext.DataView-click" ext:member="click" ext:cls="Ext.DataView">click</a></code></b> event passing the node clicked on. To access DOM
+events directly from a Component's HTMLElement, listeners must be added to the <i><a href="output/Ext.Component.html#Ext.Component-getEl" ext:member="getEl" ext:cls="Ext.Component">Element</a></i> after the Component
+has been rendered. A plugin can simplify this step:<pre><code><i>// Plugin is configured <b>with</b> a listeners config object.</i>
+<i>// The Component is appended to the argument list of all handler functions.</i>
+Ext.DomObserver = Ext.extend(Object, {
+ constructor: <b>function</b>(config) {
+ this.listeners = config.listeners ? config.listeners : config;
+ },
+
+ <i>// Component passes itself into plugin's init method</i>
+ init: <b>function</b>(c) {
+ <b>var</b> p, l = this.listeners;
+ <b>for</b> (p <b>in</b> l) {
+ <b>if</b> (Ext.isFunction(l[p])) {
+ l[p] = this.createHandler(l[p], c);
+ } <b>else</b> {
+ l[p].fn = this.createHandler(l[p].fn, c);
+ }
+ }
+
+ <i>// Add the listeners to the Element immediately following the render call</i>
+ c.render = c.render.<a href="output/Function.html#Function-createSequence" ext:member="createSequence" ext:cls="Function">createSequence</a>(<b>function</b>() {
+ <b>var</b> e = c.getEl();
+ <b>if</b> (e) {
+ e.on(l);
+ }
+ });
+ },
+
+ createHandler: <b>function</b>(fn, c) {
+ <b>return</b> <b>function</b>(e) {
+ fn.call(this, e, c);
+ };
+ }
+});
+
+<b>var</b> combo = <b>new</b> Ext.form.ComboBox({
+
+ <i>// Collapse combo when its element is clicked on</i>
+ plugins: [ <b>new</b> Ext.DomObserver({
+ click: <b>function</b>(evt, comp) {
+ comp.collapse();
+ }
+ })],
+ store: myStore,
+ typeAhead: true,
+ mode: <em>'local'</em>,
+ triggerAction: <em>'all'</em>
+});</code></pre></p></div></div></td><td class="msource"><a href="output/Ext.util.Observable.html#listeners" ext:member="#listeners" ext:cls="Ext.util.Observable">Observable</a></td></tr><tr class="config-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.grid.RowSelectionModel-moveEditorOnEnter"></a><b><a href="source/RowSelectionModel.html#cfg-Ext.grid.RowSelectionModel-moveEditorOnEnter">moveEditorOnEnter</a></b> : Boolean<div class="mdesc"><div class="short">false to turn off moving the editor to the next row down when the enter key is pressed\r
+or the next row up when shift ...</div><div class="long"><tt>false</tt> to turn off moving the editor to the next row down when the enter key is pressed
+or the next row up when shift + enter keys are pressed.</div></div></td><td class="msource"><a href="output/Ext.grid.RowSelectionModel.html#moveEditorOnEnter" ext:member="#moveEditorOnEnter" ext:cls="Ext.grid.RowSelectionModel">RowSelectionModel</a></td></tr><tr class="config-row inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.grid.RowSelectionModel-singleSelect"></a><b><a href="source/RowSelectionModel.html#cfg-Ext.grid.RowSelectionModel-singleSelect">singleSelect</a></b> : Boolean<div class="mdesc"><tt>true</tt> to allow selection of only one row at a time (defaults to <tt>false</tt>
+allowing multiple selections)</div></td><td class="msource"><a href="output/Ext.grid.RowSelectionModel.html#singleSelect" ext:member="#singleSelect" ext:cls="Ext.grid.RowSelectionModel">RowSelectionModel</a></td></tr><tr class="config-row "><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.grid.CheckboxSelectionModel-sortable"></a><b><a href="source/CheckboxSelectionModel.html#cfg-Ext.grid.CheckboxSelectionModel-sortable">sortable</a></b> : Boolean<div class="mdesc"><tt>true</tt> if the checkbox column is sortable (defaults to\r
+<tt>false</tt>).</div></td><td class="msource">CheckboxSelectionModel</td></tr><tr class="config-row "><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.grid.CheckboxSelectionModel-width"></a><b><a href="source/CheckboxSelectionModel.html#cfg-Ext.grid.CheckboxSelectionModel-width">width</a></b> : Number<div class="mdesc">The default width in pixels of the checkbox column (defaults to <tt>20</tt>).</div></td><td class="msource">CheckboxSelectionModel</td></tr></tbody></table><a id="Ext.grid.CheckboxSelectionModel-props"></a><h2>Public Properties</h2><table cellspacing="0" class="member-table"><tbody><tr><th colspan="2" class="sig-header">Property</th><th class="msource-header">Defined By</th></tr><tr class="property-row inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.grid.AbstractSelectionModel-grid"></a><b><a href="source/AbstractSelectionModel.html#prop-Ext.grid.AbstractSelectionModel-grid">grid</a></b> : Object<div class="mdesc">The GridPanel for which this SelectionModel is handling selection. Read-only.</div></td><td class="msource"><a href="output/Ext.grid.AbstractSelectionModel.html#grid" ext:member="#grid" ext:cls="Ext.grid.AbstractSelectionModel">AbstractSelectionModel</a></td></tr></tbody></table><a id="Ext.grid.CheckboxSelectionModel-methods"></a><h2>Public Methods</h2><table cellspacing="0" class="member-table"><tbody><tr><th colspan="2" class="sig-header">Method</th><th class="msource-header">Defined By</th></tr><tr class="method-row expandable"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.grid.CheckboxSelectionModel-CheckboxSelectionModel"></a><b><a href="source/CheckboxSelectionModel.html#cls-Ext.grid.CheckboxSelectionModel">CheckboxSelectionModel</a></b>( <code>Object config</code> )\r
+ <div class="mdesc"><div class="short"></div><div class="long"><div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>config</code> : Object<div class="sub-desc">The configuration options</div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource">CheckboxSelectionModel</td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.util.Observable-addEvents"></a><b><a href="source/Observable.html#method-Ext.util.Observable-addEvents">addEvents</a></b>( <code>Object|String o</code>, <code>string Optional.</code> )\r
+ :\r
+ void<div class="mdesc"><div class="short">Adds the specified events to the list of events which this Observable may fire.</div><div class="long">Adds the specified events to the list of events which this Observable may fire.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>o</code> : Object|String<div class="sub-desc">Either an object with event names as properties with a value of <code>true</code>
+or the first event name string if multiple event names are being passed as separate parameters.</div></li><li><code>Optional.</code> : string<div class="sub-desc">Event name if multiple event names are being passed as separate parameters.
+Usage:<pre><code>this.addEvents(<em>'storeloaded'</em>, <em>'storecleared'</em>);</code></pre></div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.util.Observable.html#addEvents" ext:member="#addEvents" ext:cls="Ext.util.Observable">Observable</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.util.Observable-addListener"></a><b><a href="source/Observable.html#method-Ext.util.Observable-addListener">addListener</a></b>( <code>String eventName</code>, <code>Function handler</code>, <span title="Optional" class="optional">[<code>Object scope</code>]</span>, <span title="Optional" class="optional">[<code>Object options</code>]</span> )\r
+ :\r
+ void<div class="mdesc"><div class="short">Appends an event handler to this object.</div><div class="long">Appends an event handler to this object.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>eventName</code> : String<div class="sub-desc">The name of the 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 (<code><b>this</b></code> reference) in which the handler function is executed.
+<b>If omitted, defaults to the object which fired the event.</b></div></li><li><code>options</code> : Object<div class="sub-desc">(optional) An object containing handler configuration.
properties. This may contain any of the following properties:<ul>
-<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>
-<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>
-<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>
-<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
+<li><b>scope</b> : Object<div class="sub-desc">The scope (<code><b>this</b></code> reference) in which the handler function is executed.
+<b>If omitted, defaults to the object which fired the event.</b></div></li>
+<li><b>delay</b> : Number<div class="sub-desc">The number of milliseconds to delay the invocation of the handler after the event fires.</div></li>
+<li><b>single</b> : Boolean<div class="sub-desc">True to add a handler to handle just the next firing of the event, and then remove itself.</div></li>
+<li><b>buffer</b> : Number<div class="sub-desc">Causes the handler to be scheduled to run in an <a href="output/Ext.util.DelayedTask.html" ext:cls="Ext.util.DelayedTask">Ext.util.DelayedTask</a> delayed
by the specified number of milliseconds. If the event fires again within that time, the original
-handler is <em>not</em> invoked, but the new handler is scheduled in its place.</p></li>
+handler is <em>not</em> invoked, but the new handler is scheduled in its place.</div></li>
+<li><b>target</b> : Observable<div class="sub-desc">Only call the handler if the event was fired on the target Observable, <i>not</i>
+if the event was bubbled up from a child Observable.</div></li>
</ul><br>
<p>
<b>Combining Options</b><br>
Using the options argument, it is possible to combine different types of listeners:<br>
<br>
-A normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)
-<pre><code>el.on(<em>'click'</em>, <b>this</b>.onClick, <b>this</b>, {
- single: true,
- delay: 100,
- forumId: 4
+A delayed, one-time listener.
+<pre><code>myDataView.on(<em>'click'</em>, this.onClick, this, {
+single: true,
+delay: 100
});</code></pre>
<p>
<b>Attaching multiple handlers in 1 call</b><br>
The method also allows for a single argument to be passed which is a config object containing properties
which specify multiple handlers.
<p>
-<pre><code>foo.on({
- <em>'click'</em> : {
- fn: <b>this</b>.onClick,
- scope: <b>this</b>,
- delay: 100
- },
- <em>'mouseover'</em> : {
- fn: <b>this</b>.onMouseOver,
- scope: <b>this</b>
- },
- <em>'mouseout'</em> : {
- fn: <b>this</b>.onMouseOut,
- scope: <b>this</b>
- }
+<pre><code>myGridPanel.on({
+<em>'click'</em> : {
+ fn: this.onClick,
+ scope: this,
+ delay: 100
+},
+<em>'mouseover'</em> : {
+ fn: this.onMouseOver,
+ scope: this
+},
+<em>'mouseout'</em> : {
+ fn: this.onMouseOut,
+ scope: this
+}
});</code></pre>
<p>
Or a shorthand syntax:<br>
-<pre><code>foo.on({
- <em>'click'</em> : <b>this</b>.onClick,
- <em>'mouseover'</em> : <b>this</b>.onMouseOver,
- <em>'mouseout'</em> : <b>this</b>.onMouseOut,
- scope: <b>this</b>
-});</code></pre></div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>void</code></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#addListener" href="output/Ext.util.Observable.html#addListener">Observable</a></td>\r
- </tr>\r
- <tr class="method-row inherited alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.grid.CheckboxSelectionModel-clearSelections"></a>\r
- <b>clearSelections</b>() : void <div class="mdesc">\r
- <div class="short">Clears all selections.</div>\r
- <div class="long">\r
- Clears all selections. <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li>None.</li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>void</code></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.grid.RowSelectionModel" ext:member="#clearSelections" href="output/Ext.grid.RowSelectionModel.html#clearSelections">RowSelectionModel</a></td>\r
- </tr>\r
- <tr class="method-row inherited expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.grid.CheckboxSelectionModel-deselectRange"></a>\r
- <b>deselectRange</b>( <code>Number startRow</code>, <code>Number endRow</code> ) : void <div class="mdesc">\r
- <div class="short">Deselects a range of rows. All rows in between startRow and endRow are also deselected.</div>\r
- <div class="long">\r
- Deselects a range of rows. All rows in between startRow and endRow are also deselected. <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>startRow</code> : Number<div class="sub-desc">The index of the first row in the range</div></li><li><code>endRow</code> : Number<div class="sub-desc">The index of the last row in the range</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>void</code></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.grid.RowSelectionModel" ext:member="#deselectRange" href="output/Ext.grid.RowSelectionModel.html#deselectRange">RowSelectionModel</a></td>\r
- </tr>\r
- <tr class="method-row inherited alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.grid.CheckboxSelectionModel-deselectRow"></a>\r
- <b>deselectRow</b>( <code>Number row</code> ) : void <div class="mdesc">\r
- <div class="short">Deselects a row.</div>\r
- <div class="long">\r
- Deselects a row. <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>row</code> : Number<div class="sub-desc">The index of the row to deselect</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>void</code></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.grid.RowSelectionModel" ext:member="#deselectRow" href="output/Ext.grid.RowSelectionModel.html#deselectRow">RowSelectionModel</a></td>\r
- </tr>\r
- <tr class="method-row inherited expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.grid.CheckboxSelectionModel-each"></a>\r
- <b>each</b>( <code>Function fn</code>, <span class="optional" title="Optional">[<code>Object scope</code>]</span> ) : Boolean <div class="mdesc">\r
- <div class="short">Calls the passed function with each selection. If the function returns false, iteration is
-stopped and this function ...</div>\r
- <div class="long">\r
- Calls the passed function with each selection. If the function returns false, iteration is
-stopped and this function returns false. Otherwise it returns true. <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>fn</code> : Function<div class="sub-desc"></div></li><li><code>scope</code> : Object<div class="sub-desc">(optional)</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>Boolean</code><div class="sub-desc">true if all selections were iterated</div></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.grid.RowSelectionModel" ext:member="#each" href="output/Ext.grid.RowSelectionModel.html#each">RowSelectionModel</a></td>\r
- </tr>\r
- <tr class="method-row inherited alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.grid.CheckboxSelectionModel-fireEvent"></a>\r
- <b>fireEvent</b>( <code>String eventName</code>, <code>Object... args</code> ) : Boolean <div class="mdesc">\r
- <div class="short">Fires the specified event with the passed parameters (minus the event name).</div>\r
- <div class="long">\r
- Fires the specified event with the passed parameters (minus the event name). <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <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>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>Boolean</code><div class="sub-desc">returns false if any of the handlers return false otherwise it returns true</div></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#fireEvent" href="output/Ext.util.Observable.html#fireEvent">Observable</a></td>\r
- </tr>\r
- <tr class="method-row inherited expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.grid.CheckboxSelectionModel-getCount"></a>\r
- <b>getCount</b>() : Number <div class="mdesc">\r
- <div class="short">Gets the number of selected rows.</div>\r
- <div class="long">\r
- Gets the number of selected rows. <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li>None.</li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>Number</code></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.grid.RowSelectionModel" ext:member="#getCount" href="output/Ext.grid.RowSelectionModel.html#getCount">RowSelectionModel</a></td>\r
- </tr>\r
- <tr class="method-row inherited alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.grid.CheckboxSelectionModel-getSelected"></a>\r
- <b>getSelected</b>() : Record <div class="mdesc">\r
- <div class="short">Returns the first selected record.</div>\r
- <div class="long">\r
- Returns the first selected record. <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li>None.</li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>Record</code></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.grid.RowSelectionModel" ext:member="#getSelected" href="output/Ext.grid.RowSelectionModel.html#getSelected">RowSelectionModel</a></td>\r
- </tr>\r
- <tr class="method-row inherited expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.grid.CheckboxSelectionModel-getSelections"></a>\r
- <b>getSelections</b>() : Array <div class="mdesc">\r
- <div class="short">Returns the selected records</div>\r
- <div class="long">\r
- Returns the selected records <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li>None.</li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>Array</code><div class="sub-desc">Array of selected records</div></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.grid.RowSelectionModel" ext:member="#getSelections" href="output/Ext.grid.RowSelectionModel.html#getSelections">RowSelectionModel</a></td>\r
- </tr>\r
- <tr class="method-row inherited alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.grid.CheckboxSelectionModel-hasListener"></a>\r
- <b>hasListener</b>( <code>String eventName</code> ) : Boolean <div class="mdesc">\r
- <div class="short">Checks to see if this object has any listeners for a specified event</div>\r
- <div class="long">\r
- Checks to see if this object has any listeners for a specified event <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>eventName</code> : String<div class="sub-desc">The name of the event to check for</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>Boolean</code><div class="sub-desc">True if the event is being listened for, else false</div></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#hasListener" href="output/Ext.util.Observable.html#hasListener">Observable</a></td>\r
- </tr>\r
- <tr class="method-row inherited expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.grid.CheckboxSelectionModel-hasNext"></a>\r
- <b>hasNext</b>() : Boolean <div class="mdesc">\r
- <div class="short">Returns true if there is a next record to select</div>\r
- <div class="long">\r
- Returns true if there is a next record to select <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li>None.</li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>Boolean</code></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.grid.RowSelectionModel" ext:member="#hasNext" href="output/Ext.grid.RowSelectionModel.html#hasNext">RowSelectionModel</a></td>\r
- </tr>\r
- <tr class="method-row inherited alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.grid.CheckboxSelectionModel-hasPrevious"></a>\r
- <b>hasPrevious</b>() : Boolean <div class="mdesc">\r
- <div class="short">Returns true if there is a previous record to select</div>\r
- <div class="long">\r
- Returns true if there is a previous record to select <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li>None.</li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>Boolean</code></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.grid.RowSelectionModel" ext:member="#hasPrevious" href="output/Ext.grid.RowSelectionModel.html#hasPrevious">RowSelectionModel</a></td>\r
- </tr>\r
- <tr class="method-row inherited expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.grid.CheckboxSelectionModel-hasSelection"></a>\r
- <b>hasSelection</b>() : Boolean <div class="mdesc">\r
- <div class="short">Returns True if there is a selection.</div>\r
- <div class="long">\r
- Returns True if there is a selection. <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li>None.</li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>Boolean</code></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.grid.RowSelectionModel" ext:member="#hasSelection" href="output/Ext.grid.RowSelectionModel.html#hasSelection">RowSelectionModel</a></td>\r
- </tr>\r
- <tr class="method-row inherited alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.grid.CheckboxSelectionModel-isIdSelected"></a>\r
- <b>isIdSelected</b>( <code>String id</code> ) : Boolean <div class="mdesc">\r
- <div class="short">Returns True if the specified record id is selected.</div>\r
- <div class="long">\r
- Returns True if the specified record id is selected. <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>id</code> : String<div class="sub-desc">The id of record to check</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>Boolean</code></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.grid.RowSelectionModel" ext:member="#isIdSelected" href="output/Ext.grid.RowSelectionModel.html#isIdSelected">RowSelectionModel</a></td>\r
- </tr>\r
- <tr class="method-row inherited expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.grid.CheckboxSelectionModel-isLocked"></a>\r
- <b>isLocked</b>() : Boolean <div class="mdesc">\r
- <div class="short">Returns true if the selections are locked.</div>\r
- <div class="long">\r
- Returns true if the selections are locked. <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li>None.</li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>Boolean</code></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.grid.AbstractSelectionModel" ext:member="#isLocked" href="output/Ext.grid.AbstractSelectionModel.html#isLocked">AbstractSelectionModel</a></td>\r
- </tr>\r
- <tr class="method-row inherited alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.grid.CheckboxSelectionModel-isSelected"></a>\r
- <b>isSelected</b>( <code>Number/Record record</code> ) : Boolean <div class="mdesc">\r
- <div class="short">Returns True if the specified row is selected.</div>\r
- <div class="long">\r
- Returns True if the specified row is selected. <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>record</code> : Number/Record<div class="sub-desc">The record or index of the record to check</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>Boolean</code></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.grid.RowSelectionModel" ext:member="#isSelected" href="output/Ext.grid.RowSelectionModel.html#isSelected">RowSelectionModel</a></td>\r
- </tr>\r
- <tr class="method-row inherited expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.grid.CheckboxSelectionModel-lock"></a>\r
- <b>lock</b>() : void <div class="mdesc">\r
- <div class="short">Locks the selections.</div>\r
- <div class="long">\r
- Locks the selections. <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li>None.</li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>void</code></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.grid.AbstractSelectionModel" ext:member="#lock" href="output/Ext.grid.AbstractSelectionModel.html#lock">AbstractSelectionModel</a></td>\r
- </tr>\r
- <tr class="method-row inherited alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.grid.CheckboxSelectionModel-on"></a>\r
- <b>on</b>( <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> ) : void <div class="mdesc">\r
- <div class="short">Appends an event handler to this element (shorthand for addListener)</div>\r
- <div class="long">\r
- Appends an event handler to this element (shorthand for addListener) <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <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
-function. The handler function's "this" context.</div></li><li><code>options</code> : Object<div class="sub-desc">(optional)</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>void</code></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#on" href="output/Ext.util.Observable.html#on">Observable</a></td>\r
- </tr>\r
- <tr class="method-row inherited expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.grid.CheckboxSelectionModel-purgeListeners"></a>\r
- <b>purgeListeners</b>() : void <div class="mdesc">\r
- <div class="short">Removes all listeners for this object</div>\r
- <div class="long">\r
- Removes all listeners for this object <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li>None.</li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>void</code></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#purgeListeners" href="output/Ext.util.Observable.html#purgeListeners">Observable</a></td>\r
- </tr>\r
- <tr class="method-row inherited alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.grid.CheckboxSelectionModel-relayEvents"></a>\r
- <b>relayEvents</b>( <code>Object o</code>, <code>Array events</code> ) : void <div class="mdesc">\r
- <div class="short">Relays selected events from the specified Observable as if the events were fired by <tt><b>this</b></tt>.</div>\r
- <div class="long">\r
- Relays selected events from the specified Observable as if the events were fired by <tt><b>this</b></tt>. <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <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>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>void</code></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#relayEvents" href="output/Ext.util.Observable.html#relayEvents">Observable</a></td>\r
- </tr>\r
- <tr class="method-row inherited expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.grid.CheckboxSelectionModel-removeListener"></a>\r
- <b>removeListener</b>( <code>String eventName</code>, <code>Function handler</code>, <span class="optional" title="Optional">[<code>Object scope</code>]</span> ) : void <div class="mdesc">\r
- <div class="short">Removes a listener</div>\r
- <div class="long">\r
- Removes a listener <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <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>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>void</code></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#removeListener" href="output/Ext.util.Observable.html#removeListener">Observable</a></td>\r
- </tr>\r
- <tr class="method-row inherited alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.grid.CheckboxSelectionModel-resumeEvents"></a>\r
- <b>resumeEvents</b>() : void <div class="mdesc">\r
- <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>\r
- <div class="long">\r
- 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">\r
- <strong>Parameters:</strong>\r
- <ul><li>None.</li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>void</code></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#resumeEvents" href="output/Ext.util.Observable.html#resumeEvents">Observable</a></td>\r
- </tr>\r
- <tr class="method-row inherited expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.grid.CheckboxSelectionModel-selectAll"></a>\r
- <b>selectAll</b>() : void <div class="mdesc">\r
- <div class="short">Selects all rows.</div>\r
- <div class="long">\r
- Selects all rows. <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li>None.</li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>void</code></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.grid.RowSelectionModel" ext:member="#selectAll" href="output/Ext.grid.RowSelectionModel.html#selectAll">RowSelectionModel</a></td>\r
- </tr>\r
- <tr class="method-row inherited alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.grid.CheckboxSelectionModel-selectFirstRow"></a>\r
- <b>selectFirstRow</b>() : void <div class="mdesc">\r
- <div class="short">Selects the first row in the grid.</div>\r
- <div class="long">\r
- Selects the first row in the grid. <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li>None.</li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>void</code></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.grid.RowSelectionModel" ext:member="#selectFirstRow" href="output/Ext.grid.RowSelectionModel.html#selectFirstRow">RowSelectionModel</a></td>\r
- </tr>\r
- <tr class="method-row inherited expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.grid.CheckboxSelectionModel-selectLastRow"></a>\r
- <b>selectLastRow</b>( <span class="optional" title="Optional">[<code>Boolean keepExisting</code>]</span> ) : void <div class="mdesc">\r
- <div class="short">Select the last row.</div>\r
- <div class="long">\r
- Select the last row. <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>keepExisting</code> : Boolean<div class="sub-desc">(optional) True to keep existing selections</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>void</code></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.grid.RowSelectionModel" ext:member="#selectLastRow" href="output/Ext.grid.RowSelectionModel.html#selectLastRow">RowSelectionModel</a></td>\r
- </tr>\r
- <tr class="method-row inherited alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.grid.CheckboxSelectionModel-selectNext"></a>\r
- <b>selectNext</b>( <span class="optional" title="Optional">[<code>Boolean keepExisting</code>]</span> ) : Boolean <div class="mdesc">\r
- <div class="short">Selects the row immediately following the last selected row.</div>\r
- <div class="long">\r
- Selects the row immediately following the last selected row. <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>keepExisting</code> : Boolean<div class="sub-desc">(optional) True to keep existing selections</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>Boolean</code><div class="sub-desc">True if there is a next row, else false</div></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.grid.RowSelectionModel" ext:member="#selectNext" href="output/Ext.grid.RowSelectionModel.html#selectNext">RowSelectionModel</a></td>\r
- </tr>\r
- <tr class="method-row inherited expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.grid.CheckboxSelectionModel-selectPrevious"></a>\r
- <b>selectPrevious</b>( <span class="optional" title="Optional">[<code>Boolean keepExisting</code>]</span> ) : Boolean <div class="mdesc">\r
- <div class="short">Selects the row that precedes the last selected row.</div>\r
- <div class="long">\r
- Selects the row that precedes the last selected row. <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>keepExisting</code> : Boolean<div class="sub-desc">(optional) True to keep existing selections</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>Boolean</code><div class="sub-desc">True if there is a previous row, else false</div></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.grid.RowSelectionModel" ext:member="#selectPrevious" href="output/Ext.grid.RowSelectionModel.html#selectPrevious">RowSelectionModel</a></td>\r
- </tr>\r
- <tr class="method-row inherited alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.grid.CheckboxSelectionModel-selectRange"></a>\r
- <b>selectRange</b>( <code>Number startRow</code>, <code>Number endRow</code>, <span class="optional" title="Optional">[<code>Boolean keepExisting</code>]</span> ) : void <div class="mdesc">\r
- <div class="short">Selects a range of rows. All rows in between startRow and endRow are also selected.</div>\r
- <div class="long">\r
- Selects a range of rows. All rows in between startRow and endRow are also selected. <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>startRow</code> : Number<div class="sub-desc">The index of the first row in the range</div></li><li><code>endRow</code> : Number<div class="sub-desc">The index of the last row in the range</div></li><li><code>keepExisting</code> : Boolean<div class="sub-desc">(optional) True to retain existing selections</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>void</code></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.grid.RowSelectionModel" ext:member="#selectRange" href="output/Ext.grid.RowSelectionModel.html#selectRange">RowSelectionModel</a></td>\r
- </tr>\r
- <tr class="method-row inherited expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.grid.CheckboxSelectionModel-selectRecords"></a>\r
- <b>selectRecords</b>( <code>Array records</code>, <span class="optional" title="Optional">[<code>Boolean keepExisting</code>]</span> ) : void <div class="mdesc">\r
- <div class="short">Select records.</div>\r
- <div class="long">\r
- Select records. <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>records</code> : Array<div class="sub-desc">The records to select</div></li><li><code>keepExisting</code> : Boolean<div class="sub-desc">(optional) True to keep existing selections</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>void</code></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.grid.RowSelectionModel" ext:member="#selectRecords" href="output/Ext.grid.RowSelectionModel.html#selectRecords">RowSelectionModel</a></td>\r
- </tr>\r
- <tr class="method-row inherited alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.grid.CheckboxSelectionModel-selectRow"></a>\r
- <b>selectRow</b>( <code>Number row</code>, <span class="optional" title="Optional">[<code>Boolean keepExisting</code>]</span> ) : void <div class="mdesc">\r
- <div class="short">Selects a row.</div>\r
- <div class="long">\r
- Selects a row. <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>row</code> : Number<div class="sub-desc">The index of the row to select</div></li><li><code>keepExisting</code> : Boolean<div class="sub-desc">(optional) True to keep existing selections</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>void</code></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.grid.RowSelectionModel" ext:member="#selectRow" href="output/Ext.grid.RowSelectionModel.html#selectRow">RowSelectionModel</a></td>\r
- </tr>\r
- <tr class="method-row inherited expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.grid.CheckboxSelectionModel-selectRows"></a>\r
- <b>selectRows</b>( <code>Array rows</code>, <span class="optional" title="Optional">[<code>Boolean keepExisting</code>]</span> ) : void <div class="mdesc">\r
- <div class="short">Selects multiple rows.</div>\r
- <div class="long">\r
- Selects multiple rows. <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>rows</code> : Array<div class="sub-desc">Array of the indexes of the row to select</div></li><li><code>keepExisting</code> : Boolean<div class="sub-desc">(optional) True to keep existing selections (defaults to false)</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>void</code></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.grid.RowSelectionModel" ext:member="#selectRows" href="output/Ext.grid.RowSelectionModel.html#selectRows">RowSelectionModel</a></td>\r
- </tr>\r
- <tr class="method-row inherited alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.grid.CheckboxSelectionModel-suspendEvents"></a>\r
- <b>suspendEvents</b>() : void <div class="mdesc">\r
- <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>\r
- <div class="long">\r
- 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">\r
- <strong>Parameters:</strong>\r
- <ul><li>None.</li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>void</code></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#suspendEvents" href="output/Ext.util.Observable.html#suspendEvents">Observable</a></td>\r
- </tr>\r
- <tr class="method-row inherited expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.grid.CheckboxSelectionModel-un"></a>\r
- <b>un</b>( <code>String eventName</code>, <code>Function handler</code>, <span class="optional" title="Optional">[<code>Object scope</code>]</span> ) : void <div class="mdesc">\r
- <div class="short">Removes a listener (shorthand for removeListener)</div>\r
- <div class="long">\r
- Removes a listener (shorthand for removeListener) <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <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>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>void</code></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#un" href="output/Ext.util.Observable.html#un">Observable</a></td>\r
- </tr>\r
- <tr class="method-row inherited alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.grid.CheckboxSelectionModel-unlock"></a>\r
- <b>unlock</b>() : void <div class="mdesc">\r
- <div class="short">Unlocks the selections.</div>\r
- <div class="long">\r
- Unlocks the selections. <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li>None.</li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>void</code></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.grid.AbstractSelectionModel" ext:member="#unlock" href="output/Ext.grid.AbstractSelectionModel.html#unlock">AbstractSelectionModel</a></td>\r
- </tr>\r
- </table>
- <a id="Ext.grid.CheckboxSelectionModel-events"></a>
- <h2>Public Events</h2>
- <table cellspacing="0" class="member-table">
- <tr>
- <th class="sig-header" colspan="2">Event</th>
- <th class="msource-header">Defined By</th>
- </tr>
- <tr class="event-row inherited expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.grid.CheckboxSelectionModel-beforerowselect"></a>\r
- <b>beforerowselect</b> : ( <code>SelectionModel this</code>, <code>Number rowIndex</code>, <code>Boolean keepExisting</code>, <code>Record record</code> ) <div class="mdesc">\r
- <div class="short">Fires when a row is being selected, return false to cancel.</div>\r
- <div class="long">\r
- Fires when a row is being selected, return false to cancel. <div class="mdetail-params">\r
- <strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>\r
- <ul><li><code>this</code> : SelectionModel<div class="sub-desc"></div></li><li><code>rowIndex</code> : Number<div class="sub-desc">The index to be selected</div></li><li><code>keepExisting</code> : Boolean<div class="sub-desc">False if other selections will be cleared</div></li><li><code>record</code> : Record<div class="sub-desc">The record to be selected</div></li> </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.grid.RowSelectionModel" ext:member="#event-beforerowselect" href="output/Ext.grid.RowSelectionModel.html#event-beforerowselect">RowSelectionModel</a></td>\r
- </tr>\r
- <tr class="event-row inherited alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.grid.CheckboxSelectionModel-rowdeselect"></a>\r
- <b>rowdeselect</b> : ( <code>SelectionModel this</code>, <code>Number rowIndex</code>, <code>Record record</code> ) <div class="mdesc">\r
- <div class="short">Fires when a row is deselected.</div>\r
- <div class="long">\r
- Fires when a row is deselected. <div class="mdetail-params">\r
- <strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>\r
- <ul><li><code>this</code> : SelectionModel<div class="sub-desc"></div></li><li><code>rowIndex</code> : Number<div class="sub-desc"></div></li><li><code>record</code> : Record<div class="sub-desc"></div></li> </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.grid.RowSelectionModel" ext:member="#event-rowdeselect" href="output/Ext.grid.RowSelectionModel.html#event-rowdeselect">RowSelectionModel</a></td>\r
- </tr>\r
- <tr class="event-row inherited expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.grid.CheckboxSelectionModel-rowselect"></a>\r
- <b>rowselect</b> : ( <code>SelectionModel this</code>, <code>Number rowIndex</code>, <code>Ext.data.Record r</code> ) <div class="mdesc">\r
- <div class="short">Fires when a row is selected.</div>\r
- <div class="long">\r
- Fires when a row is selected. <div class="mdetail-params">\r
- <strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>\r
- <ul><li><code>this</code> : SelectionModel<div class="sub-desc"></div></li><li><code>rowIndex</code> : Number<div class="sub-desc">The selected index</div></li><li><code>r</code> : Ext.data.Record<div class="sub-desc">The selected record</div></li> </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.grid.RowSelectionModel" ext:member="#event-rowselect" href="output/Ext.grid.RowSelectionModel.html#event-rowselect">RowSelectionModel</a></td>\r
- </tr>\r
- <tr class="event-row inherited alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.grid.CheckboxSelectionModel-selectionchange"></a>\r
- <b>selectionchange</b> : ( <code>SelectionModel this</code> ) <div class="mdesc">\r
- <div class="short">Fires when the selection changes</div>\r
- <div class="long">\r
- Fires when the selection changes <div class="mdetail-params">\r
- <strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>\r
- <ul><li><code>this</code> : SelectionModel<div class="sub-desc"></div></li> </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.grid.RowSelectionModel" ext:member="#event-selectionchange" href="output/Ext.grid.RowSelectionModel.html#event-selectionchange">RowSelectionModel</a></td>\r
- </tr>\r
- </table>
-
- </div>
\ No newline at end of file
+<pre><code>myGridPanel.on({
+<em>'click'</em> : this.onClick,
+<em>'mouseover'</em> : this.onMouseOver,
+<em>'mouseout'</em> : this.onMouseOut,
+ scope: this
+});</code></pre></div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.util.Observable.html#addListener" ext:member="#addListener" ext:cls="Ext.util.Observable">Observable</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.grid.RowSelectionModel-clearSelections"></a><b><a href="source/RowSelectionModel.html#method-Ext.grid.RowSelectionModel-clearSelections">clearSelections</a></b>( <span title="Optional" class="optional">[<code>Boolean fast</code>]</span> )\r
+ :\r
+ void<div class="mdesc"><div class="short">Clears all selections if the selection model\r
+is not locked.</div><div class="long">Clears all selections if the selection model
+<a href="output/Ext.grid.AbstractSelectionModel.html#Ext.grid.AbstractSelectionModel-isLocked" ext:member="isLocked" ext:cls="Ext.grid.AbstractSelectionModel">is not locked</a>.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>fast</code> : Boolean<div class="sub-desc">(optional) <tt>true</tt> to bypass the
+conditional checks and events described in <a href="output/Ext.grid.RowSelectionModel.html#Ext.grid.RowSelectionModel-deselectRow" ext:member="deselectRow" ext:cls="Ext.grid.RowSelectionModel">deselectRow</a>.</div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.grid.RowSelectionModel.html#clearSelections" ext:member="#clearSelections" ext:cls="Ext.grid.RowSelectionModel">RowSelectionModel</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.grid.RowSelectionModel-deselectRange"></a><b><a href="source/RowSelectionModel.html#method-Ext.grid.RowSelectionModel-deselectRange">deselectRange</a></b>( <code>Number startRow</code>, <code>Number endRow</code> )\r
+ :\r
+ void<div class="mdesc"><div class="short">Deselects a range of rows if the selection model\r
+is not locked. \r
+All rows in between startRow and endRow are also de...</div><div class="long">Deselects a range of rows if the selection model
+<a href="output/Ext.grid.AbstractSelectionModel.html#Ext.grid.AbstractSelectionModel-isLocked" ext:member="isLocked" ext:cls="Ext.grid.AbstractSelectionModel">is not locked</a>.
+All rows in between startRow and endRow are also deselected.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>startRow</code> : Number<div class="sub-desc">The index of the first row in the range</div></li><li><code>endRow</code> : Number<div class="sub-desc">The index of the last row in the range</div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.grid.RowSelectionModel.html#deselectRange" ext:member="#deselectRange" ext:cls="Ext.grid.RowSelectionModel">RowSelectionModel</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.grid.RowSelectionModel-deselectRow"></a><b><a href="source/RowSelectionModel.html#method-Ext.grid.RowSelectionModel-deselectRow">deselectRow</a></b>( <code>Number row</code>, <span title="Optional" class="optional">[<code>Boolean preventViewNotify</code>]</span> )\r
+ :\r
+ void<div class="mdesc"><div class="short">Deselects a row. Before deselecting a row, checks if the selection model\r
+is locked.\r
+If this check is satisfied the r...</div><div class="long">Deselects a row. Before deselecting a row, checks if the selection model
+<a href="output/Ext.grid.AbstractSelectionModel.html#Ext.grid.AbstractSelectionModel-isLocked" ext:member="isLocked" ext:cls="Ext.grid.AbstractSelectionModel">is locked</a>.
+If this check is satisfied the row will be deselected and followed up by
+firing the <a href="output/Ext.grid.RowSelectionModel.html#Ext.grid.RowSelectionModel-rowdeselect" ext:member="rowdeselect" ext:cls="Ext.grid.RowSelectionModel">rowdeselect</a> and <a href="output/Ext.grid.RowSelectionModel.html#Ext.grid.RowSelectionModel-selectionchange" ext:member="selectionchange" ext:cls="Ext.grid.RowSelectionModel">selectionchange</a> events.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>row</code> : Number<div class="sub-desc">The index of the row to deselect</div></li><li><code>preventViewNotify</code> : Boolean<div class="sub-desc">(optional) Specify <tt>true</tt> to
+prevent notifying the view (disables updating the selected appearance)</div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.grid.RowSelectionModel.html#deselectRow" ext:member="#deselectRow" ext:cls="Ext.grid.RowSelectionModel">RowSelectionModel</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.grid.RowSelectionModel-each"></a><b><a href="source/RowSelectionModel.html#method-Ext.grid.RowSelectionModel-each">each</a></b>( <code>Function fn</code>, <span title="Optional" class="optional">[<code>Object scope</code>]</span> )\r
+ :\r
+ Boolean<div class="mdesc"><div class="short">Calls the passed function with each selection. If the function returns\r
+false, iteration is stopped and this function ...</div><div class="long">Calls the passed function with each selection. If the function returns
+<tt>false</tt>, iteration is stopped and this function returns
+<tt>false</tt>. Otherwise it returns <tt>true</tt>.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>fn</code> : Function<div class="sub-desc"></div></li><li><code>scope</code> : Object<div class="sub-desc">(optional)</div></li></ul><strong>Returns:</strong><ul><li><code>Boolean</code><div class="sub-desc">true if all selections were iterated</div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.grid.RowSelectionModel.html#each" ext:member="#each" ext:cls="Ext.grid.RowSelectionModel">RowSelectionModel</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.util.Observable-enableBubble"></a><b><a href="source/Observable-more.html#method-Ext.util.Observable-enableBubble">enableBubble</a></b>( <code>Object events</code> )\r
+ :\r
+ void<div class="mdesc"><div class="short">Enables events fired by this Observable to bubble up an owner hierarchy by calling \r
+this.getBubbleTarget() if present...</div><div class="long"><p>Enables events fired by this Observable to bubble up an owner hierarchy by calling\r
+<code>this.getBubbleTarget()</code> if present. There is no implementation in the Observable base class.</p>\r
+<p>This is commonly used by Ext.Components to bubble events to owner Containers. See <a href="output/Ext.Component.getBubbleTarget.html" ext:cls="Ext.Component.getBubbleTarget">Ext.Component.getBubbleTarget</a>. The default\r
+implementation in Ext.Component returns the Component's immediate owner. But if a known target is required, this can be overridden to\r
+access the required target more quickly.</p>\r
+<p>Example:</p><pre><code>Ext.override(Ext.form.Field, {\r
+<i>// Add functionality to Field<em>'s initComponent to enable the change event to bubble\r</i>
+ initComponent: Ext.form.Field.prototype.initComponent.createSequence(<b>function</b>() {\r
+ this.enableBubble('</em>change<em>');\r
+ }),\r
+\r
+<i>// We know that we want Field'</em>s events to bubble directly to the FormPanel.\r</i>
+ getBubbleTarget: <b>function</b>() {\r
+ <b>if</b> (!this.formPanel) {\r
+ this.formPanel = this.findParentByType(<em>'form'</em>);\r
+ }\r
+ <b>return</b> this.formPanel;\r
+ }\r
+});\r
+\r
+<b>var</b> myForm = <b>new</b> Ext.formPanel({\r
+ title: <em>'User Details'</em>,\r
+ items: [{\r
+ ...\r
+ }],\r
+ listeners: {\r
+ change: <b>function</b>() {\r
+<i>// Title goes red <b>if</b> form has been modified.\r</i>
+ myForm.header.setStyle(<em>"color"</em>, <em>"red"</em>);\r
+ }\r
+ }\r
+});</code></pre><div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>events</code> : Object<div class="sub-desc">The event name to bubble, or an Array of event names.</div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.util.Observable.html#enableBubble" ext:member="#enableBubble" ext:cls="Ext.util.Observable">Observable</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.util.Observable-fireEvent"></a><b><a href="source/Observable.html#method-Ext.util.Observable-fireEvent">fireEvent</a></b>( <code>String eventName</code>, <code>Object... args</code> )\r
+ :\r
+ Boolean<div class="mdesc"><div class="short">Fires the specified event with the passed parameters (minus the event name).\r
+An event may be set to bubble up an Obse...</div><div class="long"><p>Fires the specified event with the passed parameters (minus the event name).</p>
+<p>An event may be set to bubble up an Observable parent hierarchy (See <a href="output/Ext.Component.html#Ext.Component-getBubbleTarget" ext:member="getBubbleTarget" ext:cls="Ext.Component">Ext.Component.getBubbleTarget</a>)
+by calling <a href="output/Ext.util.Observable.html#Ext.util.Observable-enableBubble" ext:member="enableBubble" ext:cls="Ext.util.Observable">enableBubble</a>.</p><div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>eventName</code> : String<div class="sub-desc">The name of the event to fire.</div></li><li><code>args</code> : Object...<div class="sub-desc">Variable number of parameters are passed to handlers.</div></li></ul><strong>Returns:</strong><ul><li><code>Boolean</code><div class="sub-desc">returns false if any of the handlers return false otherwise it returns true.</div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.util.Observable.html#fireEvent" ext:member="#fireEvent" ext:cls="Ext.util.Observable">Observable</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.grid.RowSelectionModel-getCount"></a><b><a href="source/RowSelectionModel.html#method-Ext.grid.RowSelectionModel-getCount">getCount</a></b>()\r
+ :\r
+ Number<div class="mdesc"><div class="short">Gets the number of selected rows.</div><div class="long">Gets the number of selected rows.<div class="mdetail-params"><strong>Parameters:</strong><ul><li>None.</li></ul><strong>Returns:</strong><ul><li><code>Number</code><div class="sub-desc"></div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.grid.RowSelectionModel.html#getCount" ext:member="#getCount" ext:cls="Ext.grid.RowSelectionModel">RowSelectionModel</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.grid.RowSelectionModel-getSelected"></a><b><a href="source/RowSelectionModel.html#method-Ext.grid.RowSelectionModel-getSelected">getSelected</a></b>()\r
+ :\r
+ Record<div class="mdesc"><div class="short">Returns the first selected record.</div><div class="long">Returns the first selected record.<div class="mdetail-params"><strong>Parameters:</strong><ul><li>None.</li></ul><strong>Returns:</strong><ul><li><code>Record</code><div class="sub-desc"></div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.grid.RowSelectionModel.html#getSelected" ext:member="#getSelected" ext:cls="Ext.grid.RowSelectionModel">RowSelectionModel</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.grid.RowSelectionModel-getSelections"></a><b><a href="source/RowSelectionModel.html#method-Ext.grid.RowSelectionModel-getSelections">getSelections</a></b>()\r
+ :\r
+ Array<div class="mdesc"><div class="short">Returns the selected records</div><div class="long">Returns the selected records<div class="mdetail-params"><strong>Parameters:</strong><ul><li>None.</li></ul><strong>Returns:</strong><ul><li><code>Array</code><div class="sub-desc">Array of selected records</div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.grid.RowSelectionModel.html#getSelections" ext:member="#getSelections" ext:cls="Ext.grid.RowSelectionModel">RowSelectionModel</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.util.Observable-hasListener"></a><b><a href="source/Observable.html#method-Ext.util.Observable-hasListener">hasListener</a></b>( <code>String eventName</code> )\r
+ :\r
+ Boolean<div class="mdesc"><div class="short">Checks to see if this object has any listeners for a specified event</div><div class="long">Checks to see if this object has any listeners for a specified event<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>eventName</code> : String<div class="sub-desc">The name of the event to check for</div></li></ul><strong>Returns:</strong><ul><li><code>Boolean</code><div class="sub-desc">True if the event is being listened for, else false</div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.util.Observable.html#hasListener" ext:member="#hasListener" ext:cls="Ext.util.Observable">Observable</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.grid.RowSelectionModel-hasNext"></a><b><a href="source/RowSelectionModel.html#method-Ext.grid.RowSelectionModel-hasNext">hasNext</a></b>()\r
+ :\r
+ Boolean<div class="mdesc"><div class="short">Returns true if there is a next record to select</div><div class="long">Returns true if there is a next record to select<div class="mdetail-params"><strong>Parameters:</strong><ul><li>None.</li></ul><strong>Returns:</strong><ul><li><code>Boolean</code><div class="sub-desc"></div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.grid.RowSelectionModel.html#hasNext" ext:member="#hasNext" ext:cls="Ext.grid.RowSelectionModel">RowSelectionModel</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.grid.RowSelectionModel-hasPrevious"></a><b><a href="source/RowSelectionModel.html#method-Ext.grid.RowSelectionModel-hasPrevious">hasPrevious</a></b>()\r
+ :\r
+ Boolean<div class="mdesc"><div class="short">Returns true if there is a previous record to select</div><div class="long">Returns true if there is a previous record to select<div class="mdetail-params"><strong>Parameters:</strong><ul><li>None.</li></ul><strong>Returns:</strong><ul><li><code>Boolean</code><div class="sub-desc"></div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.grid.RowSelectionModel.html#hasPrevious" ext:member="#hasPrevious" ext:cls="Ext.grid.RowSelectionModel">RowSelectionModel</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.grid.RowSelectionModel-hasSelection"></a><b><a href="source/RowSelectionModel.html#method-Ext.grid.RowSelectionModel-hasSelection">hasSelection</a></b>()\r
+ :\r
+ Boolean<div class="mdesc"><div class="short">Returns true if there is a selection.</div><div class="long">Returns <tt>true</tt> if there is a selection.<div class="mdetail-params"><strong>Parameters:</strong><ul><li>None.</li></ul><strong>Returns:</strong><ul><li><code>Boolean</code><div class="sub-desc"></div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.grid.RowSelectionModel.html#hasSelection" ext:member="#hasSelection" ext:cls="Ext.grid.RowSelectionModel">RowSelectionModel</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.grid.RowSelectionModel-isIdSelected"></a><b><a href="source/RowSelectionModel.html#method-Ext.grid.RowSelectionModel-isIdSelected">isIdSelected</a></b>( <code>String id</code> )\r
+ :\r
+ Boolean<div class="mdesc"><div class="short">Returns true if the specified record id is selected.</div><div class="long">Returns <tt>true</tt> if the specified record id is selected.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>id</code> : String<div class="sub-desc">The id of record to check</div></li></ul><strong>Returns:</strong><ul><li><code>Boolean</code><div class="sub-desc"></div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.grid.RowSelectionModel.html#isIdSelected" ext:member="#isIdSelected" ext:cls="Ext.grid.RowSelectionModel">RowSelectionModel</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.grid.AbstractSelectionModel-isLocked"></a><b><a href="source/AbstractSelectionModel.html#method-Ext.grid.AbstractSelectionModel-isLocked">isLocked</a></b>()\r
+ :\r
+ Boolean<div class="mdesc"><div class="short">Returns true if the selections are locked.</div><div class="long">Returns true if the selections are locked.<div class="mdetail-params"><strong>Parameters:</strong><ul><li>None.</li></ul><strong>Returns:</strong><ul><li><code>Boolean</code><div class="sub-desc"></div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.grid.AbstractSelectionModel.html#isLocked" ext:member="#isLocked" ext:cls="Ext.grid.AbstractSelectionModel">AbstractSelectionModel</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.grid.RowSelectionModel-isSelected"></a><b><a href="source/RowSelectionModel.html#method-Ext.grid.RowSelectionModel-isSelected">isSelected</a></b>( <code>Number/Record index</code> )\r
+ :\r
+ Boolean<div class="mdesc"><div class="short">Returns true if the specified row is selected.</div><div class="long">Returns <tt>true</tt> if the specified row is selected.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>index</code> : Number/Record<div class="sub-desc">The record or index of the record to check</div></li></ul><strong>Returns:</strong><ul><li><code>Boolean</code><div class="sub-desc"></div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.grid.RowSelectionModel.html#isSelected" ext:member="#isSelected" ext:cls="Ext.grid.RowSelectionModel">RowSelectionModel</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.grid.AbstractSelectionModel-lock"></a><b><a href="source/AbstractSelectionModel.html#method-Ext.grid.AbstractSelectionModel-lock">lock</a></b>()\r
+ :\r
+ void<div class="mdesc"><div class="short">Locks the selections.</div><div class="long">Locks the selections.<div class="mdetail-params"><strong>Parameters:</strong><ul><li>None.</li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.grid.AbstractSelectionModel.html#lock" ext:member="#lock" ext:cls="Ext.grid.AbstractSelectionModel">AbstractSelectionModel</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.util.Observable-on"></a><b><a href="source/Observable.html#method-Ext.util.Observable-on">on</a></b>( <code>String eventName</code>, <code>Function handler</code>, <span title="Optional" class="optional">[<code>Object scope</code>]</span>, <span title="Optional" class="optional">[<code>Object options</code>]</span> )\r
+ :\r
+ void<div class="mdesc"><div class="short">Appends an event handler to this object (shorthand for addListener.)</div><div class="long">Appends an event handler to this object (shorthand for <a href="output/Ext.util.Observable.html#Ext.util.Observable-addListener" ext:member="addListener" ext:cls="Ext.util.Observable">addListener</a>.)<div class="mdetail-params"><strong>Parameters:</strong><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 (<code><b>this</b></code> reference) in which the handler function is executed.
+<b>If omitted, defaults to the object which fired the event.</b></div></li><li><code>options</code> : Object<div class="sub-desc">(optional) An object containing handler configuration.</div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.util.Observable.html#on" ext:member="#on" ext:cls="Ext.util.Observable">Observable</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.util.Observable-purgeListeners"></a><b><a href="source/Observable.html#method-Ext.util.Observable-purgeListeners">purgeListeners</a></b>()\r
+ :\r
+ void<div class="mdesc"><div class="short">Removes all listeners for this object</div><div class="long">Removes all listeners for this object<div class="mdetail-params"><strong>Parameters:</strong><ul><li>None.</li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.util.Observable.html#purgeListeners" ext:member="#purgeListeners" ext:cls="Ext.util.Observable">Observable</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.util.Observable-relayEvents"></a><b><a href="source/Observable-more.html#method-Ext.util.Observable-relayEvents">relayEvents</a></b>( <code>Object o</code>, <code>Array events</code> )\r
+ :\r
+ void<div class="mdesc"><div class="short">Relays selected events from the specified Observable as if the events were fired by this.</div><div class="long">Relays selected events from the specified Observable as if the events were fired by <tt><b>this</b></tt>.<div class="mdetail-params"><strong>Parameters:</strong><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><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.util.Observable.html#relayEvents" ext:member="#relayEvents" ext:cls="Ext.util.Observable">Observable</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.util.Observable-removeListener"></a><b><a href="source/Observable.html#method-Ext.util.Observable-removeListener">removeListener</a></b>( <code>String eventName</code>, <code>Function handler</code>, <span title="Optional" class="optional">[<code>Object scope</code>]</span> )\r
+ :\r
+ void<div class="mdesc"><div class="short">Removes an event handler.</div><div class="long">Removes an event handler.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>eventName</code> : String<div class="sub-desc">The type of event the handler was associated with.</div></li><li><code>handler</code> : Function<div class="sub-desc">The handler to remove. <b>This must be a reference to the function passed into the <a href="output/Ext.util.Observable.html#Ext.util.Observable-addListener" ext:member="addListener" ext:cls="Ext.util.Observable">addListener</a> call.</b></div></li><li><code>scope</code> : Object<div class="sub-desc">(optional) The scope originally specified for the handler.</div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.util.Observable.html#removeListener" ext:member="#removeListener" ext:cls="Ext.util.Observable">Observable</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.util.Observable-resumeEvents"></a><b><a href="source/Observable.html#method-Ext.util.Observable-resumeEvents">resumeEvents</a></b>()\r
+ :\r
+ void<div class="mdesc"><div class="short">Resume firing events. (see suspendEvents)\r
+If events were suspended using the queueSuspended parameter, then all\r
+event...</div><div class="long">Resume firing events. (see <a href="output/Ext.util.Observable.html#Ext.util.Observable-suspendEvents" ext:member="suspendEvents" ext:cls="Ext.util.Observable">suspendEvents</a>)
+If events were suspended using the <tt><b>queueSuspended</b></tt> parameter, then all
+events fired during event suspension will be sent to any listeners now.<div class="mdetail-params"><strong>Parameters:</strong><ul><li>None.</li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.util.Observable.html#resumeEvents" ext:member="#resumeEvents" ext:cls="Ext.util.Observable">Observable</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.grid.RowSelectionModel-selectAll"></a><b><a href="source/RowSelectionModel.html#method-Ext.grid.RowSelectionModel-selectAll">selectAll</a></b>()\r
+ :\r
+ void<div class="mdesc"><div class="short">Selects all rows if the selection model\r
+is not locked.</div><div class="long">Selects all rows if the selection model
+<a href="output/Ext.grid.AbstractSelectionModel.html#Ext.grid.AbstractSelectionModel-isLocked" ext:member="isLocked" ext:cls="Ext.grid.AbstractSelectionModel">is not locked</a>.<div class="mdetail-params"><strong>Parameters:</strong><ul><li>None.</li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.grid.RowSelectionModel.html#selectAll" ext:member="#selectAll" ext:cls="Ext.grid.RowSelectionModel">RowSelectionModel</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.grid.RowSelectionModel-selectFirstRow"></a><b><a href="source/RowSelectionModel.html#method-Ext.grid.RowSelectionModel-selectFirstRow">selectFirstRow</a></b>()\r
+ :\r
+ void<div class="mdesc"><div class="short">Selects the first row in the grid.</div><div class="long">Selects the first row in the grid.<div class="mdetail-params"><strong>Parameters:</strong><ul><li>None.</li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.grid.RowSelectionModel.html#selectFirstRow" ext:member="#selectFirstRow" ext:cls="Ext.grid.RowSelectionModel">RowSelectionModel</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.grid.RowSelectionModel-selectLastRow"></a><b><a href="source/RowSelectionModel.html#method-Ext.grid.RowSelectionModel-selectLastRow">selectLastRow</a></b>( <span title="Optional" class="optional">[<code>Boolean keepExisting</code>]</span> )\r
+ :\r
+ void<div class="mdesc"><div class="short">Select the last row.</div><div class="long">Select the last row.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>keepExisting</code> : Boolean<div class="sub-desc">(optional) <tt>true</tt> to keep existing selections</div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.grid.RowSelectionModel.html#selectLastRow" ext:member="#selectLastRow" ext:cls="Ext.grid.RowSelectionModel">RowSelectionModel</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.grid.RowSelectionModel-selectNext"></a><b><a href="source/RowSelectionModel.html#method-Ext.grid.RowSelectionModel-selectNext">selectNext</a></b>( <span title="Optional" class="optional">[<code>Boolean keepExisting</code>]</span> )\r
+ :\r
+ Boolean<div class="mdesc"><div class="short">Selects the row immediately following the last selected row.</div><div class="long">Selects the row immediately following the last selected row.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>keepExisting</code> : Boolean<div class="sub-desc">(optional) <tt>true</tt> to keep existing selections</div></li></ul><strong>Returns:</strong><ul><li><code>Boolean</code><div class="sub-desc"><tt>true</tt> if there is a next row, else <tt>false</tt></div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.grid.RowSelectionModel.html#selectNext" ext:member="#selectNext" ext:cls="Ext.grid.RowSelectionModel">RowSelectionModel</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.grid.RowSelectionModel-selectPrevious"></a><b><a href="source/RowSelectionModel.html#method-Ext.grid.RowSelectionModel-selectPrevious">selectPrevious</a></b>( <span title="Optional" class="optional">[<code>Boolean keepExisting</code>]</span> )\r
+ :\r
+ Boolean<div class="mdesc"><div class="short">Selects the row that precedes the last selected row.</div><div class="long">Selects the row that precedes the last selected row.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>keepExisting</code> : Boolean<div class="sub-desc">(optional) <tt>true</tt> to keep existing selections</div></li></ul><strong>Returns:</strong><ul><li><code>Boolean</code><div class="sub-desc"><tt>true</tt> if there is a previous row, else <tt>false</tt></div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.grid.RowSelectionModel.html#selectPrevious" ext:member="#selectPrevious" ext:cls="Ext.grid.RowSelectionModel">RowSelectionModel</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.grid.RowSelectionModel-selectRange"></a><b><a href="source/RowSelectionModel.html#method-Ext.grid.RowSelectionModel-selectRange">selectRange</a></b>( <code>Number startRow</code>, <code>Number endRow</code>, <span title="Optional" class="optional">[<code>Boolean keepExisting</code>]</span> )\r
+ :\r
+ void<div class="mdesc"><div class="short">Selects a range of rows if the selection model\r
+is not locked.\r
+All rows in between startRow and endRow are also select...</div><div class="long">Selects a range of rows if the selection model
+<a href="output/Ext.grid.AbstractSelectionModel.html#Ext.grid.AbstractSelectionModel-isLocked" ext:member="isLocked" ext:cls="Ext.grid.AbstractSelectionModel">is not locked</a>.
+All rows in between startRow and endRow are also selected.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>startRow</code> : Number<div class="sub-desc">The index of the first row in the range</div></li><li><code>endRow</code> : Number<div class="sub-desc">The index of the last row in the range</div></li><li><code>keepExisting</code> : Boolean<div class="sub-desc">(optional) True to retain existing selections</div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.grid.RowSelectionModel.html#selectRange" ext:member="#selectRange" ext:cls="Ext.grid.RowSelectionModel">RowSelectionModel</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.grid.RowSelectionModel-selectRecords"></a><b><a href="source/RowSelectionModel.html#method-Ext.grid.RowSelectionModel-selectRecords">selectRecords</a></b>( <code>Array records</code>, <span title="Optional" class="optional">[<code>Boolean keepExisting</code>]</span> )\r
+ :\r
+ void<div class="mdesc"><div class="short">Select records.</div><div class="long">Select records.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>records</code> : Array<div class="sub-desc">The records to select</div></li><li><code>keepExisting</code> : Boolean<div class="sub-desc">(optional) <tt>true</tt> to keep existing selections</div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.grid.RowSelectionModel.html#selectRecords" ext:member="#selectRecords" ext:cls="Ext.grid.RowSelectionModel">RowSelectionModel</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.grid.RowSelectionModel-selectRow"></a><b><a href="source/RowSelectionModel.html#method-Ext.grid.RowSelectionModel-selectRow">selectRow</a></b>( <code>Number row</code>, <span title="Optional" class="optional">[<code>Boolean keepExisting</code>]</span>, <span title="Optional" class="optional">[<code>Boolean preventViewNotify</code>]</span> )\r
+ :\r
+ void<div class="mdesc"><div class="short">Selects a row. Before selecting a row, checks if the selection model\r
+is locked and fires the\r
+beforerowselect event. ...</div><div class="long">Selects a row. Before selecting a row, checks if the selection model
+<a href="output/Ext.grid.AbstractSelectionModel.html#Ext.grid.AbstractSelectionModel-isLocked" ext:member="isLocked" ext:cls="Ext.grid.AbstractSelectionModel">is locked</a> and fires the
+<a href="output/Ext.grid.RowSelectionModel.html#Ext.grid.RowSelectionModel-beforerowselect" ext:member="beforerowselect" ext:cls="Ext.grid.RowSelectionModel">beforerowselect</a> event. If these checks are satisfied the row
+will be selected and followed up by firing the <a href="output/Ext.grid.RowSelectionModel.html#Ext.grid.RowSelectionModel-rowselect" ext:member="rowselect" ext:cls="Ext.grid.RowSelectionModel">rowselect</a> and
+<a href="output/Ext.grid.RowSelectionModel.html#Ext.grid.RowSelectionModel-selectionchange" ext:member="selectionchange" ext:cls="Ext.grid.RowSelectionModel">selectionchange</a> events.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>row</code> : Number<div class="sub-desc">The index of the row to select</div></li><li><code>keepExisting</code> : Boolean<div class="sub-desc">(optional) <tt>true</tt> to keep existing selections</div></li><li><code>preventViewNotify</code> : Boolean<div class="sub-desc">(optional) Specify <tt>true</tt> to
+prevent notifying the view (disables updating the selected appearance)</div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.grid.RowSelectionModel.html#selectRow" ext:member="#selectRow" ext:cls="Ext.grid.RowSelectionModel">RowSelectionModel</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.grid.RowSelectionModel-selectRows"></a><b><a href="source/RowSelectionModel.html#method-Ext.grid.RowSelectionModel-selectRows">selectRows</a></b>( <code>Array rows</code>, <span title="Optional" class="optional">[<code>Boolean keepExisting</code>]</span> )\r
+ :\r
+ void<div class="mdesc"><div class="short">Selects multiple rows.</div><div class="long">Selects multiple rows.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>rows</code> : Array<div class="sub-desc">Array of the indexes of the row to select</div></li><li><code>keepExisting</code> : Boolean<div class="sub-desc">(optional) <tt>true</tt> to keep
+existing selections (defaults to <tt>false</tt>)</div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.grid.RowSelectionModel.html#selectRows" ext:member="#selectRows" ext:cls="Ext.grid.RowSelectionModel">RowSelectionModel</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.util.Observable-suspendEvents"></a><b><a href="source/Observable.html#method-Ext.util.Observable-suspendEvents">suspendEvents</a></b>( <code>Boolean queueSuspended</code> )\r
+ :\r
+ void<div class="mdesc"><div class="short">Suspend the firing of all events. (see resumeEvents)</div><div class="long">Suspend the firing of all events. (see <a href="output/Ext.util.Observable.html#Ext.util.Observable-resumeEvents" ext:member="resumeEvents" ext:cls="Ext.util.Observable">resumeEvents</a>)<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>queueSuspended</code> : Boolean<div class="sub-desc">Pass as true to queue up suspended events to be fired
+after the <a href="output/Ext.util.Observable.html#Ext.util.Observable-resumeEvents" ext:member="resumeEvents" ext:cls="Ext.util.Observable">resumeEvents</a> call instead of discarding all suspended events;</div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.util.Observable.html#suspendEvents" ext:member="#suspendEvents" ext:cls="Ext.util.Observable">Observable</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.util.Observable-un"></a><b><a href="source/Observable.html#method-Ext.util.Observable-un">un</a></b>( <code>String eventName</code>, <code>Function handler</code>, <span title="Optional" class="optional">[<code>Object scope</code>]</span> )\r
+ :\r
+ void<div class="mdesc"><div class="short">Removes an event handler (shorthand for removeListener.)</div><div class="long">Removes an event handler (shorthand for <a href="output/Ext.util.Observable.html#Ext.util.Observable-removeListener" ext:member="removeListener" ext:cls="Ext.util.Observable">removeListener</a>.)<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>eventName</code> : String<div class="sub-desc">The type of event the handler was associated with.</div></li><li><code>handler</code> : Function<div class="sub-desc">The handler to remove. <b>This must be a reference to the function passed into the <a href="output/Ext.util.Observable.html#Ext.util.Observable-addListener" ext:member="addListener" ext:cls="Ext.util.Observable">addListener</a> call.</b></div></li><li><code>scope</code> : Object<div class="sub-desc">(optional) The scope originally specified for the handler.</div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.util.Observable.html#un" ext:member="#un" ext:cls="Ext.util.Observable">Observable</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.grid.AbstractSelectionModel-unlock"></a><b><a href="source/AbstractSelectionModel.html#method-Ext.grid.AbstractSelectionModel-unlock">unlock</a></b>()\r
+ :\r
+ void<div class="mdesc"><div class="short">Unlocks the selections.</div><div class="long">Unlocks the selections.<div class="mdetail-params"><strong>Parameters:</strong><ul><li>None.</li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.grid.AbstractSelectionModel.html#unlock" ext:member="#unlock" ext:cls="Ext.grid.AbstractSelectionModel">AbstractSelectionModel</a></td></tr></tbody></table><a id="Ext.grid.CheckboxSelectionModel-events"></a><h2>Public Events</h2><table cellspacing="0" class="member-table"><tbody><tr><th colspan="2" class="sig-header">Event</th><th class="msource-header">Defined By</th></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.grid.RowSelectionModel-beforerowselect"></a><b><a href="source/RowSelectionModel.html#event-Ext.grid.RowSelectionModel-beforerowselect">beforerowselect</a></b> :\r
+ ( <code>SelectionModel this</code>, <code>Number rowIndex</code>, <code>Boolean keepExisting</code>, <code>Record record</code> )\r
+ <div class="mdesc"><div class="short">Fires before a row is selected, return false to cancel the selection.</div><div class="long">Fires before a row is selected, return false to cancel the selection.<div class="mdetail-params"><strong style="font-weight: normal;">Listeners will be called with the following arguments:</strong><ul><li><code>this</code> : SelectionModel<div class="sub-desc"></div></li><li><code>rowIndex</code> : Number<div class="sub-desc">The index to be selected</div></li><li><code>keepExisting</code> : Boolean<div class="sub-desc">False if other selections will be cleared</div></li><li><code>record</code> : Record<div class="sub-desc">The record to be selected</div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.grid.RowSelectionModel.html#beforerowselect" ext:member="#beforerowselect" ext:cls="Ext.grid.RowSelectionModel">RowSelectionModel</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.grid.RowSelectionModel-rowdeselect"></a><b><a href="source/RowSelectionModel.html#event-Ext.grid.RowSelectionModel-rowdeselect">rowdeselect</a></b> :\r
+ ( <code>SelectionModel this</code>, <code>Number rowIndex</code>, <code>Record record</code> )\r
+ <div class="mdesc"><div class="short">Fires when a row is deselected. To prevent deselection\r
+lock the selections.</div><div class="long">Fires when a row is deselected. To prevent deselection
+<a href="output/Ext.grid.AbstractSelectionModel.html#Ext.grid.AbstractSelectionModel-lock" ext:member="lock" ext:cls="Ext.grid.AbstractSelectionModel">lock the selections</a>.<div class="mdetail-params"><strong style="font-weight: normal;">Listeners will be called with the following arguments:</strong><ul><li><code>this</code> : SelectionModel<div class="sub-desc"></div></li><li><code>rowIndex</code> : Number<div class="sub-desc"></div></li><li><code>record</code> : Record<div class="sub-desc"></div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.grid.RowSelectionModel.html#rowdeselect" ext:member="#rowdeselect" ext:cls="Ext.grid.RowSelectionModel">RowSelectionModel</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.grid.RowSelectionModel-rowselect"></a><b><a href="source/RowSelectionModel.html#event-Ext.grid.RowSelectionModel-rowselect">rowselect</a></b> :\r
+ ( <code>SelectionModel this</code>, <code>Number rowIndex</code>, <code>Ext.data.Record r</code> )\r
+ <div class="mdesc"><div class="short">Fires when a row is selected.</div><div class="long">Fires when a row is selected.<div class="mdetail-params"><strong style="font-weight: normal;">Listeners will be called with the following arguments:</strong><ul><li><code>this</code> : SelectionModel<div class="sub-desc"></div></li><li><code>rowIndex</code> : Number<div class="sub-desc">The selected index</div></li><li><code>r</code> : Ext.data.Record<div class="sub-desc">The selected record</div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.grid.RowSelectionModel.html#rowselect" ext:member="#rowselect" ext:cls="Ext.grid.RowSelectionModel">RowSelectionModel</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.grid.RowSelectionModel-selectionchange"></a><b><a href="source/RowSelectionModel.html#event-Ext.grid.RowSelectionModel-selectionchange">selectionchange</a></b> :\r
+ ( <code>SelectionModel this</code> )\r
+ <div class="mdesc"><div class="short">Fires when the selection changes</div><div class="long">Fires when the selection changes<div class="mdetail-params"><strong style="font-weight: normal;">Listeners will be called with the following arguments:</strong><ul><li><code>this</code> : SelectionModel<div class="sub-desc"></div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.grid.RowSelectionModel.html#selectionchange" ext:member="#selectionchange" ext:cls="Ext.grid.RowSelectionModel">RowSelectionModel</a></td></tr></tbody></table></div>
\ No newline at end of file
git.ithinksw.org / extjs.git / blobdiff