Go to most recent revision | Blame | Last modification | View Log | RSS feed
<div class="body-wrap">
<div class="top-tools">
<a class="inner-link" href="#Ext.grid.RowSelectionModel-props"><img src="../resources/images/default/s.gif" class="item-icon icon-prop">Properties</a>
<a class="inner-link" href="#Ext.grid.RowSelectionModel-methods"><img src="../resources/images/default/s.gif" class="item-icon icon-method">Methods</a>
<a class="inner-link" href="#Ext.grid.RowSelectionModel-events"><img src="../resources/images/default/s.gif" class="item-icon icon-event">Events</a>
<a class="inner-link" href="#Ext.grid.RowSelectionModel-configs"><img src="../resources/images/default/s.gif" class="item-icon icon-config">Config Options</a>
<a class="bookmark" href="../docs/?class=Ext.grid.RowSelectionModel"><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"/>RowSelectionModel</pre></div>
<h1>Class Ext.grid.RowSelectionModel</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="../source/widgets/grid/RowSelectionModel.js" target="_blank">RowSelectionModel.js</a></td></tr>
<tr><td class="label">Class:</td><td class="hd-info">RowSelectionModel</td></tr>
<tr><td class="label">Subclasses:</td><td class="hd-info"><a ext:cls="Ext.grid.CheckboxSelectionModel" href="output/Ext.grid.CheckboxSelectionModel.html">CheckboxSelectionModel</a></td></tr>
<tr><td class="label">Extends:</td><td class="hd-info"><a ext:cls="Ext.grid.AbstractSelectionModel" ext:member="" href="output/Ext.grid.AbstractSelectionModel.html">AbstractSelectionModel</a></td></tr>
</table>
<div class="description">
The default SelectionModel used by <a ext:cls="Ext.grid.GridPanel" href="output/Ext.grid.GridPanel.html">Ext.grid.GridPanel</a>.
It supports multiple selections and keyboard selection/navigation. The objects stored
as selections and returned by <a ext:cls="Ext.grid.RowSelectionModel" ext:member="getSelected" href="output/Ext.grid.RowSelectionModel.html#getSelected">getSelected</a>, and <a ext:cls="Ext.grid.RowSelectionModel" ext:member="getSelections" href="output/Ext.grid.RowSelectionModel.html#getSelections">getSelections</a> are
the <a ext:cls="Ext.data.Record" href="output/Ext.data.Record.html">Record</a>s which provide the data for the selected rows. </div>
<div class="hr"></div>
<a id="Ext.grid.RowSelectionModel-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 inherited expandable">
<td class="micon"><a class="exi" href="#expand"> </a></td>
<td class="sig">
<a id="Ext.grid.RowSelectionModel-listeners"></a>
<b>listeners</b> : Object <div class="mdesc">
<div class="short">A config object containing one or more event handlers to be added to this object during initialization. This should b...</div>
<div class="long">
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>
</div>
</td>
<td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#listeners" href="output/Ext.util.Observable.html#listeners">Observable</a></td>
</tr>
<tr class="config-row alt">
<td class="micon"><a class="exi" href="#expand"> </a></td>
<td class="sig">
<a id="Ext.grid.RowSelectionModel-moveEditorOnEnter"></a>
<b>moveEditorOnEnter</b> : Boolean <div class="mdesc">
False to turn off moving the editor to the next cell when the enter key is pressed </div>
</td>
<td class="msource">RowSelectionModel</td>
</tr>
<tr class="config-row">
<td class="micon"><a class="exi" href="#expand"> </a></td>
<td class="sig">
<a id="Ext.grid.RowSelectionModel-singleSelect"></a>
<b>singleSelect</b> : Boolean <div class="mdesc">
True to allow selection of only one row at a time (defaults to false) </div>
</td>
<td class="msource">RowSelectionModel</td>
</tr>
</table>
<a id="Ext.grid.RowSelectionModel-props"></a>
<h2>Public Properties</h2>
<div class="no-members">This class has no public properties.</div> <a id="Ext.grid.RowSelectionModel-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">
<td class="micon"><a class="exi" href="#expand"> </a></td>
<td class="sig">
<a id="Ext.grid.RowSelectionModel-RowSelectionModel"></a>
<b>RowSelectionModel</b>( <code>Object config</code> ) <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"></div></li> </ul>
<strong>Returns:</strong>
<ul>
<li><code></code></li>
</ul>
</div>
</div>
</div>
</td>
<td class="msource">RowSelectionModel</td>
</tr>
<tr class="method-row inherited alt expandable">
<td class="micon"><a class="exi" href="#expand"> </a></td>
<td class="sig">
<a id="Ext.grid.RowSelectionModel-addEvents"></a>
<b>addEvents</b>( <code>Object object</code> ) : void <div class="mdesc">
<div class="short">Used to define events on this Observable</div>
<div class="long">
Used to define events on this Observable <div class="mdetail-params">
<strong>Parameters:</strong>
<ul><li><code>object</code> : Object<div class="sub-desc">The object with the events defined</div></li> </ul>
<strong>Returns:</strong>
<ul>
<li><code>void</code></li>
</ul>
</div>
</div>
</div>
</td>
<td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#addEvents" href="output/Ext.util.Observable.html#addEvents">Observable</a></td>
</tr>
<tr class="method-row inherited expandable">
<td class="micon"><a class="exi" href="#expand"> </a></td>
<td class="sig">
<a id="Ext.grid.RowSelectionModel-addListener"></a>
<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">
<div class="short">Appends an event handler to this component</div>
<div class="long">
Appends an event handler to this component <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 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
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
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>
</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
});</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>
}
});</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>
<strong>Returns:</strong>
<ul>
<li><code>void</code></li>
</ul>
</div>
</div>
</div>
</td>
<td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#addListener" href="output/Ext.util.Observable.html#addListener">Observable</a></td>
</tr>
<tr class="method-row alt expandable">
<td class="micon"><a class="exi" href="#expand"> </a></td>
<td class="sig">
<a id="Ext.grid.RowSelectionModel-clearSelections"></a>
<b>clearSelections</b>() : void <div class="mdesc">
<div class="short">Clears all selections.</div>
<div class="long">
Clears all selections. <div class="mdetail-params">
<strong>Parameters:</strong>
<ul><li>None.</li> </ul>
<strong>Returns:</strong>
<ul>
<li><code>void</code></li>
</ul>
</div>
</div>
</div>
</td>
<td class="msource">RowSelectionModel</td>
</tr>
<tr class="method-row expandable">
<td class="micon"><a class="exi" href="#expand"> </a></td>
<td class="sig">
<a id="Ext.grid.RowSelectionModel-deselectRange"></a>
<b>deselectRange</b>( <code>Number startRow</code>, <code>Number endRow</code> ) : void <div class="mdesc">
<div class="short">Deselects a range of rows. All rows in between startRow and endRow are also deselected.</div>
<div class="long">
Deselects a range of rows. 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><code>void</code></li>
</ul>
</div>
</div>
</div>
</td>
<td class="msource">RowSelectionModel</td>
</tr>
<tr class="method-row alt expandable">
<td class="micon"><a class="exi" href="#expand"> </a></td>
<td class="sig">
<a id="Ext.grid.RowSelectionModel-deselectRow"></a>
<b>deselectRow</b>( <code>Number row</code> ) : void <div class="mdesc">
<div class="short">Deselects a row.</div>
<div class="long">
Deselects a row. <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> </ul>
<strong>Returns:</strong>
<ul>
<li><code>void</code></li>
</ul>
</div>
</div>
</div>
</td>
<td class="msource">RowSelectionModel</td>
</tr>
<tr class="method-row expandable">
<td class="micon"><a class="exi" href="#expand"> </a></td>
<td class="sig">
<a id="Ext.grid.RowSelectionModel-each"></a>
<b>each</b>( <code>Function fn</code>, <span class="optional" title="Optional">[<code>Object scope</code>]</span> ) : Boolean <div class="mdesc">
<div class="short">Calls the passed function with each selection. If the function returns false, iteration is
stopped and this function ...</div>
<div class="long">
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">
<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">RowSelectionModel</td>
</tr>
<tr class="method-row inherited alt expandable">
<td class="micon"><a class="exi" href="#expand"> </a></td>
<td class="sig">
<a id="Ext.grid.RowSelectionModel-fireEvent"></a>
<b>fireEvent</b>( <code>String eventName</code>, <code>Object... args</code> ) : Boolean <div class="mdesc">
<div class="short">Fires the specified event with the passed parameters (minus the event name).</div>
<div class="long">
Fires the specified event with the passed parameters (minus the event name). <div class="mdetail-params">
<strong>Parameters:</strong>
<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>
<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 ext:cls="Ext.util.Observable" ext:member="#fireEvent" href="output/Ext.util.Observable.html#fireEvent">Observable</a></td>
</tr>
<tr class="method-row expandable">
<td class="micon"><a class="exi" href="#expand"> </a></td>
<td class="sig">
<a id="Ext.grid.RowSelectionModel-getCount"></a>
<b>getCount</b>() : 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></li>
</ul>
</div>
</div>
</div>
</td>
<td class="msource">RowSelectionModel</td>
</tr>
<tr class="method-row alt expandable">
<td class="micon"><a class="exi" href="#expand"> </a></td>
<td class="sig">
<a id="Ext.grid.RowSelectionModel-getSelected"></a>
<b>getSelected</b>() : 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></li>
</ul>
</div>
</div>
</div>
</td>
<td class="msource">RowSelectionModel</td>
</tr>
<tr class="method-row expandable">
<td class="micon"><a class="exi" href="#expand"> </a></td>
<td class="sig">
<a id="Ext.grid.RowSelectionModel-getSelections"></a>
<b>getSelections</b>() : 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">RowSelectionModel</td>
</tr>
<tr class="method-row inherited alt expandable">
<td class="micon"><a class="exi" href="#expand"> </a></td>
<td class="sig">
<a id="Ext.grid.RowSelectionModel-hasListener"></a>
<b>hasListener</b>( <code>String eventName</code> ) : 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 ext:cls="Ext.util.Observable" ext:member="#hasListener" href="output/Ext.util.Observable.html#hasListener">Observable</a></td>
</tr>
<tr class="method-row expandable">
<td class="micon"><a class="exi" href="#expand"> </a></td>
<td class="sig">
<a id="Ext.grid.RowSelectionModel-hasNext"></a>
<b>hasNext</b>() : 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></li>
</ul>
</div>
</div>
</div>
</td>
<td class="msource">RowSelectionModel</td>
</tr>
<tr class="method-row alt expandable">
<td class="micon"><a class="exi" href="#expand"> </a></td>
<td class="sig">
<a id="Ext.grid.RowSelectionModel-hasPrevious"></a>
<b>hasPrevious</b>() : 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></li>
</ul>
</div>
</div>
</div>
</td>
<td class="msource">RowSelectionModel</td>
</tr>
<tr class="method-row expandable">
<td class="micon"><a class="exi" href="#expand"> </a></td>
<td class="sig">
<a id="Ext.grid.RowSelectionModel-hasSelection"></a>
<b>hasSelection</b>() : Boolean <div class="mdesc">
<div class="short">Returns True if there is a selection.</div>
<div class="long">
Returns True 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></li>
</ul>
</div>
</div>
</div>
</td>
<td class="msource">RowSelectionModel</td>
</tr>
<tr class="method-row alt expandable">
<td class="micon"><a class="exi" href="#expand"> </a></td>
<td class="sig">
<a id="Ext.grid.RowSelectionModel-isIdSelected"></a>
<b>isIdSelected</b>( <code>String id</code> ) : Boolean <div class="mdesc">
<div class="short">Returns True if the specified record id is selected.</div>
<div class="long">
Returns True 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></li>
</ul>
</div>
</div>
</div>
</td>
<td class="msource">RowSelectionModel</td>
</tr>
<tr class="method-row inherited expandable">
<td class="micon"><a class="exi" href="#expand"> </a></td>
<td class="sig">
<a id="Ext.grid.RowSelectionModel-isLocked"></a>
<b>isLocked</b>() : 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></li>
</ul>
</div>
</div>
</div>
</td>
<td class="msource"><a ext:cls="Ext.grid.AbstractSelectionModel" ext:member="#isLocked" href="output/Ext.grid.AbstractSelectionModel.html#isLocked">AbstractSelectionModel</a></td>
</tr>
<tr class="method-row alt expandable">
<td class="micon"><a class="exi" href="#expand"> </a></td>
<td class="sig">
<a id="Ext.grid.RowSelectionModel-isSelected"></a>
<b>isSelected</b>( <code>Number/Record record</code> ) : Boolean <div class="mdesc">
<div class="short">Returns True if the specified row is selected.</div>
<div class="long">
Returns True if the specified row is selected. <div class="mdetail-params">
<strong>Parameters:</strong>
<ul><li><code>record</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></li>
</ul>
</div>
</div>
</div>
</td>
<td class="msource">RowSelectionModel</td>
</tr>
<tr class="method-row inherited expandable">
<td class="micon"><a class="exi" href="#expand"> </a></td>
<td class="sig">
<a id="Ext.grid.RowSelectionModel-lock"></a>
<b>lock</b>() : 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><code>void</code></li>
</ul>
</div>
</div>
</div>
</td>
<td class="msource"><a ext:cls="Ext.grid.AbstractSelectionModel" ext:member="#lock" href="output/Ext.grid.AbstractSelectionModel.html#lock">AbstractSelectionModel</a></td>
</tr>
<tr class="method-row inherited alt expandable">
<td class="micon"><a class="exi" href="#expand"> </a></td>
<td class="sig">
<a id="Ext.grid.RowSelectionModel-on"></a>
<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">
<div class="short">Appends an event handler to this element (shorthand for addListener)</div>
<div class="long">
Appends an event handler to this element (shorthand for addListener) <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 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>
<strong>Returns:</strong>
<ul>
<li><code>void</code></li>
</ul>
</div>
</div>
</div>
</td>
<td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#on" href="output/Ext.util.Observable.html#on">Observable</a></td>
</tr>
<tr class="method-row inherited expandable">
<td class="micon"><a class="exi" href="#expand"> </a></td>
<td class="sig">
<a id="Ext.grid.RowSelectionModel-purgeListeners"></a>
<b>purgeListeners</b>() : 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><code>void</code></li>
</ul>
</div>
</div>
</div>
</td>
<td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#purgeListeners" href="output/Ext.util.Observable.html#purgeListeners">Observable</a></td>
</tr>
<tr class="method-row inherited alt expandable">
<td class="micon"><a class="exi" href="#expand"> </a></td>
<td class="sig">
<a id="Ext.grid.RowSelectionModel-removeListener"></a>
<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">
<div class="short">Removes a listener</div>
<div class="long">
Removes a listener <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 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>
<strong>Returns:</strong>
<ul>
<li><code>void</code></li>
</ul>
</div>
</div>
</div>
</td>
<td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#removeListener" href="output/Ext.util.Observable.html#removeListener">Observable</a></td>
</tr>
<tr class="method-row inherited expandable">
<td class="micon"><a class="exi" href="#expand"> </a></td>
<td class="sig">
<a id="Ext.grid.RowSelectionModel-resumeEvents"></a>
<b>resumeEvents</b>() : void <div class="mdesc">
<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>
<div class="long">
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">
<strong>Parameters:</strong>
<ul><li>None.</li> </ul>
<strong>Returns:</strong>
<ul>
<li><code>void</code></li>
</ul>
</div>
</div>
</div>
</td>
<td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#resumeEvents" href="output/Ext.util.Observable.html#resumeEvents">Observable</a></td>
</tr>
<tr class="method-row alt expandable">
<td class="micon"><a class="exi" href="#expand"> </a></td>
<td class="sig">
<a id="Ext.grid.RowSelectionModel-selectAll"></a>
<b>selectAll</b>() : void <div class="mdesc">
<div class="short">Selects all rows.</div>
<div class="long">
Selects all rows. <div class="mdetail-params">
<strong>Parameters:</strong>
<ul><li>None.</li> </ul>
<strong>Returns:</strong>
<ul>
<li><code>void</code></li>
</ul>
</div>
</div>
</div>
</td>
<td class="msource">RowSelectionModel</td>
</tr>
<tr class="method-row expandable">
<td class="micon"><a class="exi" href="#expand"> </a></td>
<td class="sig">
<a id="Ext.grid.RowSelectionModel-selectFirstRow"></a>
<b>selectFirstRow</b>() : 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><code>void</code></li>
</ul>
</div>
</div>
</div>
</td>
<td class="msource">RowSelectionModel</td>
</tr>
<tr class="method-row alt expandable">
<td class="micon"><a class="exi" href="#expand"> </a></td>
<td class="sig">
<a id="Ext.grid.RowSelectionModel-selectLastRow"></a>
<b>selectLastRow</b>( <span class="optional" title="Optional">[<code>Boolean keepExisting</code>]</span> ) : 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) True to keep existing selections</div></li> </ul>
<strong>Returns:</strong>
<ul>
<li><code>void</code></li>
</ul>
</div>
</div>
</div>
</td>
<td class="msource">RowSelectionModel</td>
</tr>
<tr class="method-row expandable">
<td class="micon"><a class="exi" href="#expand"> </a></td>
<td class="sig">
<a id="Ext.grid.RowSelectionModel-selectNext"></a>
<b>selectNext</b>( <span class="optional" title="Optional">[<code>Boolean keepExisting</code>]</span> ) : 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) True to keep existing selections</div></li> </ul>
<strong>Returns:</strong>
<ul>
<li><code>Boolean</code><div class="sub-desc">True if there is a next row, else false</div></li>
</ul>
</div>
</div>
</div>
</td>
<td class="msource">RowSelectionModel</td>
</tr>
<tr class="method-row alt expandable">
<td class="micon"><a class="exi" href="#expand"> </a></td>
<td class="sig">
<a id="Ext.grid.RowSelectionModel-selectPrevious"></a>
<b>selectPrevious</b>( <span class="optional" title="Optional">[<code>Boolean keepExisting</code>]</span> ) : 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) True to keep existing selections</div></li> </ul>
<strong>Returns:</strong>
<ul>
<li><code>Boolean</code><div class="sub-desc">True if there is a previous row, else false</div></li>
</ul>
</div>
</div>
</div>
</td>
<td class="msource">RowSelectionModel</td>
</tr>
<tr class="method-row expandable">
<td class="micon"><a class="exi" href="#expand"> </a></td>
<td class="sig">
<a id="Ext.grid.RowSelectionModel-selectRange"></a>
<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">
<div class="short">Selects a range of rows. All rows in between startRow and endRow are also selected.</div>
<div class="long">
Selects a range of rows. 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><code>void</code></li>
</ul>
</div>
</div>
</div>
</td>
<td class="msource">RowSelectionModel</td>
</tr>
<tr class="method-row alt expandable">
<td class="micon"><a class="exi" href="#expand"> </a></td>
<td class="sig">
<a id="Ext.grid.RowSelectionModel-selectRecords"></a>
<b>selectRecords</b>( <code>Array records</code>, <span class="optional" title="Optional">[<code>Boolean keepExisting</code>]</span> ) : 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) True to keep existing selections</div></li> </ul>
<strong>Returns:</strong>
<ul>
<li><code>void</code></li>
</ul>
</div>
</div>
</div>
</td>
<td class="msource">RowSelectionModel</td>
</tr>
<tr class="method-row expandable">
<td class="micon"><a class="exi" href="#expand"> </a></td>
<td class="sig">
<a id="Ext.grid.RowSelectionModel-selectRow"></a>
<b>selectRow</b>( <code>Number row</code>, <span class="optional" title="Optional">[<code>Boolean keepExisting</code>]</span> ) : void <div class="mdesc">
<div class="short">Selects a row.</div>
<div class="long">
Selects a row. <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) True to keep existing selections</div></li> </ul>
<strong>Returns:</strong>
<ul>
<li><code>void</code></li>
</ul>
</div>
</div>
</div>
</td>
<td class="msource">RowSelectionModel</td>
</tr>
<tr class="method-row alt expandable">
<td class="micon"><a class="exi" href="#expand"> </a></td>
<td class="sig">
<a id="Ext.grid.RowSelectionModel-selectRows"></a>
<b>selectRows</b>( <code>Array rows</code>, <span class="optional" title="Optional">[<code>Boolean keepExisting</code>]</span> ) : 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) True to keep existing selections (defaults to false)</div></li> </ul>
<strong>Returns:</strong>
<ul>
<li><code>void</code></li>
</ul>
</div>
</div>
</div>
</td>
<td class="msource">RowSelectionModel</td>
</tr>
<tr class="method-row inherited expandable">
<td class="micon"><a class="exi" href="#expand"> </a></td>
<td class="sig">
<a id="Ext.grid.RowSelectionModel-suspendEvents"></a>
<b>suspendEvents</b>() : void <div class="mdesc">
<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>
<div class="long">
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">
<strong>Parameters:</strong>
<ul><li>None.</li> </ul>
<strong>Returns:</strong>
<ul>
<li><code>void</code></li>
</ul>
</div>
</div>
</div>
</td>
<td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#suspendEvents" href="output/Ext.util.Observable.html#suspendEvents">Observable</a></td>
</tr>
<tr class="method-row inherited alt expandable">
<td class="micon"><a class="exi" href="#expand"> </a></td>
<td class="sig">
<a id="Ext.grid.RowSelectionModel-un"></a>
<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">
<div class="short">Removes a listener (shorthand for removeListener)</div>
<div class="long">
Removes a listener (shorthand for removeListener) <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 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>
<strong>Returns:</strong>
<ul>
<li><code>void</code></li>
</ul>
</div>
</div>
</div>
</td>
<td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#un" href="output/Ext.util.Observable.html#un">Observable</a></td>
</tr>
<tr class="method-row inherited expandable">
<td class="micon"><a class="exi" href="#expand"> </a></td>
<td class="sig">
<a id="Ext.grid.RowSelectionModel-unlock"></a>
<b>unlock</b>() : 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><code>void</code></li>
</ul>
</div>
</div>
</div>
</td>
<td class="msource"><a ext:cls="Ext.grid.AbstractSelectionModel" ext:member="#unlock" href="output/Ext.grid.AbstractSelectionModel.html#unlock">AbstractSelectionModel</a></td>
</tr>
</table>
<a id="Ext.grid.RowSelectionModel-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 expandable">
<td class="micon"><a class="exi" href="#expand"> </a></td>
<td class="sig">
<a id="Ext.grid.RowSelectionModel-beforerowselect"></a>
<b>beforerowselect</b> : ( <code>SelectionModel this</code>, <code>Number rowIndex</code>, <code>Boolean keepExisting</code>, <code>Record record</code> ) <div class="mdesc">
<div class="short">Fires when a row is being selected, return false to cancel.</div>
<div class="long">
Fires when a row is being selected, return false to cancel. <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">RowSelectionModel</td>
</tr>
<tr class="event-row alt expandable">
<td class="micon"><a class="exi" href="#expand"> </a></td>
<td class="sig">
<a id="Ext.grid.RowSelectionModel-rowdeselect"></a>
<b>rowdeselect</b> : ( <code>SelectionModel this</code>, <code>Number rowIndex</code>, <code>Record record</code> ) <div class="mdesc">
<div class="short">Fires when a row is deselected.</div>
<div class="long">
Fires when a row is deselected. <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">RowSelectionModel</td>
</tr>
<tr class="event-row expandable">
<td class="micon"><a class="exi" href="#expand"> </a></td>
<td class="sig">
<a id="Ext.grid.RowSelectionModel-rowselect"></a>
<b>rowselect</b> : ( <code>SelectionModel this</code>, <code>Number rowIndex</code>, <code>Ext.data.Record r</code> ) <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">RowSelectionModel</td>
</tr>
<tr class="event-row alt expandable">
<td class="micon"><a class="exi" href="#expand"> </a></td>
<td class="sig">
<a id="Ext.grid.RowSelectionModel-selectionchange"></a>
<b>selectionchange</b> : ( <code>SelectionModel this</code> ) <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">RowSelectionModel</td>
</tr>
</table>
</div>