git.roojs.org Git - roojs1/blob - docs/symbols/Roo.Editor.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.Editor</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.Editor-props"><img src="resources/s.gif" class="item-icon icon-prop">Properties</a>
  35         <a class="inner-link" href="#Roo.Editor-methods"><img src="resources/s.gif" class="item-icon icon-method">Methods</a>
  36         <a class="inner-link" href="#Roo.Editor-events"><img src="resources/s.gif" class="item-icon icon-event">Events</a>
  37         <a class="inner-link" href="#Roo.Editor-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.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
  47 <img src="../../images/default/s.gif" height="1"  width="20"/><img class="elbow" src="../../images/default/tree/elbow-end.gif"/>Roo.Editor
  48
  49                    </pre>
  50                 </div>
  51
  52 <!-- ============================== class title / details ============================ -->
  53
  54
  55     <h1 class="classTitle">
  56
  57                                 Class Roo.Editor
  58                         </h1>
  59
  60     <table cellspacing="0" class="class-summary-table">
  61
  62                 <tr><td class="label">Package:</td><td class="hd-info">Roo</td></tr>
  63
  64         <tr><td class="label">Defined In:</td><td class="hd-info">
  65
  66                                         <a href="./src/Roo_Editor.js.html">Roo/Editor.js</a>.
  67
  68         </td></tr>
  69         <tr><td class="label">Class:</td><td class="hd-info">Editor</td></tr>
  70
  71
  72
  73
  74                 <tr><td class="label">Extends:</td><td class="hd-info">
  75                         <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
  76
  77                 </td></tr>
  78
  79
  80     </table>
  81
  82
  83 <!-- ============================== class summary ========================== -->
  84     <div class="description">
  85         A base editor field that handles displaying/hiding on demand and has some built-in sizing and event handling logic.
  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.Editor';">[Add Your comment/notes about this class]</u>
  94         <br/>
  95         <iframe frameborder="0"  id="comments-Roo" style="border: none;width:100%;"
  96                 src="/blog.php/GtkDjsComments/Roo.Editor.html"></iframe>
  97 </div>
  98
  99
 100
 101 <!-- ============================== config options ========================== -->
 102
 103
 104
 105
 106     <div class="hr"></div>
 107     <a id="Roo.Editor-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.Editor-cfg-alignment" name=".alignment"></a>
 132                         <div class="fixedFont">
 133                                 <b  class="itemname">alignment</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
 134
 135
 136                         </div>
 137
 138                         <div class="mdesc">
 139                             <div class="short">The position to align to (see {<b>link</b> Roo.Element<b>alignTo</b>} for more details, defaults to "c-c?").</div>
 140                         </div>
 141
 142                         <div class="mdesc">
 143                             <div class="long">The position to align to (see {<b>link</b> Roo.Element<b>alignTo</b>} for more details, defaults to "c-c?").</div>
 144                         </div>
 145
 146
 147
 148                     </td>
 149                     <td class="msource">
 150
 151                         Roo.Editor
 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.Editor-cfg-autosize" name=".autosize"></a>
 162                         <div class="fixedFont">
 163                                 <b  class="itemname">autosize</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>/String
 164
 165
 166                         </div>
 167
 168                         <div class="mdesc">
 169                             <div class="short">True for the editor to automatically adopt the size of the underlying field, "width" to adopt the width only,<br/>or "height" to adopt the height only (defaults to false)</div>
 170                         </div>
 171
 172                         <div class="mdesc">
 173                             <div class="long">True for the editor to automatically adopt the size of the underlying field, "width" to adopt the width only,<br/>or "height" to adopt the height only (defaults to false)</div>
 174                         </div>
 175
 176
 177
 178                     </td>
 179                     <td class="msource">
 180
 181                         Roo.Editor
 182
 183                     </td>
 184                 </tr>
 185
 186
 187                 <tr class="config-row expandable config-row-alt0 notInherited">
 188                    <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 189                     <td class="sig">
 190
 191                         <a id="Roo.Editor-cfg-cancelOnEsc" name=".cancelOnEsc"></a>
 192                         <div class="fixedFont">
 193                                 <b  class="itemname">cancelOnEsc</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
 194
 195
 196                         </div>
 197
 198                         <div class="mdesc">
 199                             <div class="short">True to cancel the edit when the escape key is pressed (defaults to false)</div>
 200                         </div>
 201
 202                         <div class="mdesc">
 203                             <div class="long">True to cancel the edit when the escape key is pressed (defaults to false)</div>
 204                         </div>
 205
 206
 207
 208                     </td>
 209                     <td class="msource">
 210
 211                         Roo.Editor
 212
 213                     </td>
 214                 </tr>
 215
 216
 217                 <tr class="config-row expandable config-row-alt1 notInherited">
 218                    <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 219                     <td class="sig">
 220
 221                         <a id="Roo.Editor-cfg-completeOnEnter" name=".completeOnEnter"></a>
 222                         <div class="fixedFont">
 223                                 <b  class="itemname">completeOnEnter</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
 224
 225
 226                         </div>
 227
 228                         <div class="mdesc">
 229                             <div class="short">True to complete the edit when the enter key is pressed (defaults to false)</div>
 230                         </div>
 231
 232                         <div class="mdesc">
 233                             <div class="long">True to complete the edit when the enter key is pressed (defaults to false)</div>
 234                         </div>
 235
 236
 237
 238                     </td>
 239                     <td class="msource">
 240
 241                         Roo.Editor
 242
 243                     </td>
 244                 </tr>
 245
 246
 247                 <tr class="config-row expandable config-row-alt0 notInherited">
 248                    <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 249                     <td class="sig">
 250
 251                         <a id="Roo.Editor-cfg-constrain" name=".constrain"></a>
 252                         <div class="fixedFont">
 253                                 <b  class="itemname">constrain</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
 254
 255
 256                         </div>
 257
 258                         <div class="mdesc">
 259                             <div class="short">True to constrain the editor to the viewport</div>
 260                         </div>
 261
 262                         <div class="mdesc">
 263                             <div class="long">True to constrain the editor to the viewport</div>
 264                         </div>
 265
 266
 267
 268                     </td>
 269                     <td class="msource">
 270
 271                         Roo.Editor
 272
 273                     </td>
 274                 </tr>
 275
 276
 277                 <tr class="config-row expandable config-row-alt1 notInherited">
 278                    <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 279                     <td class="sig">
 280
 281                         <a id="Roo.Editor-cfg-hideEl" name=".hideEl"></a>
 282                         <div class="fixedFont">
 283                                 <b  class="itemname">hideEl</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
 284
 285
 286                         </div>
 287
 288                         <div class="mdesc">
 289                             <div class="short">False to keep the bound element visible while the editor is displayed (defaults to true)</div>
 290                         </div>
 291
 292                         <div class="mdesc">
 293                             <div class="long">False to keep the bound element visible while the editor is displayed (defaults to true)</div>
 294                         </div>
 295
 296
 297
 298                     </td>
 299                     <td class="msource">
 300
 301                         Roo.Editor
 302
 303                     </td>
 304                 </tr>
 305
 306
 307                 <tr class="config-row expandable config-row-alt0 notInherited">
 308                    <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 309                     <td class="sig">
 310
 311                         <a id="Roo.Editor-cfg-ignoreNoChange" name=".ignoreNoChange"></a>
 312                         <div class="fixedFont">
 313                                 <b  class="itemname">ignoreNoChange</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
 314
 315
 316                         </div>
 317
 318                         <div class="mdesc">
 319                             <div class="short">True to skip the the edit completion process (no save, no events fired) if the user completes an edit and<br/>the value has not changed (defaults to false).</div>
 320                         </div>
 321
 322                         <div class="mdesc">
 323                             <div class="long">True to skip the the edit completion process (no save, no events fired) if the user completes an edit and<br/>the value has not changed (defaults to false).  Applies only to string values - edits for other data types<br/>will never be ignored.</div>
 324                         </div>
 325
 326
 327
 328                     </td>
 329                     <td class="msource">
 330
 331                         Roo.Editor
 332
 333                     </td>
 334                 </tr>
 335
 336
 337                 <tr class="config-row expandable config-row-alt1 notInherited">
 338                    <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 339                     <td class="sig">
 340
 341                         <a id="Roo.Editor-cfg-revertInvalid" name=".revertInvalid"></a>
 342                         <div class="fixedFont">
 343                                 <b  class="itemname">revertInvalid</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
 344
 345
 346                         </div>
 347
 348                         <div class="mdesc">
 349                             <div class="short">True to automatically revert the field value and cancel the edit when the user completes an edit and the field<br/>validation fails (defaults to true)</div>
 350                         </div>
 351
 352                         <div class="mdesc">
 353                             <div class="long">True to automatically revert the field value and cancel the edit when the user completes an edit and the field<br/>validation fails (defaults to true)</div>
 354                         </div>
 355
 356
 357
 358                     </td>
 359                     <td class="msource">
 360
 361                         Roo.Editor
 362
 363                     </td>
 364                 </tr>
 365
 366
 367                 <tr class="config-row expandable config-row-alt0 notInherited">
 368                    <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 369                     <td class="sig">
 370
 371                         <a id="Roo.Editor-cfg-shadow" name=".shadow"></a>
 372                         <div class="fixedFont">
 373                                 <b  class="itemname">shadow</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>/String
 374
 375
 376                         </div>
 377
 378                         <div class="mdesc">
 379                             <div class="short">"sides" for sides/bottom only, "frame" for 4-way shadow, and "drop"<br/>for bottom-right shadow (defaults to "frame")</div>
 380                         </div>
 381
 382                         <div class="mdesc">
 383                             <div class="long">"sides" for sides/bottom only, "frame" for 4-way shadow, and "drop"<br/>for bottom-right shadow (defaults to "frame")</div>
 384                         </div>
 385
 386
 387
 388                     </td>
 389                     <td class="msource">
 390
 391                         Roo.Editor
 392
 393                     </td>
 394                 </tr>
 395
 396
 397                 <tr class="config-row expandable config-row-alt1 notInherited">
 398                    <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 399                     <td class="sig">
 400
 401                         <a id="Roo.Editor-cfg-updateEl" name=".updateEl"></a>
 402                         <div class="fixedFont">
 403                                 <b  class="itemname">updateEl</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
 404
 405
 406                         </div>
 407
 408                         <div class="mdesc">
 409                             <div class="short">True to update the innerHTML of the bound element when the update completes (defaults to false)</div>
 410                         </div>
 411
 412                         <div class="mdesc">
 413                             <div class="long">True to update the innerHTML of the bound element when the update completes (defaults to false)</div>
 414                         </div>
 415
 416
 417
 418                     </td>
 419                     <td class="msource">
 420
 421                         Roo.Editor
 422
 423                     </td>
 424                 </tr>
 425
 426
 427                 <tr class="config-row expandable config-row-alt0 notInherited">
 428                    <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 429                     <td class="sig">
 430
 431                         <a id="Roo.Editor-cfg-value" name=".value"></a>
 432                         <div class="fixedFont">
 433                                 <b  class="itemname">value</b> : Mixed
 434
 435
 436                         </div>
 437
 438                         <div class="mdesc">
 439                             <div class="short">The data value of the underlying field (defaults to "")</div>
 440                         </div>
 441
 442                         <div class="mdesc">
 443                             <div class="long">The data value of the underlying field (defaults to "")</div>
 444                         </div>
 445
 446
 447
 448                     </td>
 449                     <td class="msource">
 450
 451                         Roo.Editor
 452
 453                     </td>
 454                 </tr>
 455
 456
 457     </table>
 458
 459
 460
 461
 462
 463
 464
 465
 466
 467   <!-- ============================== public properties ==================== -->
 468
 469
 470
 471     <a id="Roo.Editor-props"></a>
 472
 473
 474
 475
 476
 477      <table cellspacing="0" class="member-table">
 478       <caption class="Empty">Public Properties - Has None</caption>
 479      </table>
 480
 481
 482
 483
 484   <!-- ============================== methods summary / details ======================== -->
 485
 486
 487   <a id="Roo.Editor-methods"></a>
 488         <!-- constructor?? -->
 489
 490         <!-- static's first
 491
 492
 493         -->
 494
 495         <!-- then dynamics first -->
 496
 497
 498
 499
 500
 501
 502       <table cellspacing="0" class="member-table">
 503       <caption>Public Methods</caption>
 504         <tr>
 505             <th class="sig-header" colspan="2">Method</th>
 506             <th class="msource-header">Defined By</th>
 507
 508         </tr>
 509
 510
 511
 512
 513
 514
 515
 516           <tr class="method-row config-row-alt0 expandable notInherited">
 517             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 518
 519
 520             <td class="sig">
 521                 <a id="Roo-method-Editor"   name=".Editor"></a>
 522                 <div class="fixedFont">
 523                         <span class="attributes">new <B>Roo.</B></span><b class="itemname">Editor</b>
 524
 525                                  (<a href="./Roo.form.Field.html#constructor" roo:cls="Roo.form.Field.html#constructor">Roo.form.Field</a> <B><i>field</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>)
 526
 527
 528
 529                 </div>
 530                 <div class="mdesc">
 531
 532
 533                         <div class="short">Create a new Roo.Editor</div>
 534
 535
 536                     <div class="long">
 537
 538
 539
 540                                 Create a new Roo.Editor
 541
 542
 543                                 <dl class="detailList">
 544                                 <dt class="heading">Parameters:</dt>
 545
 546                                         <dt>
 547                                                 <span class="fixedFont"><a href="./Roo.form.Field.html#constructor" roo:cls="Roo.form.Field.html#constructor">Roo.form.Field</a></span>  <b>field</b>
 548
 549                                         </dt>
 550                                         <dd>The Field object (or descendant)</dd>
 551
 552                                         <dt>
 553                                                 <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>
 554
 555                                         </dt>
 556                                         <dd>The config object</dd>
 557
 558                                 </dl>
 559
 560
 561
 562
 563
 564
 565
 566
 567
 568
 569
 570                     </div>
 571                 </div>
 572
 573             </td>
 574             <td class="msource">
 575                 &nbsp;
 576             </td>
 577         </tr>
 578
 579
 580           <tr class="method-row config-row-alt1 expandable notInherited">
 581             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 582
 583
 584             <td class="sig">
 585                 <a id="Roo.Editor-method-cancelEdit"   name=".cancelEdit"></a>
 586                 <div class="fixedFont">
 587                         <span class="attributes"></span><b class="itemname">cancelEdit</b>
 588
 589                                  (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a> <B><i>remainVisible</i></B>)
 590
 591
 592
 593                 </div>
 594                 <div class="mdesc">
 595
 596                    <div class="short">Cancels the editing process and hides the editor without persisting any changes.</div>
 597
 598
 599
 600                     <div class="long">
 601
 602                                 Cancels the editing process and hides the editor without persisting any changes.  The field value will be<br/>reverted to the original starting value.
 603
 604
 605
 606
 607
 608
 609                                 <dl class="detailList">
 610                                 <dt class="heading">Parameters:</dt>
 611
 612                                         <dt>
 613                                                 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span>  <b>remainVisible</b>
 614
 615                                         </dt>
 616                                         <dd>Override the default behavior and keep the editor visible after<br/>cancel (defaults to false)</dd>
 617
 618                                 </dl>
 619
 620
 621
 622
 623
 624
 625
 626
 627
 628
 629
 630                     </div>
 631                 </div>
 632
 633             </td>
 634             <td class="msource">
 635
 636                         Roo.Editor
 637                 &nbsp;
 638             </td>
 639         </tr>
 640
 641
 642           <tr class="method-row config-row-alt0 expandable notInherited">
 643             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 644
 645
 646             <td class="sig">
 647                 <a id="Roo.Editor-method-completeEdit"   name=".completeEdit"></a>
 648                 <div class="fixedFont">
 649                         <span class="attributes"></span><b class="itemname">completeEdit</b>
 650
 651                                  (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a> <B><i>remainVisible</i></B>)
 652
 653
 654
 655                 </div>
 656                 <div class="mdesc">
 657
 658                    <div class="short">Ends the editing process, persists the changed value to the underlying field, and hides the editor.</div>
 659
 660
 661
 662                     <div class="long">
 663
 664                                 Ends the editing process, persists the changed value to the underlying field, and hides the editor.
 665
 666
 667
 668
 669
 670
 671                                 <dl class="detailList">
 672                                 <dt class="heading">Parameters:</dt>
 673
 674                                         <dt>
 675                                                 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span>  <b>remainVisible</b>
 676
 677                                         </dt>
 678                                         <dd>Override the default behavior and keep the editor visible after edit (defaults to false)</dd>
 679
 680                                 </dl>
 681
 682
 683
 684
 685
 686
 687
 688
 689
 690
 691
 692                     </div>
 693                 </div>
 694
 695             </td>
 696             <td class="msource">
 697
 698                         Roo.Editor
 699                 &nbsp;
 700             </td>
 701         </tr>
 702
 703
 704           <tr class="method-row config-row-alt1 expandable notInherited">
 705             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 706
 707
 708             <td class="sig">
 709                 <a id="Roo.Editor-method-getValue"   name=".getValue"></a>
 710                 <div class="fixedFont">
 711                         <span class="attributes"></span><b class="itemname">getValue</b>
 712
 713                                  ()
 714
 715
 716                                          :
 717
 718
 719                                                 Mixed
 720
 721
 722
 723
 724
 725                 </div>
 726                 <div class="mdesc">
 727
 728                    <div class="short">Gets the data value of the editor</div>
 729
 730
 731
 732                     <div class="long">
 733
 734                                 Gets the data value of the editor
 735
 736
 737
 738
 739
 740
 741
 742
 743
 744
 745                                 <dl class="detailList">
 746                                 <dt class="heading">Returns:</dt>
 747
 748                                         <dd><span class="fixedFont">Mixed</span>  The data value</dd>
 749
 750                                 </dl>
 751
 752
 753
 754
 755
 756
 757
 758                     </div>
 759                 </div>
 760
 761             </td>
 762             <td class="msource">
 763
 764                         Roo.Editor
 765                 &nbsp;
 766             </td>
 767         </tr>
 768
 769
 770           <tr class="method-row config-row-alt0 expandable notInherited">
 771             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 772
 773
 774             <td class="sig">
 775                 <a id="Roo.Editor-method-realign"   name=".realign"></a>
 776                 <div class="fixedFont">
 777                         <span class="attributes"></span><b class="itemname">realign</b>
 778
 779                                  ()
 780
 781
 782
 783                 </div>
 784                 <div class="mdesc">
 785
 786                    <div class="short">Realigns the editor to the bound field based on the current alignment config value.</div>
 787
 788
 789
 790                     <div class="long">
 791
 792                                 Realigns the editor to the bound field based on the current alignment config value.
 793
 794
 795
 796
 797
 798
 799
 800
 801
 802
 803
 804
 805
 806
 807
 808
 809                     </div>
 810                 </div>
 811
 812             </td>
 813             <td class="msource">
 814
 815                         Roo.Editor
 816                 &nbsp;
 817             </td>
 818         </tr>
 819
 820
 821           <tr class="method-row config-row-alt1 expandable notInherited">
 822             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 823
 824
 825             <td class="sig">
 826                 <a id="Roo.Editor-method-setSize"   name=".setSize"></a>
 827                 <div class="fixedFont">
 828                         <span class="attributes"></span><b class="itemname">setSize</b>
 829
 830                                  (<a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a> <B><i>width</i></B>, <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a> <B><i>height</i></B>)
 831
 832
 833
 834                 </div>
 835                 <div class="mdesc">
 836
 837                    <div class="short">Sets the height and width of this editor.</div>
 838
 839
 840
 841                     <div class="long">
 842
 843                                 Sets the height and width of this editor.
 844
 845
 846
 847
 848
 849
 850                                 <dl class="detailList">
 851                                 <dt class="heading">Parameters:</dt>
 852
 853                                         <dt>
 854                                                 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span>  <b>width</b>
 855
 856                                         </dt>
 857                                         <dd>The new width</dd>
 858
 859                                         <dt>
 860                                                 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span>  <b>height</b>
 861
 862                                         </dt>
 863                                         <dd>The new height</dd>
 864
 865                                 </dl>
 866
 867
 868
 869
 870
 871
 872
 873
 874
 875
 876
 877                     </div>
 878                 </div>
 879
 880             </td>
 881             <td class="msource">
 882
 883                         Roo.Editor
 884                 &nbsp;
 885             </td>
 886         </tr>
 887
 888
 889           <tr class="method-row config-row-alt0 expandable notInherited">
 890             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 891
 892
 893             <td class="sig">
 894                 <a id="Roo.Editor-method-setValue"   name=".setValue"></a>
 895                 <div class="fixedFont">
 896                         <span class="attributes"></span><b class="itemname">setValue</b>
 897
 898                                  (Mixed <B><i>value</i></B>)
 899
 900
 901
 902                 </div>
 903                 <div class="mdesc">
 904
 905                    <div class="short">Sets the data value of the editor</div>
 906
 907
 908
 909                     <div class="long">
 910
 911                                 Sets the data value of the editor
 912
 913
 914
 915
 916
 917
 918                                 <dl class="detailList">
 919                                 <dt class="heading">Parameters:</dt>
 920
 921                                         <dt>
 922                                                 <span class="fixedFont">Mixed</span>  <b>value</b>
 923
 924                                         </dt>
 925                                         <dd>Any valid value supported by the underlying field</dd>
 926
 927                                 </dl>
 928
 929
 930
 931
 932
 933
 934
 935
 936
 937
 938
 939                     </div>
 940                 </div>
 941
 942             </td>
 943             <td class="msource">
 944
 945                         Roo.Editor
 946                 &nbsp;
 947             </td>
 948         </tr>
 949
 950
 951           <tr class="method-row config-row-alt1 expandable notInherited">
 952             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 953
 954
 955             <td class="sig">
 956                 <a id="Roo.Editor-method-startEdit"   name=".startEdit"></a>
 957                 <div class="fixedFont">
 958                         <span class="attributes"></span><b class="itemname">startEdit</b>
 959
 960                                  (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/HTMLElement/Element <B><i>el</i></B>, <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>value</i></B>)
 961
 962
 963
 964                 </div>
 965                 <div class="mdesc">
 966
 967                    <div class="short">Starts the editing process and shows the editor.</div>
 968
 969
 970
 971                     <div class="long">
 972
 973                                 Starts the editing process and shows the editor.
 974
 975
 976
 977
 978
 979
 980                                 <dl class="detailList">
 981                                 <dt class="heading">Parameters:</dt>
 982
 983                                         <dt>
 984                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/HTMLElement/Element</span>  <b>el</b>
 985
 986                                         </dt>
 987                                         <dd>The element to edit</dd>
 988
 989                                         <dt>
 990                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  <b>value</b>
 991
 992                                         </dt>
 993                                         <dd>(optional) A value to initialize the editor with. If a value is not provided, it defaults<br/>to the innerHTML of el.</dd>
 994
 995                                 </dl>
 996
 997
 998
 999
