1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
4 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
7 <meta http-equiv="content-type" content="text/html; charset=undefined" />
8 <meta name="generator" content="JsDoc Toolkit" />
11 <title>JsDoc Reference - Roo.grid.CellSelectionModel</title>
14 <link rel="stylesheet" type="text/css" href="../../css/roojs.css" />
15 <link rel="stylesheet" type="text/css" href="../default.css" />
18 <script type="text/javascript" src="../page.js">
25 <body onload="RooDocsPage.onload();">
28 <div class="body-wrap">
30 <!-- ============================== links to methods. ================================= -->
32 <div class="top-tools">
34 <a class="inner-link" href="#Roo.grid.CellSelectionModel-props"><img src="resources/s.gif" class="item-icon icon-prop">Properties</a>
35 <a class="inner-link" href="#Roo.grid.CellSelectionModel-methods"><img src="resources/s.gif" class="item-icon icon-method">Methods</a>
36 <a class="inner-link" href="#Roo.grid.CellSelectionModel-events"><img src="resources/s.gif" class="item-icon icon-event">Events</a>
37 <a class="inner-link" href="#Roo.grid.CellSelectionModel-configs"><img src="resources/s.gif" class="item-icon icon-config">Config Options</a>
38 <a class="bookmark" href="NEED_TO_CREATE_DIRECT_LINK_HREF"><img src="resources/s.gif" class="item-icon icon-fav">Direct Link</a>
43 <!-- ============================== inheritance Block. ================================= -->
45 <div class="inheritance res-block">
46 <pre class="res-block-inner"><a href="./Roo.grid.AbstractSelectionModel.html#constructor" roo:cls="Roo.grid.AbstractSelectionModel.html#constructor">Roo.grid.AbstractSelectionModel</a>
47 <img src="../../images/default/s.gif" height="1" width="20"/><img class="elbow" src="../../images/default/tree/elbow-end.gif"/>Roo.grid.CellSelectionModel
52 <!-- ============================== class title / details ============================ -->
55 <h1 class="classTitle">
57 Class Roo.grid.CellSelectionModel
60 <table cellspacing="0" class="class-summary-table">
62 <tr><td class="label">Package:</td><td class="hd-info">Roo.grid</td></tr>
64 <tr><td class="label">Defined In:</td><td class="hd-info">
66 <a href="./src/Roo_grid_CellSelectionModel.js.html">Roo/grid/CellSelectionModel.js</a>.
69 <tr><td class="label">Class:</td><td class="hd-info">CellSelectionModel</td></tr>
74 <tr><td class="label">Extends:</td><td class="hd-info">
75 <a href="./Roo.grid.AbstractSelectionModel.html#constructor" roo:cls="Roo.grid.AbstractSelectionModel.html#constructor">Roo.grid.AbstractSelectionModel</a>
83 <!-- ============================== class summary ========================== -->
84 <div class="description">
85 This class provides the basic implementation for cell selection in a grid.
89 <!-- ============================== Class comment block... ========================== -->
91 <div class="comments">
92 <b>Class Comments / Notes</B> =>
93 <u onclick="parent.CommentDialog.showCommentId = 'Roo.grid.CellSelectionModel';">[Add Your comment/notes about this class]</u>
95 <iframe frameborder="0" id="comments-Roo.grid" style="border: none;width:100%;"
96 src="/blog.php/GtkDjsComments/Roo.grid.CellSelectionModel.html"></iframe>
101 <!-- ============================== config options ========================== -->
106 <div class="hr"></div>
107 <a id="Roo.grid.CellSelectionModel-configs"></a>
111 <table cellspacing="0" class="member-table">
112 <caption class="Empty">Config Options - Has None</caption>
126 <!-- ============================== public properties ==================== -->
130 <a id="Roo.grid.CellSelectionModel-props"></a>
136 <table cellspacing="0" class="member-table">
137 <caption class="Empty">Public Properties - Has None</caption>
143 <!-- ============================== methods summary / details ======================== -->
146 <a id="Roo.grid.CellSelectionModel-methods"></a>
147 <!-- constructor?? -->
154 <!-- then dynamics first -->
161 <table cellspacing="0" class="member-table">
162 <caption>Public Methods</caption>
164 <th class="sig-header" colspan="2">Method</th>
165 <th class="msource-header">Defined By</th>
175 <tr class="method-row config-row-alt0 expandable notInherited">
176 <td class="micon"><a class="exi" href="#expand"> </a></td>
180 <a id="Roo.grid-method-CellSelectionModel" name=".CellSelectionModel"></a>
181 <div class="fixedFont">
182 <span class="attributes">new <B>Roo.grid.</B></span><b class="itemname">CellSelectionModel</b>
184 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>config</i></B>)
192 <div class="short">Create a new Roo.grid.CellSelectionModel</div>
199 Create a new Roo.grid.CellSelectionModel
202 <dl class="detailList">
203 <dt class="heading">Parameters:</dt>
206 <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>
209 <dd>The object containing the configuration of this model.</dd>
233 <tr class="method-row config-row-alt1 expandable notInherited">
234 <td class="micon"><a class="exi" href="#expand"> </a></td>
238 <a id="Roo.grid.CellSelectionModel-method-clearSelections" name=".clearSelections"></a>
239 <div class="fixedFont">
240 <span class="attributes"></span><b class="itemname">clearSelections</b>
242 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a> <B><i>true</i></B>)
249 <div class="short">Clears all selections.</div>
255 Clears all selections.
262 <dl class="detailList">
263 <dt class="heading">Parameters:</dt>
266 <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>
269 <dd>to prevent the gridview from being notified about the change.</dd>
289 Roo.grid.CellSelectionModel
295 <tr class="method-row config-row-alt0 expandable notInherited">
296 <td class="micon"><a class="exi" href="#expand"> </a></td>
300 <a id="Roo.grid.CellSelectionModel-method-getSelectedCell" name=".getSelectedCell"></a>
301 <div class="fixedFont">
302 <span class="attributes"></span><b class="itemname">getSelectedCell</b>
310 <a href="./Array.html#constructor" roo:cls="Array.html#constructor">Array</a>
319 <div class="short">Returns the currently selected cell,.</div>
325 Returns the currently selected cell,.
336 <dl class="detailList">
337 <dt class="heading">Returns:</dt>
339 <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>
355 Roo.grid.CellSelectionModel
361 <tr class="method-row config-row-alt1 expandable notInherited">
362 <td class="micon"><a class="exi" href="#expand"> </a></td>
366 <a id="Roo.grid.CellSelectionModel-method-hasSelection" name=".hasSelection"></a>
367 <div class="fixedFont">
368 <span class="attributes"></span><b class="itemname">hasSelection</b>
376 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
385 <div class="short">Returns true if there is a selection.</div>
391 Returns true if there is a selection.
402 <dl class="detailList">
403 <dt class="heading">Returns:</dt>
405 <dd><span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span> </dd>
421 Roo.grid.CellSelectionModel
427 <tr class="method-row config-row-alt0 expandable notInherited">
428 <td class="micon"><a class="exi" href="#expand"> </a></td>
432 <a id="Roo.grid.CellSelectionModel-method-select" name=".select"></a>
433 <div class="fixedFont">
434 <span class="attributes"></span><b class="itemname">select</b>
436 (<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>)
443 <div class="short">Selects a cell.</div>
456 <dl class="detailList">
457 <dt class="heading">Parameters:</dt>
460 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>rowIndex</b>
466 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>collIndex</b>
489 Roo.grid.CellSelectionModel
498 <!-- ============================== events summary / details ======================== -->
501 <a id="Roo.grid.CellSelectionModel-events"></a>
510 <table cellspacing="0" class="member-table">
511 <caption>Events</caption>
514 <th class="sig-header" colspan="2">Event</th>
515 <th class="msource-header">Defined By</th>
524 <tr class="method-row expandable config-row-alt0 notInherited">
525 <td class="micon"><a class="exi" href="#expand"> </a></td>
528 <a id="Roo.grid.CellSelectionModel-event-*beforerowselect"></a>
530 <div class="fixedFont">
531 <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>)
537 <div class="short">Fires before a cell is selected.
543 Fires before a cell is selected.
549 <dl class="detailList">
550 <dt class="heading">Parameters:</dt>
553 <span class="fixedFont">SelectionModel</span> <b>this</b>
559 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>rowIndex</b>
562 <dd>The selected row index</dd>
565 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>colIndex</b>
568 <dd>The selected cell index</dd>
587 Roo.grid.CellSelectionModel
591 <tr class="method-row expandable config-row-alt1 notInherited">
592 <td class="micon"><a class="exi" href="#expand"> </a></td>
595 <a id="Roo.grid.CellSelectionModel-event-*cellselect"></a>
597 <div class="fixedFont">
598 <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>)
604 <div class="short">Fires when a cell is selected.
610 Fires when a cell is selected.
616 <dl class="detailList">
617 <dt class="heading">Parameters:</dt>
620 <span class="fixedFont">SelectionModel</span> <b>this</b>
626 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>rowIndex</b>
629 <dd>The selected row index</dd>
632 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>colIndex</b>
635 <dd>The selected cell index</dd>
654 Roo.grid.CellSelectionModel
658 <tr class="method-row expandable config-row-alt0 notInherited">
659 <td class="micon"><a class="exi" href="#expand"> </a></td>
662 <a id="Roo.grid.CellSelectionModel-event-*selectionchange"></a>
664 <div class="fixedFont">
665 <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>)
671 <div class="short">Fires when the active selection changes.
677 Fires when the active selection changes.
683 <dl class="detailList">
684 <dt class="heading">Parameters:</dt>
687 <span class="fixedFont">SelectionModel</span> <b>this</b>
693 <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>
696 <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>
715 Roo.grid.CellSelectionModel
726 <!-- ============================== footer ================================= -->
727 <div class="fineprint" style="clear:both">
729 Documentation generated by <a href="http://www.akbkhome.com" target="_blankt">Introspection Doc Generator</a> on Fri Jul 16 2010 16:43:12 GMT+0800 (HKT)
731 <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a>