docs/symbols/Roo.grid.CellSelectionModel.html
authorAlan Knowles <alan@akbkhome.com>
Fri, 16 Jul 2010 07:57:03 +0000 (15:57 +0800)
committerAlan Knowles <alan@akbkhome.com>
Fri, 16 Jul 2010 07:57:03 +0000 (15:57 +0800)
docs/symbols/Roo.grid.CellSelectionModel.html [new file with mode: 0644]

diff --git a/docs/symbols/Roo.grid.CellSelectionModel.html b/docs/symbols/Roo.grid.CellSelectionModel.html
new file mode 100644 (file)
index 0000000..b1b1fab
--- /dev/null
@@ -0,0 +1,734 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
+
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+
+       <head>
+               <meta http-equiv="content-type" content="text/html; charset=undefined" />
+               <meta name="generator" content="JsDoc Toolkit" />
+               
+               
+               <title>JsDoc Reference - Roo.grid.CellSelectionModel</title>
+               
+               
+       <link rel="stylesheet" type="text/css" href="../../css/roojs.css" />            
+       <link rel="stylesheet" type="text/css" href="../default.css" />
+       
+       
+       <script type="text/javascript" src="../page.js">
+       
+       </script>
+        
+               
+       </head>
+
+       <body onload="RooDocsPage.onload();">
+        
+       
+<div class="body-wrap">
+
+    <!-- ============================== links to methods. ================================= -->        
+
+    <div class="top-tools">
+    <!--
+        <a class="inner-link" href="#Roo.grid.CellSelectionModel-props"><img src="resources/s.gif" class="item-icon icon-prop">Properties</a>
+        <a class="inner-link" href="#Roo.grid.CellSelectionModel-methods"><img src="resources/s.gif" class="item-icon icon-method">Methods</a>
+        <a class="inner-link" href="#Roo.grid.CellSelectionModel-events"><img src="resources/s.gif" class="item-icon icon-event">Events</a>
+        <a class="inner-link" href="#Roo.grid.CellSelectionModel-configs"><img src="resources/s.gif" class="item-icon icon-config">Config Options</a>
+        <a class="bookmark" href="NEED_TO_CREATE_DIRECT_LINK_HREF"><img src="resources/s.gif" class="item-icon icon-fav">Direct Link</a>
+       -->
+    </div>
+
+    
+<!-- ============================== inheritance Block. ================================= -->   
+       
+               <div class="inheritance res-block">
+                  <pre class="res-block-inner"><a href="./Roo.grid.AbstractSelectionModel.html#constructor" roo:cls="Roo.grid.AbstractSelectionModel.html#constructor">Roo.grid.AbstractSelectionModel</a>
+<img src="../../images/default/s.gif" height="1"  width="20"/><img class="elbow" src="../../images/default/tree/elbow-end.gif"/>Roo.grid.CellSelectionModel 
+
+                  </pre>
+               </div>
+       
+<!-- ============================== class title / details ============================ -->
+    
+    
+    <h1 class="classTitle">
+                               
+                               Class Roo.grid.CellSelectionModel
+                       </h1>
+                       
+    <table cellspacing="0" class="class-summary-table">
+       
+               <tr><td class="label">Package:</td><td class="hd-info">Roo.grid</td></tr>
+       
+        <tr><td class="label">Defined In:</td><td class="hd-info">
+                       
+                                       <a href="./src/Roo_grid_CellSelectionModel.js.html">Roo/grid/CellSelectionModel.js</a>.
+                       
+       </td></tr>
+        <tr><td class="label">Class:</td><td class="hd-info">CellSelectionModel</td></tr>
+       
+       
+       
+       
+               <tr><td class="label">Extends:</td><td class="hd-info">
+                       <a href="./Roo.grid.AbstractSelectionModel.html#constructor" roo:cls="Roo.grid.AbstractSelectionModel.html#constructor">Roo.grid.AbstractSelectionModel</a>
+       
+               </td></tr>    
+       
+       
+    </table>
+
+    
+<!-- ============================== class summary ========================== -->                       
+    <div class="description">
+       This class provides the basic implementation for cell selection in a grid.
+    </div>
+
+       
+<!-- ============================== Class comment block... ========================== -->                                      
+
+<div class="comments">
+       <b>Class Comments / Notes</B> =>  
+       <u onclick="parent.CommentDialog.showCommentId = 'Roo.grid.CellSelectionModel';">[Add Your comment/notes about this class]</u>
+       <br/>
+       <iframe frameborder="0"  id="comments-Roo.grid" style="border: none;width:100%;" 
+               src="/blog.php/GtkDjsComments/Roo.grid.CellSelectionModel.html"></iframe>
+</div>
+       
+
+               
+<!-- ============================== config options ========================== -->                                              
+                
+    
+    
+               
+    <div class="hr"></div>
+    <a id="Roo.grid.CellSelectionModel-configs"></a>
+               
+    
+    
+     <table cellspacing="0" class="member-table">
+      <caption class="Empty">Config Options - Has None</caption>
+     </table>
+    
+    
+     
+               
+  
+  
+  
+  
+  
+  
+  
+  
+  <!-- ============================== public properties ==================== -->       
+  
+  
+  
+    <a id="Roo.grid.CellSelectionModel-props"></a>      
+    
+    
+
+    
+    
+     <table cellspacing="0" class="member-table">
+      <caption class="Empty">Public Properties - Has None</caption>
+     </table>
+    
+    
+     
+    
+  <!-- ============================== methods summary / details ======================== -->
+  
+  
+  <a id="Roo.grid.CellSelectionModel-methods"></a>
+       <!-- constructor?? -->
+       
+       <!-- static's first 
+       
+       
+       -->
+       
+       <!-- then dynamics first -->
+       
+  
+  
+    
+    
+    
+      <table cellspacing="0" class="member-table">
+      <caption>Public Methods</caption>
+        <tr>
+            <th class="sig-header" colspan="2">Method</th>            
+            <th class="msource-header">Defined By</th>
+
+        </tr>
+        
+       
+       
+        
+       
+        
+         
+          <tr class="method-row config-row-alt0 expandable notInherited">
+            <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
+          
+          
+            <td class="sig">
+                <a id="Roo.grid-method-CellSelectionModel"   name=".CellSelectionModel"></a>
+               <div class="fixedFont">
+                       <span class="attributes">new <B>Roo.grid.</B></span><b class="itemname">CellSelectionModel</b>
+                               
+                                (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>config</i></B>) 
+                       
+                               
+                       
+               </div>
+                <div class="mdesc">
+               
+                
+                       <div class="short">Create a new Roo.grid.CellSelectionModel</div> 
+                
+                
+                    <div class="long">
+                       
+                       
+                       
+                               Create a new Roo.grid.CellSelectionModel
+                       
+                       
+                               <dl class="detailList">
+                               <dt class="heading">Parameters:</dt>
+                               
+                                       <dt>
+                                               <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span>  <b>config</b>
+                                               
+                                       </dt>
+                                       <dd>The object containing the configuration of this model.</dd>
+                               
+                               </dl>
+                       
+                       
+                       
+                       
+                       
+                       
+                       
+
+                   
+                   
+                    
+                    </div>                    
+                </div>
+
+            </td>
+            <td class="msource">
+               &nbsp;
+            </td>
+        </tr>
+       
+         
+          <tr class="method-row config-row-alt1 expandable notInherited">
+            <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
+          
+          
+            <td class="sig">
+                <a id="Roo.grid.CellSelectionModel-method-clearSelections"   name=".clearSelections"></a>
+               <div class="fixedFont">
+                       <span class="attributes"></span><b class="itemname">clearSelections</b>
+                               
+                                (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a> <B><i>true</i></B>) 
+                       
+                               
+                       
+               </div>
+                <div class="mdesc">
+               
+                   <div class="short">Clears all selections.</div> 
+                
+                
+                
+                    <div class="long">
+                       
+                               Clears all selections.
+                   
+                               
+                       
+                       
+                       
+                       
+                               <dl class="detailList">
+                               <dt class="heading">Parameters:</dt>
+                               
+                                       <dt>
+                                               <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span>  <b>true</b>
+                                               
+                                       </dt>
+                                       <dd>to prevent the gridview from being notified about the change.</dd>
+                               
+                               </dl>
+                       
+                       
+                       
+                       
+                       
+                       
+                       
+
+                   
+                   
+                    
+                    </div>                    
+                </div>
+
+            </td>
+            <td class="msource">
+               
+                       Roo.grid.CellSelectionModel
+               &nbsp;
+            </td>
+        </tr>
+       
+         
+          <tr class="method-row config-row-alt0 expandable notInherited">
+            <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
+          
+          
+            <td class="sig">
+                <a id="Roo.grid.CellSelectionModel-method-getSelectedCell"   name=".getSelectedCell"></a>
+               <div class="fixedFont">
+                       <span class="attributes"></span><b class="itemname">getSelectedCell</b>
+                               
+                                () 
+                       
+                               
+                                        : 
+                                       
+                                               
+                                               <a href="./Array.html#constructor" roo:cls="Array.html#constructor">Array</a>
+                                       
+                                       
+                                       
+                               
+                       
+               </div>
+                <div class="mdesc">
+               
+                   <div class="short">Returns the currently selected cell,.</div> 
+                
+                
+                
+                    <div class="long">
+                       
+                               Returns the currently selected cell,.
+                   
+                               
+                       
+                       
+                       
+                       
+                       
+                       
+                       
+                       
+                               <dl class="detailList">
+                               <dt class="heading">Returns:</dt>
+                               
+                                       <dd><span class="fixedFont"><a href="./Array.html#constructor" roo:cls="Array.html#constructor">Array</a></span>  The selected cell (row, column) or null if none selected.</dd>
+                               
+                               </dl>
+                       
+                       
+                       
+
+                   
+                   
+                    
+                    </div>                    
+                </div>
+
+            </td>
+            <td class="msource">
+               
+                       Roo.grid.CellSelectionModel
+               &nbsp;
+            </td>
+        </tr>
+       
+         
+          <tr class="method-row config-row-alt1 expandable notInherited">
+            <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
+          
+          
+            <td class="sig">
+                <a id="Roo.grid.CellSelectionModel-method-hasSelection"   name=".hasSelection"></a>
+               <div class="fixedFont">
+                       <span class="attributes"></span><b class="itemname">hasSelection</b>
+                               
+                                () 
+                       
+                               
+                                        : 
+                                       
+                                               
+                                               <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
+                                       
+                                       
+                                       
+                               
+                       
+               </div>
+                <div class="mdesc">
+               
+                   <div class="short">Returns true if there is a selection.</div> 
+                
+                
+                
+                    <div class="long">
+                       
+                               Returns true if there is a selection.
+                   
+                               
+                       
+                       
+                       
+                       
+                       
+                       
+                       
+                       
+                               <dl class="detailList">
+                               <dt class="heading">Returns:</dt>
+                               
+                                       <dd><span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span>  </dd>
+                               
+                               </dl>
+                       
+                       
+                       
+
+                   
+                   
+                    
+                    </div>                    
+                </div>
+
+            </td>
+            <td class="msource">
+               
+                       Roo.grid.CellSelectionModel
+               &nbsp;
+            </td>
+        </tr>
+       
+         
+          <tr class="method-row config-row-alt0 expandable notInherited">
+            <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
+          
+          
+            <td class="sig">
+                <a id="Roo.grid.CellSelectionModel-method-select"   name=".select"></a>
+               <div class="fixedFont">
+                       <span class="attributes"></span><b class="itemname">select</b>
+                               
+                                (<a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a> <B><i>rowIndex</i></B>, <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a> <B><i>collIndex</i></B>) 
+                       
+                               
+                       
+               </div>
+                <div class="mdesc">
+               
+                   <div class="short">Selects a cell.</div> 
+                
+                
+                
+                    <div class="long">
+                       
+                               Selects a cell.
+                   
+                               
+                       
+                       
+                       
+                       
+                               <dl class="detailList">
+                               <dt class="heading">Parameters:</dt>
+                               
+                                       <dt>
+                                               <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span>  <b>rowIndex</b>
+                                               
+                                       </dt>
+                                       <dd></dd>
+                               
+                                       <dt>
+                                               <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span>  <b>collIndex</b>
+                                               
+                                       </dt>
+                                       <dd></dd>
+                               
+                               </dl>
+                       
+                       
+                       
+                       
+                       
+                       
+                       
+
+                   
+                   
+                    
+                    </div>                    
+                </div>
+
+            </td>
+            <td class="msource">
+               
+                       Roo.grid.CellSelectionModel
+               &nbsp;
+            </td>
+        </tr>
+       
+                                                      
+    </table>
+
+  
+  <!-- ============================== events summary / details ======================== -->
+  
+  
+  <a id="Roo.grid.CellSelectionModel-events"></a>
+    
+  
+       
+   
+  
+    
+    
+    
+      <table cellspacing="0" class="member-table">
+               <caption>Events</caption>
+             <thead>
+               <tr>
+                   <th class="sig-header" colspan="2">Event</th>            
+                   <th class="msource-header">Defined By</th>
+
+               </tr>
+             </thead>  
+       
+       
+        
+       
+        
+          <tr class="method-row expandable config-row-alt0 notInherited">
+            <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
+           
+            <td class="sig">
+                <a id="Roo.grid.CellSelectionModel-event-*beforerowselect"></a>
+                
+              <div class="fixedFont">
+               <b class="itemname">beforerowselect</b> (SelectionModel <B><i>this</i></B>, <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a> <B><i>rowIndex</i></B>, <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a> <B><i>colIndex</i></B>) 
+               
+               </div>
+
+                <div class="mdesc">
+
+                   <div class="short">Fires before a cell is selected.
+                  
+               </div> 
+                   
+                    <div class="long">
+                   
+                       Fires before a cell is selected.
+                   
+                       
+                       
+               
+                       
+                               <dl class="detailList">
+                               <dt class="heading">Parameters:</dt>
+                               
+                                       <dt>
+                                               <span class="fixedFont">SelectionModel</span> <b>this</b>
+                                               
+                                       </dt>
+                                       <dd></dd>
+                               
+                                       <dt>
+                                               <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>rowIndex</b>
+                                               
+                                       </dt>
+                                       <dd>The selected row index</dd>
+                               
+                                       <dt>
+                                               <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>colIndex</b>
+                                               
+                                       </dt>
+                                       <dd>The selected cell index</dd>
+                               
+                               </dl>
+                       
+                       
+                       
+                       
+                       
+                       
+                       
+
+                   
+                   
+                    
+                    </div>                    
+                </div>
+
+            </td>
+            <td class="msource">
+                Roo.grid.CellSelectionModel
+            </td>
+        </tr>
+       
+          <tr class="method-row expandable config-row-alt1 notInherited">
+            <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
+           
+            <td class="sig">
+                <a id="Roo.grid.CellSelectionModel-event-*cellselect"></a>
+                
+              <div class="fixedFont">
+               <b class="itemname">cellselect</b> (SelectionModel <B><i>this</i></B>, <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a> <B><i>rowIndex</i></B>, <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a> <B><i>colIndex</i></B>) 
+               
+               </div>
+
+                <div class="mdesc">
+
+                   <div class="short">Fires when a cell is selected.
+                  
+               </div> 
+                   
+                    <div class="long">
+                   
+                       Fires when a cell is selected.
+                   
+                       
+                       
+               
+                       
+                               <dl class="detailList">
+                               <dt class="heading">Parameters:</dt>
+                               
+                                       <dt>
+                                               <span class="fixedFont">SelectionModel</span> <b>this</b>
+                                               
+                                       </dt>
+                                       <dd></dd>
+                               
+                                       <dt>
+                                               <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>rowIndex</b>
+                                               
+                                       </dt>
+                                       <dd>The selected row index</dd>
+                               
+                                       <dt>
+                                               <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>colIndex</b>
+                                               
+                                       </dt>
+                                       <dd>The selected cell index</dd>
+                               
+                               </dl>
+                       
+                       
+                       
+                       
+                       
+                       
+                       
+
+                   
+                   
+                    
+                    </div>                    
+                </div>
+
+            </td>
+            <td class="msource">
+                Roo.grid.CellSelectionModel
+            </td>
+        </tr>
+       
+          <tr class="method-row expandable config-row-alt0 notInherited">
+            <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
+           
+            <td class="sig">
+                <a id="Roo.grid.CellSelectionModel-event-*selectionchange"></a>
+                
+              <div class="fixedFont">
+               <b class="itemname">selectionchange</b> (SelectionModel <B><i>this</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>selection</i></B>) 
+               
+               </div>
+
+                <div class="mdesc">
+
+                   <div class="short">Fires when the active selection changes.
+                  
+               </div> 
+                   
+                    <div class="long">
+                   
+                       Fires when the active selection changes.
+                   
+                       
+                       
+               
+                       
+                               <dl class="detailList">
+                               <dt class="heading">Parameters:</dt>
+                               
+                                       <dt>
+                                               <span class="fixedFont">SelectionModel</span> <b>this</b>
+                                               
+                                       </dt>
+                                       <dd></dd>
+                               
+                                       <dt>
+                                               <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span> <b>selection</b>
+                                               
+                                       </dt>
+                                       <dd>null for no selection or an object (o) with two properties<br/>             <ul><br/>               <li>o.record: the record object for the row the selection is in</li><br/>               <li>o.cell: An array of [rowIndex, columnIndex]</li><br/>               </ul></dd>
+                               
+                               </dl>
+                       
+                       
+                       
+                       
+                       
+                       
+                       
+
+                   
+                   
+                    
+                    </div>                    
+                </div>
+
+            </td>
+            <td class="msource">
+                Roo.grid.CellSelectionModel
+            </td>
+        </tr>
+       
+                                                      
+    </table>
+
+  
+  
+  
+<!-- ============================== footer ================================= -->
+               <div class="fineprint" style="clear:both">
+                       
+                       Documentation generated by <a href="http://www.akbkhome.com" target="_blankt">Introspection Doc Generator</a>  on Fri Jul 16 2010 15:55:27 GMT+0800 (HKT)
+                       Based on 
+                       <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a>  
+               </div>
+       </body>
+</html>