1000
1001
1002
1003
1004
1005
1006
1007                     </div>
1008                 </div>
1009
1010             </td>
1011             <td class="msource">
1012
1013                         Roo.Editor
1014                 &nbsp;
1015             </td>
1016         </tr>
1017
1018
1019     </table>
1020
1021
1022   <!-- ============================== events summary / details ======================== -->
1023
1024
1025   <a id="Roo.Editor-events"></a>
1026
1027
1028
1029
1030
1031
1032
1033
1034       <table cellspacing="0" class="member-table">
1035                 <caption>Events</caption>
1036               <thead>
1037                 <tr>
1038                     <th class="sig-header" colspan="2">Event</th>
1039                     <th class="msource-header">Defined By</th>
1040
1041                 </tr>
1042               </thead>
1043
1044
1045
1046
1047
1048           <tr class="method-row expandable config-row-alt0 notInherited">
1049             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1050
1051             <td class="sig">
1052                 <a id="Roo.Editor-event-*beforecomplete"></a>
1053
1054                <div class="fixedFont">
1055                 <b class="itemname">beforecomplete</b> (Editor <B><i>this</i></B>, Mixed <B><i>value</i></B>, Mixed <B><i>startValue</i></B>)
1056
1057                 </div>
1058
1059                 <div class="mdesc">
1060
1061                    <div class="short">Fires after a change has been made to the field, but before the change is reflected in the underlying<br/>field.
1062
1063                 </div>
1064
1065                     <div class="long">
1066
1067                         Fires after a change has been made to the field, but before the change is reflected in the underlying<br/>field.  Saving the change to the field can be canceled by returning false from the handler of this event.<br/>Note that if the value has not changed and ignoreNoChange = true, the editing will still end but this<br/>event will not fire since no edit actually occurred.
1068
1069
1070
1071
1072
1073                                 <dl class="detailList">
1074                                 <dt class="heading">Parameters:</dt>
1075
1076                                         <dt>
1077                                                 <span class="fixedFont">Editor</span> <b>this</b>
1078
1079                                         </dt>
1080                                         <dd></dd>
1081
1082                                         <dt>
1083                                                 <span class="fixedFont">Mixed</span> <b>value</b>
1084
1085                                         </dt>
1086                                         <dd>The current field value</dd>
1087
1088                                         <dt>
1089                                                 <span class="fixedFont">Mixed</span> <b>startValue</b>
1090
1091                                         </dt>
1092                                         <dd>The original field value</dd>
1093
1094                                 </dl>
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106                     </div>
1107                 </div>
1108
1109             </td>
1110             <td class="msource">
1111                 Roo.Editor
1112             </td>
1113         </tr>
1114
1115           <tr class="method-row expandable config-row-alt1 notInherited">
1116             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1117
1118             <td class="sig">
1119                 <a id="Roo.Editor-event-*beforestartedit"></a>
1120
1121                <div class="fixedFont">
1122                 <b class="itemname">beforestartedit</b> (Editor <B><i>this</i></B>, <a href="./Roo.Element.html#constructor" roo:cls="Roo.Element.html#constructor">Roo.Element</a> <B><i>boundEl</i></B>, Mixed <B><i>value</i></B>)
1123
1124                 </div>
1125
1126                 <div class="mdesc">
1127
1128                    <div class="short">Fires when editing is initiated, but before the value changes.
1129
1130                 </div>
1131
1132                     <div class="long">
1133
1134                         Fires when editing is initiated, but before the value changes.  Editing can be canceled by returning<br/>false from the handler of this event.
1135
1136
1137
1138
1139
1140                                 <dl class="detailList">
1141                                 <dt class="heading">Parameters:</dt>
1142
1143                                         <dt>
1144                                                 <span class="fixedFont">Editor</span> <b>this</b>
1145
1146                                         </dt>
1147                                         <dd></dd>
1148
1149                                         <dt>
1150                                                 <span class="fixedFont"><a href="./Roo.Element.html#constructor" roo:cls="Roo.Element.html#constructor">Roo.Element</a></span> <b>boundEl</b>
1151
1152                                         </dt>
1153                                         <dd>The underlying element bound to this editor</dd>
1154
1155                                         <dt>
1156                                                 <span class="fixedFont">Mixed</span> <b>value</b>
1157
1158                                         </dt>
1159                                         <dd>The field value being set</dd>
1160
1161                                 </dl>
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173                     </div>
1174                 </div>
1175
1176             </td>
1177             <td class="msource">
1178                 Roo.Editor
1179             </td>
1180         </tr>
1181
1182           <tr class="method-row expandable config-row-alt0 notInherited">
1183             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1184
1185             <td class="sig">
1186                 <a id="Roo.Editor-event-*complete"></a>
1187
1188                <div class="fixedFont">
1189                 <b class="itemname">complete</b> (Editor <B><i>this</i></B>, Mixed <B><i>value</i></B>, Mixed <B><i>startValue</i></B>)
1190
1191                 </div>
1192
1193                 <div class="mdesc">
1194
1195                    <div class="short">Fires after editing is complete and any changed value has been written to the underlying field.
1196
1197                 </div>
1198
1199                     <div class="long">
1200
1201                         Fires after editing is complete and any changed value has been written to the underlying field.
1202
1203
1204
1205
1206
1207                                 <dl class="detailList">
1208                                 <dt class="heading">Parameters:</dt>
1209
1210                                         <dt>
1211                                                 <span class="fixedFont">Editor</span> <b>this</b>
1212
1213                                         </dt>
1214                                         <dd></dd>
1215
1216                                         <dt>
1217                                                 <span class="fixedFont">Mixed</span> <b>value</b>
1218
1219                                         </dt>
1220                                         <dd>The current field value</dd>
1221
1222                                         <dt>
1223                                                 <span class="fixedFont">Mixed</span> <b>startValue</b>
1224
1225                                         </dt>
1226                                         <dd>The original field value</dd>
1227
1228                                 </dl>
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240                     </div>
1241                 </div>
1242
1243             </td>
1244             <td class="msource">
1245                 Roo.Editor
1246             </td>
1247         </tr>
1248
1249           <tr class="method-row expandable config-row-alt1 notInherited">
1250             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1251
1252             <td class="sig">
1253                 <a id="Roo.Editor-event-*specialkey"></a>
1254
1255                <div class="fixedFont">
1256                 <b class="itemname">specialkey</b> (<a href="./Roo.form.Field.html#constructor" roo:cls="Roo.form.Field.html#constructor">Roo.form.Field</a> <B><i>this</i></B>, <a href="./Roo.EventObject.html#constructor" roo:cls="Roo.EventObject.html#constructor">Roo.EventObject</a> <B><i>e</i></B>)
1257
1258                 </div>
1259
1260                 <div class="mdesc">
1261
1262                    <div class="short">Fires when any key related to navigation (arrows, tab, enter, esc, etc.
1263
1264                 </div>
1265
1266                     <div class="long">
1267
1268                         Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed.  You can check<br/>{<b>link</b> Roo.EventObject<b>getKey</b>} to determine which key was pressed.
1269
1270
1271
1272
1273
1274                                 <dl class="detailList">
1275                                 <dt class="heading">Parameters:</dt>
1276
1277                                         <dt>
1278                                                 <span class="fixedFont"><a href="./Roo.form.Field.html#constructor" roo:cls="Roo.form.Field.html#constructor">Roo.form.Field</a></span> <b>this</b>
1279
1280                                         </dt>
1281                                         <dd></dd>
1282
1283                                         <dt>
1284                                                 <span class="fixedFont"><a href="./Roo.EventObject.html#constructor" roo:cls="Roo.EventObject.html#constructor">Roo.EventObject</a></span> <b>e</b>
1285
1286                                         </dt>
1287                                         <dd>The event object</dd>
1288
1289                                 </dl>
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301                     </div>
1302                 </div>
1303
1304             </td>
1305             <td class="msource">
1306                 Roo.Editor
1307             </td>
1308         </tr>
1309
1310           <tr class="method-row expandable config-row-alt0 notInherited">
1311             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1312
1313             <td class="sig">
1314                 <a id="Roo.Editor-event-*startedit"></a>
1315
1316                <div class="fixedFont">
1317                 <b class="itemname">startedit</b> (<a href="./Roo.Element.html#constructor" roo:cls="Roo.Element.html#constructor">Roo.Element</a> <B><i>boundEl</i></B>, Mixed <B><i>value</i></B>)
1318
1319                 </div>
1320
1321                 <div class="mdesc">
1322
1323                    <div class="short">Fires when this editor is displayed
1324
1325                 </div>
1326
1327                     <div class="long">
1328
1329                         Fires when this editor is displayed
1330
1331
1332
1333
1334
1335                                 <dl class="detailList">
1336                                 <dt class="heading">Parameters:</dt>
1337
1338                                         <dt>
1339                                                 <span class="fixedFont"><a href="./Roo.Element.html#constructor" roo:cls="Roo.Element.html#constructor">Roo.Element</a></span> <b>boundEl</b>
1340
1341                                         </dt>
1342                                         <dd>The underlying element bound to this editor</dd>
1343
1344                                         <dt>
1345                                                 <span class="fixedFont">Mixed</span> <b>value</b>
1346
1347                                         </dt>
1348                                         <dd>The starting field value</dd>
1349
1350                                 </dl>
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362                     </div>
1363                 </div>
1364
1365             </td>
1366             <td class="msource">
1367                 Roo.Editor
1368             </td>
1369         </tr>
1370
1371
1372     </table>
1373
1374
1375
1376
1377
1378 <!-- ============================== footer ================================= -->
1379                 <div class="fineprint" style="clear:both">
1380
1381                         Documentation generated by <a href="http://www.akbkhome.com" target="_blankt">Introspection Doc Generator</a>  on Fri Jul 16 2010 15:55:22 GMT+0800 (HKT)
1382                         Based on
1383                         <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a>
1384                 </div>
1385         </body>
1386 </html>