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