major doc changes
[roojs1] / docs / src / Roo_grid_AbstractSelectionModel.js.html
1 <html><head><title>Roo/grid/AbstractSelectionModel.js</title><link rel="stylesheet" type="text/css" href="../../css/highlight-js.css"/></head><body class="highlightpage"><code class="jsdoc-pretty"><span class="jsdoc-comment">/*
2  * Based on:
3  * Ext JS Library 1.1.1
4  * Copyright(c) 2006-2007, Ext JS, LLC.
5  *
6  * Originally Released Under LGPL - original licence link has changed is not relivant.
7  *
8  * Fork - LGPL
9  * &lt;script type=&quot;text/javascript&quot;&gt;
10  */
11
12 /**
13  * @class Roo.grid.AbstractSelectionModel
14  * @extends Roo.util.Observable
15  * @abstract
16  * Abstract base class for grid SelectionModels.  It provides the interface that should be
17  * implemented by descendant classes.  This class should not be directly instantiated.
18  * @constructor
19  */
20 </span><span class="jsdoc-var">Roo.grid.AbstractSelectionModel </span><span class="jsdoc-syntax">= </span><span class="jsdoc-keyword">function</span><span class="jsdoc-syntax">(){
21     </span><span class="jsdoc-var">this.locked </span><span class="jsdoc-syntax">= </span><span class="jsdoc-keyword">false</span><span class="jsdoc-syntax">;
22     </span><span class="jsdoc-var">Roo.grid.AbstractSelectionModel.superclass.constructor.call</span><span class="jsdoc-syntax">(</span><span class="jsdoc-var">this</span><span class="jsdoc-syntax">);
23 };
24
25 </span><span class="jsdoc-var">Roo.extend</span><span class="jsdoc-syntax">(</span><span class="jsdoc-var">Roo.grid.AbstractSelectionModel</span><span class="jsdoc-syntax">, </span><span class="jsdoc-var">Roo.util.Observable</span><span class="jsdoc-syntax">,  {
26     </span><span class="jsdoc-comment">/** @ignore Called by the grid automatically. Do not call directly. */
27     </span><span class="jsdoc-var">init </span><span class="jsdoc-syntax">: </span><span class="jsdoc-keyword">function</span><span class="jsdoc-syntax">(</span><span class="jsdoc-var">grid</span><span class="jsdoc-syntax">){
28         </span><span class="jsdoc-var">this.grid </span><span class="jsdoc-syntax">= </span><span class="jsdoc-var">grid</span><span class="jsdoc-syntax">;
29         </span><span class="jsdoc-var">this.initEvents</span><span class="jsdoc-syntax">();
30     },
31
32     </span><span class="jsdoc-comment">/**
33      * Locks the selections.
34      */
35     </span><span class="jsdoc-var">lock </span><span class="jsdoc-syntax">: </span><span class="jsdoc-keyword">function</span><span class="jsdoc-syntax">(){
36         </span><span class="jsdoc-var">this.locked </span><span class="jsdoc-syntax">= </span><span class="jsdoc-keyword">true</span><span class="jsdoc-syntax">;
37     },
38
39     </span><span class="jsdoc-comment">/**
40      * Unlocks the selections.
41      */
42     </span><span class="jsdoc-var">unlock </span><span class="jsdoc-syntax">: </span><span class="jsdoc-keyword">function</span><span class="jsdoc-syntax">(){
43         </span><span class="jsdoc-var">this.locked </span><span class="jsdoc-syntax">= </span><span class="jsdoc-keyword">false</span><span class="jsdoc-syntax">;
44     },
45
46     </span><span class="jsdoc-comment">/**
47      * Returns true if the selections are locked.
48      * @return {Boolean}
49      */
50     </span><span class="jsdoc-var">isLocked </span><span class="jsdoc-syntax">: </span><span class="jsdoc-keyword">function</span><span class="jsdoc-syntax">(){
51         </span><span class="jsdoc-keyword">return </span><span class="jsdoc-var">this.locked</span><span class="jsdoc-syntax">;
52     }
53 });</span></code></body></html>