git.roojs.org Git - roojs1/blob - docs/symbols/Roo.grid.PropertyGrid.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.PropertyGrid</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.PropertyGrid-props"><img src="resources/s.gif" class="item-icon icon-prop">Properties</a>
  35         <a class="inner-link" href="#Roo.grid.PropertyGrid-methods"><img src="resources/s.gif" class="item-icon icon-method">Methods</a>
  36         <a class="inner-link" href="#Roo.grid.PropertyGrid-events"><img src="resources/s.gif" class="item-icon icon-event">Events</a>
  37         <a class="inner-link" href="#Roo.grid.PropertyGrid-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.EditorGrid.html#constructor" roo:cls="Roo.grid.EditorGrid.html#constructor">Roo.grid.EditorGrid</a>
  47 <img src="../../images/default/s.gif" height="1"  width="20"/><img class="elbow" src="../../images/default/tree/elbow-end.gif"/>Roo.grid.PropertyGrid
  48
  49                    </pre>
  50                 </div>
  51
  52 <!-- ============================== class title / details ============================ -->
  53
  54
  55     <h1 class="classTitle">
  56
  57                                 Class Roo.grid.PropertyGrid
  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_PropertyGrid.js.html">Roo/grid/PropertyGrid.js</a>.
  67
  68         </td></tr>
  69         <tr><td class="label">Class:</td><td class="hd-info">PropertyGrid</td></tr>
  70
  71
  72
  73
  74                 <tr><td class="label">Extends:</td><td class="hd-info">
  75                         <a href="./Roo.grid.EditorGrid.html#constructor" roo:cls="Roo.grid.EditorGrid.html#constructor">Roo.grid.EditorGrid</a>
  76
  77                 </td></tr>
  78
  79
  80     </table>
  81
  82
  83 <!-- ============================== class summary ========================== -->
  84     <div class="description">
  85         This class represents the  interface of a component based property grid control.<br/><br><br>Usage:<pre><code><br/> var grid = new Roo.grid.PropertyGrid("my-container-id", {<br/>      <br/> });<br/> // set any options<br/> grid.render();<br/></code></pre>
  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.PropertyGrid';">[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.PropertyGrid.html"></iframe>
  97 </div>
  98
  99
 100
 101 <!-- ============================== config options ========================== -->
 102
 103
 104
 105
 106     <div class="hr"></div>
 107     <a id="Roo.grid.PropertyGrid-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.PropertyGrid-cfg-customEditors" name=".customEditors"></a>
 132                         <div class="fixedFont">
 133                                 <b  class="itemname">customEditors</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a>
 134
 135
 136                         </div>
 137
 138                         <div class="mdesc">
 139                             <div class="short">map of colnames=> custom editors.</div>
 140                         </div>
 141
 142                         <div class="mdesc">
 143                             <div class="long">map of colnames=> custom editors.<br/>the custom editor can be one of the standard ones (date|string|number|int|boolean), or a<br/>grid editor eg. Roo.grid.GridEditor(new Roo.form.TextArea({selectOnFocus:true})),<br/>false disables editing of the field.</div>
 144                         </div>
 145
 146
 147
 148                     </td>
 149                     <td class="msource">
 150
 151                         Roo.grid.PropertyGrid
 152
 153                     </td>
 154                 </tr>
 155
 156
 157                 <tr class="config-row expandable config-row-alt1 notInherited">
 158                    <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 159                     <td class="sig">
 160
 161                         <a id="Roo.grid.PropertyGrid-cfg-propertyNames" name=".propertyNames"></a>
 162                         <div class="fixedFont">
 163                                 <b  class="itemname">propertyNames</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a>
 164
 165
 166                         </div>
 167
 168                         <div class="mdesc">
 169                             <div class="short">map of property Names to their displayed value</div>
 170                         </div>
 171
 172                         <div class="mdesc">
 173                             <div class="long">map of property Names to their displayed value</div>
 174                         </div>
 175
 176
 177
 178                     </td>
 179                     <td class="msource">
 180
 181                         Roo.grid.PropertyGrid
 182
 183                     </td>
 184                 </tr>
 185
 186
 187     </table>
 188
 189
 190
 191
 192
 193
 194
 195
 196
 197   <!-- ============================== public properties ==================== -->
 198
 199
 200
 201     <a id="Roo.grid.PropertyGrid-props"></a>
 202
 203
 204
 205
 206
 207      <table cellspacing="0" class="member-table">
 208       <caption class="Empty">Public Properties - Has None</caption>
 209      </table>
 210
 211
 212
 213
 214   <!-- ============================== methods summary / details ======================== -->
 215
 216
 217   <a id="Roo.grid.PropertyGrid-methods"></a>
 218         <!-- constructor?? -->
 219
 220         <!-- static's first
 221
 222
 223         -->
 224
 225         <!-- then dynamics first -->
 226
 227
 228
 229
 230
 231
 232       <table cellspacing="0" class="member-table">
 233       <caption>Public Methods</caption>
 234         <tr>
 235             <th class="sig-header" colspan="2">Method</th>
 236             <th class="msource-header">Defined By</th>
 237
 238         </tr>
 239
 240
 241
 242
 243
 244
 245
 246           <tr class="method-row config-row-alt0 expandable notInherited">
 247             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 248
 249
 250             <td class="sig">
 251                 <a id="Roo.grid-method-PropertyGrid"   name=".PropertyGrid"></a>
 252                 <div class="fixedFont">
 253                         <span class="attributes">new <B>Roo.grid.</B></span><b class="itemname">PropertyGrid</b>
 254
 255                                  (<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>config</i></B>)
 256
 257
 258
 259                 </div>
 260                 <div class="mdesc">
 261
 262
 263                         <div class="short">Create a new Roo.grid.PropertyGrid</div>
 264
 265
 266                     <div class="long">
 267
 268
 269
 270                                 Create a new Roo.grid.PropertyGrid
 271
 272
 273                                 <dl class="detailList">
 274                                 <dt class="heading">Parameters:</dt>
 275
 276                                         <dt>
 277                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/HTMLElement/Roo.Element</span>  <b>container</b>
 278
 279                                         </dt>
 280                                         <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>
 281
 282                                         <dt>
 283                                                 <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>
 284
 285                                         </dt>
 286                                         <dd>A config object that sets properties on this grid.</dd>
 287
 288                                 </dl>
 289
 290
 291
 292
 293
 294
 295
 296
 297
 298
 299
 300                     </div>
 301                 </div>
 302
 303             </td>
 304             <td class="msource">
 305                 &nbsp;
 306             </td>
 307         </tr>
 308
 309
 310           <tr class="method-row config-row-alt1 expandable notInherited">
 311             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 312
 313
 314             <td class="sig">
 315                 <a id="Roo.grid.PropertyGrid-method-getSource"   name=".getSource"></a>
 316                 <div class="fixedFont">
 317                         <span class="attributes"></span><b class="itemname">getSource</b>
 318
 319                                  ()
 320
 321
 322                                          :
 323
 324
 325                                                 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a>
 326
 327
 328
 329
 330
 331                 </div>
 332                 <div class="mdesc">
 333
 334                    <div class="short">Gets all the data from the grid.</div>
 335
 336
 337
 338                     <div class="long">
 339
 340                                 Gets all the data from the grid.
 341
 342
 343
 344
 345
 346
 347
 348
 349
 350
 351                                 <dl class="detailList">
 352                                 <dt class="heading">Returns:</dt>
 353
 354                                         <dd><span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span>  data  data stored in grid</dd>
 355
 356                                 </dl>
 357
 358
 359
 360
 361
 362
 363
 364                     </div>
 365                 </div>
 366
 367             </td>
 368             <td class="msource">
 369
 370                         Roo.grid.PropertyGrid
 371                 &nbsp;
 372             </td>
 373         </tr>
 374
 375
 376           <tr class="method-row config-row-alt0 expandable notInherited">
 377             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 378
 379
 380             <td class="sig">
 381                 <a id="Roo.grid.PropertyGrid-method-setSource"   name=".setSource"></a>
 382                 <div class="fixedFont">
 383                         <span class="attributes"></span><b class="itemname">setSource</b>
 384
 385                                  (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>data</i></B>)
 386
 387
 388
 389                 </div>
 390                 <div class="mdesc">
 391
 392                    <div class="short">Sets the data for the Grid<br/>accepts a Key => Value object of all the elements avaiable.</div>
 393
 394
 395
 396                     <div class="long">
 397
 398                                 Sets the data for the Grid<br/>accepts a Key => Value object of all the elements avaiable.
 399
 400
 401
 402
 403
 404
 405                                 <dl class="detailList">
 406                                 <dt class="heading">Parameters:</dt>
 407
 408                                         <dt>
 409                                                 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span>  <b>data</b>
 410
 411                                         </dt>
 412                                         <dd>to appear in grid.</dd>
 413
 414                                 </dl>
 415
 416
 417
 418
 419
 420
 421
 422
 423
 424
 425
 426                     </div>
 427                 </div>
 428
 429             </td>
 430             <td class="msource">
 431
 432                         Roo.grid.PropertyGrid
 433                 &nbsp;
 434             </td>
 435         </tr>
 436
 437
 438     </table>
 439
 440
 441   <!-- ============================== events summary / details ======================== -->
 442
 443
 444   <a id="Roo.grid.PropertyGrid-events"></a>
 445
 446
 447
 448
 449
 450
 451
 452
 453       <table cellspacing="0" class="member-table">
 454                 <caption>Events</caption>
 455               <thead>
 456                 <tr>
 457                     <th class="sig-header" colspan="2">Event</th>
 458                     <th class="msource-header">Defined By</th>
 459
 460                 </tr>
 461               </thead>
 462
 463
 464
 465
 466
 467           <tr class="method-row expandable config-row-alt0 notInherited">
 468             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 469
 470             <td class="sig">
 471                 <a id="Roo.grid.PropertyGrid-event-*beforepropertychange"></a>
 472
 473                <div class="fixedFont">
 474                 <b class="itemname">beforepropertychange</b> (<a href="./Roo.grid.PropertyGrid.html#constructor" roo:cls="Roo.grid.PropertyGrid.html#constructor">Roo.grid.PropertyGrid</a> <B><i>grid</i></B>, <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>id</i></B>, <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>newval</i></B>, <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>oldval</i></B>)
 475
 476                 </div>
 477
 478                 <div class="mdesc">
 479
 480                    <div class="short">Fires before a property changes (return false to stop?)
 481
 482                 </div>
 483
 484                     <div class="long">
 485
 486                         Fires before a property changes (return false to stop?)
 487
 488
 489
 490
 491
 492                                 <dl class="detailList">
 493                                 <dt class="heading">Parameters:</dt>
 494
 495                                         <dt>
 496                                                 <span class="fixedFont"><a href="./Roo.grid.PropertyGrid.html#constructor" roo:cls="Roo.grid.PropertyGrid.html#constructor">Roo.grid.PropertyGrid</a></span> <b>grid</b>
 497
 498                                         </dt>
 499                                         <dd>property grid? (check could be store)</dd>
 500
 501                                         <dt>
 502                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>id</b>
 503
 504                                         </dt>
 505                                         <dd>Record Id</dd>
 506
 507                                         <dt>
 508                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>newval</b>
 509
 510                                         </dt>
 511                                         <dd>New Value</dd>
 512
 513                                         <dt>
 514                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>oldval</b>
 515
 516                                         </dt>
 517                                         <dd>Old Value</dd>
 518
 519                                 </dl>
 520
 521
 522
 523
 524
 525
 526
 527
 528
 529
 530
 531                     </div>
 532                 </div>
 533
 534             </td>
 535             <td class="msource">
 536                 Roo.grid.PropertyGrid
 537             </td>
 538         </tr>
 539
 540           <tr class="method-row expandable config-row-alt1 notInherited">
 541             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 542
 543             <td class="sig">
 544                 <a id="Roo.grid.PropertyGrid-event-*propertychange"></a>
 545
 546                <div class="fixedFont">
 547                 <b class="itemname">propertychange</b> (<a href="./Roo.grid.PropertyGrid.html#constructor" roo:cls="Roo.grid.PropertyGrid.html#constructor">Roo.grid.PropertyGrid</a> <B><i>grid</i></B>, <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>id</i></B>, <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>newval</i></B>, <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>oldval</i></B>)
 548
 549                 </div>
 550
 551                 <div class="mdesc">
 552
 553                    <div class="short">Fires after a property changes
 554
 555                 </div>
 556
 557                     <div class="long">
 558
 559                         Fires after a property changes
 560
 561
 562
 563
 564
 565                                 <dl class="detailList">
 566                                 <dt class="heading">Parameters:</dt>
 567
 568                                         <dt>
 569                                                 <span class="fixedFont"><a href="./Roo.grid.PropertyGrid.html#constructor" roo:cls="Roo.grid.PropertyGrid.html#constructor">Roo.grid.PropertyGrid</a></span> <b>grid</b>
 570
 571                                         </dt>
 572                                         <dd>property grid? (check could be store)</dd>
 573
 574                                         <dt>
 575                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>id</b>
 576
 577                                         </dt>
 578                                         <dd>Record Id</dd>
 579
 580                                         <dt>
 581                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>newval</b>
 582
 583                                         </dt>
 584                                         <dd>New Value</dd>
 585
 586                                         <dt>
 587                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>oldval</b>
 588
 589                                         </dt>
 590                                         <dd>Old Value</dd>
 591
 592                                 </dl>
 593
 594
 595
 596
 597
 598
 599
 600
 601
 602
 603
 604                     </div>
 605                 </div>
 606
 607             </td>
 608             <td class="msource">
 609                 Roo.grid.PropertyGrid
 610             </td>
 611         </tr>
 612
 613
 614     </table>
 615
 616
 617
 618
 619
 620 <!-- ============================== footer ================================= -->
 621                 <div class="fineprint" style="clear:both">
 622
 623                         Documentation generated by <a href="http://www.akbkhome.com" target="_blankt">Introspection Doc Generator</a>  on Fri Jul 16 2010 19:32:56 GMT+0800 (HKT)
 624                         Based on
 625                         <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a>
 626                 </div>
 627         </body>
 628 </html>