git.roojs.org Git - roojs1/blob - docs/symbols/Roo.grid.EditorGrid.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
   2
   3
   4 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
   5
   6         <head>
   7                 <meta http-equiv="content-type" content="text/html; charset=undefined" />
   8                 <meta name="generator" content="JsDoc Toolkit" />
   9
  10
  11                 <title>JsDoc Reference - Roo.grid.EditorGrid</title>
  12
  13
  14         <link rel="stylesheet" type="text/css" href="../../css/roojs.css" />
  15         <link rel="stylesheet" type="text/css" href="../default.css" />
  16
  17
  18         <script type="text/javascript" src="../page.js">
  19
  20         </script>
  21
  22
  23         </head>
  24
  25         <body onload="RooDocsPage.onload();">
  26
  27
  28 <div class="body-wrap">
  29
  30     <!-- ============================== links to methods. ================================= -->
  31
  32     <div class="top-tools">
  33     <!--
  34         <a class="inner-link" href="#Roo.grid.EditorGrid-props"><img src="resources/s.gif" class="item-icon icon-prop">Properties</a>
  35         <a class="inner-link" href="#Roo.grid.EditorGrid-methods"><img src="resources/s.gif" class="item-icon icon-method">Methods</a>
  36         <a class="inner-link" href="#Roo.grid.EditorGrid-events"><img src="resources/s.gif" class="item-icon icon-event">Events</a>
  37         <a class="inner-link" href="#Roo.grid.EditorGrid-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>
  39         -->
  40     </div>
  41
  42
  43 <!-- ============================== inheritance Block. ================================= -->
  44
  45                 <div class="inheritance res-block">
  46                    <pre class="res-block-inner"><a href="./Roo.grid.Grid.html#constructor" roo:cls="Roo.grid.Grid.html#constructor">Roo.grid.Grid</a>
  47 <img src="../../images/default/s.gif" height="1"  width="20"/><img class="elbow" src="../../images/default/tree/elbow-end.gif"/>Roo.grid.EditorGrid
  48
  49                    </pre>
  50                 </div>
  51
  52 <!-- ============================== class title / details ============================ -->
  53
  54
  55     <h1 class="classTitle">
  56
  57                                 Class Roo.grid.EditorGrid
  58                         </h1>
  59
  60     <table cellspacing="0" class="class-summary-table">
  61
  62                 <tr><td class="label">Package:</td><td class="hd-info">Roo.grid</td></tr>
  63
  64         <tr><td class="label">Defined In:</td><td class="hd-info">
  65
  66                                         <a href="./src/Roo_grid_EditorGrid.js.html">Roo/grid/EditorGrid.js</a>.
  67
  68         </td></tr>
  69         <tr><td class="label">Class:</td><td class="hd-info">EditorGrid</td></tr>
  70
  71
  72
  73
  74                 <tr><td class="label">Extends:</td><td class="hd-info">
  75                         <a href="./Roo.grid.Grid.html#constructor" roo:cls="Roo.grid.Grid.html#constructor">Roo.grid.Grid</a>
  76
  77                 </td></tr>
  78
  79
  80     </table>
  81
  82
  83 <!-- ============================== class summary ========================== -->
  84     <div class="description">
  85         Class for creating and editable grid.
  86     </div>
  87
  88
  89 <!-- ============================== Class comment block... ========================== -->
  90
  91 <div class="comments">
  92         <b>Class Comments / Notes</B> =>
  93         <u onclick="parent.CommentDialog.showCommentId = 'Roo.grid.EditorGrid';">[Add Your comment/notes about this class]</u>
  94         <br/>
  95         <iframe frameborder="0"  id="comments-Roo.grid" style="border: none;width:100%;"
  96                 src="/blog.php/GtkDjsComments/Roo.grid.EditorGrid.html"></iframe>
  97 </div>
  98
  99
 100
 101 <!-- ============================== config options ========================== -->
 102
 103
 104
 105
 106     <div class="hr"></div>
 107     <a id="Roo.grid.EditorGrid-configs"></a>
 108
 109
 110
 111
 112
 113       <table cellspacing="0" class="member-table">
 114       <caption>Config Options (Usually are also Properties)</caption>
 115
 116
 117         <tr>
 118             <th class="sig-header" colspan="2">Options</th>
 119
 120             <th class="msource-header">Defined By</th>
 121         </tr>
 122
 123
 124
 125
 126
 127                 <tr class="config-row expandable config-row-alt0 notInherited">
 128                    <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 129                     <td class="sig">
 130
 131                         <a id="Roo.grid.EditorGrid-cfg-clicksToEdit" name=".clicksToEdit"></a>
 132                         <div class="fixedFont">
 133                                 <b  class="itemname">clicksToEdit</b> : <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>
 134
 135
 136                         </div>
 137
 138                         <div class="mdesc">
 139                             <div class="short">The number of clicks on a cell required to display the cell's editor (defaults to 2)</div>
 140                         </div>
 141
 142                         <div class="mdesc">
 143                             <div class="long">The number of clicks on a cell required to display the cell's editor (defaults to 2)</div>
 144                         </div>
 145
 146
 147
 148                     </td>
 149                     <td class="msource">
 150
 151                         Roo.grid.EditorGrid
 152
 153                     </td>
 154                 </tr>
 155
 156
 157     </table>
 158
 159
 160
 161
 162
 163
 164
 165
 166
 167   <!-- ============================== public properties ==================== -->
 168
 169
 170
 171     <a id="Roo.grid.EditorGrid-props"></a>
 172
 173
 174
 175
 176
 177      <table cellspacing="0" class="member-table">
 178       <caption class="Empty">Public Properties - Has None</caption>
 179      </table>
 180
 181
 182
 183
 184   <!-- ============================== methods summary / details ======================== -->
 185
 186
 187   <a id="Roo.grid.EditorGrid-methods"></a>
 188         <!-- constructor?? -->
 189
 190         <!-- static's first
 191
 192
 193         -->
 194
 195         <!-- then dynamics first -->
 196
 197
 198
 199
 200
 201
 202       <table cellspacing="0" class="member-table">
 203       <caption>Public Methods</caption>
 204         <tr>
 205             <th class="sig-header" colspan="2">Method</th>
 206             <th class="msource-header">Defined By</th>
 207
 208         </tr>
 209
 210
 211
 212
 213
 214
 215
 216           <tr class="method-row config-row-alt0 expandable notInherited">
 217             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 218
 219
 220             <td class="sig">
 221                 <a id="Roo.grid-method-EditorGrid"   name=".EditorGrid"></a>
 222                 <div class="fixedFont">
 223                         <span class="attributes">new <B>Roo.grid.</B></span><b class="itemname">EditorGrid</b>
 224
 225                                  (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/HTMLElement/Roo.Element <B><i>container</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>dataSource</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>colModel</i></B>)
 226
 227
 228
 229                 </div>
 230                 <div class="mdesc">
 231
 232
 233                         <div class="short">Create a new Roo.grid.EditorGrid</div>
 234
 235
 236                     <div class="long">
 237
 238
 239
 240                                 Create a new Roo.grid.EditorGrid
 241
 242
 243                                 <dl class="detailList">
 244                                 <dt class="heading">Parameters:</dt>
 245
 246                                         <dt>
 247                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/HTMLElement/Roo.Element</span>  <b>container</b>
 248
 249                                         </dt>
 250                                         <dd>The element into which this grid will be rendered - <br/>The container MUST have some type of size defined for the grid to fill. The container will be <br/>automatically set to position relative if it isn't already.</dd>
 251
 252                                         <dt>
 253                                                 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span>  <b>dataSource</b>
 254
 255                                         </dt>
 256                                         <dd>The data model to bind to</dd>
 257
 258                                         <dt>
 259                                                 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span>  <b>colModel</b>
 260
 261                                         </dt>
 262                                         <dd>The column model with info about this grid's columns</dd>
 263
 264                                 </dl>
 265
 266
 267
 268
 269
 270
 271
 272
 273
 274
 275
 276                     </div>
 277                 </div>
 278
 279             </td>
 280             <td class="msource">
 281                 &nbsp;
 282             </td>
 283         </tr>
 284
 285
 286           <tr class="method-row config-row-alt1 expandable notInherited">
 287             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 288
 289
 290             <td class="sig">
 291                 <a id="Roo.grid.EditorGrid-method-startEditing"   name=".startEditing"></a>
 292                 <div class="fixedFont">
 293                         <span class="attributes"></span><b class="itemname">startEditing</b>
 294
 295                                  (<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>)
 296
 297
 298
 299                 </div>
 300                 <div class="mdesc">
 301
 302                    <div class="short">Starts editing the specified for the specified row/column</div>
 303
 304
 305
 306                     <div class="long">
 307
 308                                 Starts editing the specified for the specified row/column
 309
 310
 311
 312
 313
 314
 315                                 <dl class="detailList">
 316                                 <dt class="heading">Parameters:</dt>
 317
 318                                         <dt>
 319                                                 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span>  <b>rowIndex</b>
 320
 321                                         </dt>
 322                                         <dd></dd>
 323
 324                                         <dt>
 325                                                 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span>  <b>colIndex</b>
 326
 327                                         </dt>
 328                                         <dd></dd>
 329
 330                                 </dl>
 331
 332
 333
 334
 335
 336
 337
 338
 339
 340
 341
 342                     </div>
 343                 </div>
 344
 345             </td>
 346             <td class="msource">
 347
 348                         Roo.grid.EditorGrid
 349                 &nbsp;
 350             </td>
 351         </tr>
 352
 353
 354           <tr class="method-row config-row-alt0 expandable notInherited">
 355             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 356
 357
 358             <td class="sig">
 359                 <a id="Roo.grid.EditorGrid-method-stopEditing"   name=".stopEditing"></a>
 360                 <div class="fixedFont">
 361                         <span class="attributes"></span><b class="itemname">stopEditing</b>
 362
 363                                  ()
 364
 365
 366
 367                 </div>
 368                 <div class="mdesc">
 369
 370                    <div class="short">Stops any active editing</div>
 371
 372
 373
 374                     <div class="long">
 375
 376                                 Stops any active editing
 377
 378
 379
 380
 381
 382
 383
 384
 385
 386
 387
 388
 389
 390
 391
 392
 393                     </div>
 394                 </div>
 395
 396             </td>
 397             <td class="msource">
 398
 399                         Roo.grid.EditorGrid
 400                 &nbsp;
 401             </td>
 402         </tr>
 403
 404
 405     </table>
 406
 407
 408   <!-- ============================== events summary / details ======================== -->
 409
 410
 411   <a id="Roo.grid.EditorGrid-events"></a>
 412
 413
 414
 415
 416
 417
 418
 419
 420       <table cellspacing="0" class="member-table">
 421                 <caption>Events</caption>
 422               <thead>
 423                 <tr>
 424                     <th class="sig-header" colspan="2">Event</th>
 425                     <th class="msource-header">Defined By</th>
 426
 427                 </tr>
 428               </thead>
 429
 430
 431
 432
 433
 434           <tr class="method-row expandable config-row-alt0 notInherited">
 435             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 436
 437             <td class="sig">
 438                 <a id="Roo.grid.EditorGrid-event-*afteredit"></a>
 439
 440                <div class="fixedFont">
 441                 <b class="itemname">afteredit</b> (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>e</i></B>)
 442
 443                 </div>
 444
 445                 <div class="mdesc">
 446
 447                    <div class="short">Fires after a cell is edited.
 448
 449                 </div>
 450
 451                     <div class="long">
 452
 453                         Fires after a cell is edited. <br /><br/><ul style="padding:5px;padding-left:16px;"><br/><li>grid - This grid</li><br/><li>record - The record being edited</li><br/><li>field - The field name being edited</li><br/><li>value - The value being set</li><br/><li>originalValue - The original value for the field, before the edit.</li><br/><li>row - The grid row index</li><br/><li>column - The grid column index</li><br/></ul>
 454
 455
 456
 457
 458
 459                                 <dl class="detailList">
 460                                 <dt class="heading">Parameters:</dt>
 461
 462                                         <dt>
 463                                                 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span> <b>e</b>
 464
 465                                         </dt>
 466                                         <dd>An edit event (see above for description)</dd>
 467
 468                                 </dl>
 469
 470
 471
 472
 473
 474
 475
 476
 477
 478
 479
 480                     </div>
 481                 </div>
 482
 483             </td>
 484             <td class="msource">
 485                 Roo.grid.EditorGrid
 486             </td>
 487         </tr>
 488
 489           <tr class="method-row expandable config-row-alt1 notInherited">
 490             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 491
 492             <td class="sig">
 493                 <a id="Roo.grid.EditorGrid-event-*beforeedit"></a>
 494
 495                <div class="fixedFont">
 496                 <b class="itemname">beforeedit</b> (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>e</i></B>)
 497
 498                 </div>
 499
 500                 <div class="mdesc">
 501
 502                    <div class="short">Fires before cell editing is triggered.
 503
 504                 </div>
 505
 506                     <div class="long">
 507
 508                         Fires before cell editing is triggered. The edit event object has the following properties <br /><br/><ul style="padding:5px;padding-left:16px;"><br/><li>grid - This grid</li><br/><li>record - The record being edited</li><br/><li>field - The field name being edited</li><br/><li>value - The value for the field being edited.</li><br/><li>row - The grid row index</li><br/><li>column - The grid column index</li><br/><li>cancel - Set this to true to cancel the edit or return false from your handler.</li><br/></ul>
 509
 510
 511
 512
 513
 514                                 <dl class="detailList">
 515                                 <dt class="heading">Parameters:</dt>
 516
 517                                         <dt>
 518                                                 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span> <b>e</b>
 519
 520                                         </dt>
 521                                         <dd>An edit event (see above for description)</dd>
 522
 523                                 </dl>
 524
 525
 526
 527
 528
 529
 530
 531
 532
 533
 534
 535                     </div>
 536                 </div>
 537
 538             </td>
 539             <td class="msource">
 540                 Roo.grid.EditorGrid
 541             </td>
 542         </tr>
 543
 544           <tr class="method-row expandable config-row-alt0 notInherited">
 545             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 546
 547             <td class="sig">
 548                 <a id="Roo.grid.EditorGrid-event-*validateedit"></a>
 549
 550                <div class="fixedFont">
 551                 <b class="itemname">validateedit</b> (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>e</i></B>)
 552
 553                 </div>
 554
 555                 <div class="mdesc">
 556
 557                    <div class="short">Fires after a cell is edited, but before the value is set in the record.
 558
 559                 </div>
 560
 561                     <div class="long">
 562
 563                         Fires after a cell is edited, but before the value is set in the record. <br/>You can use this to modify the value being set in the field, Return false<br/>to cancel the change. The edit event object has the following properties <br /><br/><ul style="padding:5px;padding-left:16px;"><br/><li>editor - This editor</li><br/><li>grid - This grid</li><br/><li>record - The record being edited</li><br/><li>field - The field name being edited</li><br/><li>value - The value being set</li><br/><li>originalValue - The original value for the field, before the edit.</li><br/><li>row - The grid row index</li><br/><li>column - The grid column index</li><br/><li>cancel - Set this to true to cancel the edit or return false from your handler.</li><br/></ul>
 564
 565
 566
 567
 568
 569                                 <dl class="detailList">
 570                                 <dt class="heading">Parameters:</dt>
 571
 572                                         <dt>
 573                                                 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span> <b>e</b>
 574
 575                                         </dt>
 576                                         <dd>An edit event (see above for description)</dd>
 577
 578                                 </dl>
 579
 580
 581
 582
 583
 584
 585
 586
 587
 588
 589
 590                     </div>
 591                 </div>
 592
 593             </td>
 594             <td class="msource">
 595                 Roo.grid.EditorGrid
 596             </td>
 597         </tr>
 598
 599
 600     </table>
 601
 602
 603
 604
 605
 606 <!-- ============================== footer ================================= -->
 607                 <div class="fineprint" style="clear:both">
 608
 609                         Documentation generated by <a href="http://www.akbkhome.com" target="_blankt">Introspection Doc Generator</a>  on Fri Jul 16 2010 15:55:28 GMT+0800 (HKT)
 610                         Based on
 611                         <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a>
 612                 </div>
 613         </body>
 614 </html>