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-height" name=".height"></a>
 192                         <div class="fixedFont">
 193                                 <b  class="itemname">height</b> : <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>
 194
 195
 196                         </div>
 197
 198                         <div class="mdesc">
 199                             <div class="short">(in pixels)</div>
 200                         </div>
 201
 202                         <div class="mdesc">
 203                             <div class="long">(in pixels)</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                 <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.form.HtmlEditor-cfg-resizable" name=".resizable"></a>
 222                         <div class="fixedFont">
 223                                 <b  class="itemname">resizable</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
 224
 225
 226                         </div>
 227
 228                         <div class="mdesc">
 229                             <div class="short">'s' or 'se' or 'e' - wrapps the element in a<br/>                       Roo.resizable.</div>
 230                         </div>
 231
 232                         <div class="mdesc">
 233                             <div class="long">'s' or 'se' or 'e' - wrapps the element in a<br/>                       Roo.resizable.</div>
 234                         </div>
 235
 236
 237
 238                     </td>
 239                     <td class="msource">
 240
 241                         Roo.form.HtmlEditor
 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.form.HtmlEditor-cfg-toolbars" name=".toolbars"></a>
 252                         <div class="fixedFont">
 253                                 <b  class="itemname">toolbars</b> : <a href="./Array.html#constructor" roo:cls="Array.html#constructor">Array</a>
 254
 255
 256                         </div>
 257
 258                         <div class="mdesc">
 259                             <div class="short">Array of toolbars.</div>
 260                         </div>
 261
 262                         <div class="mdesc">
 263                             <div class="long">Array of toolbars. - defaults to just the Standard one</div>
 264                         </div>
 265
 266
 267
 268                     </td>
 269                     <td class="msource">
 270
 271                         Roo.form.HtmlEditor
 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.form.HtmlEditor-cfg-width" name=".width"></a>
 282                         <div class="fixedFont">
 283                                 <b  class="itemname">width</b> : <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>
 284
 285
 286                         </div>
 287
 288                         <div class="mdesc">
 289                             <div class="short">(in pixels)</div>
 290                         </div>
 291
 292                         <div class="mdesc">
 293                             <div class="long">(in pixels)</div>
 294                         </div>
 295
 296
 297
 298                     </td>
 299                     <td class="msource">
 300
 301                         Roo.form.HtmlEditor
 302
 303                     </td>
 304                 </tr>
 305
 306
 307     </table>
 308
 309
 310
 311
 312
 313
 314
 315
 316
 317   <!-- ============================== public properties ==================== -->
 318
 319
 320
 321     <a id="Roo.form.HtmlEditor-props"></a>
 322
 323
 324
 325
 326
 327      <table cellspacing="0" class="member-table">
 328       <caption class="Empty">Public Properties - Has None</caption>
 329      </table>
 330
 331
 332
 333
 334   <!-- ============================== methods summary / details ======================== -->
 335
 336
 337   <a id="Roo.form.HtmlEditor-methods"></a>
 338         <!-- constructor?? -->
 339
 340         <!-- static's first
 341
 342
 343         -->
 344
 345         <!-- then dynamics first -->
 346
 347
 348
 349
 350
 351
 352       <table cellspacing="0" class="member-table">
 353       <caption>Public Methods</caption>
 354         <tr>
 355             <th class="sig-header" colspan="2">Method</th>
 356             <th class="msource-header">Defined By</th>
 357
 358         </tr>
 359
 360
 361
 362
 363
 364
 365
 366           <tr class="method-row config-row-alt0 notInherited">
 367             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 368
 369
 370             <td class="sig">
 371                 <a id="Roo.form-method-HtmlEditor"   name=".HtmlEditor"></a>
 372                 <div class="fixedFont">
 373                         <span class="attributes">new <B>Roo.form.</B></span><b class="itemname">HtmlEditor</b>
 374
 375                                  ()
 376
 377
 378
 379                 </div>
 380                 <div class="mdesc">
 381
 382
 383                         <div class="short">Create a new Roo.form.HtmlEditor</div>
 384
 385
 386                     <div class="long">
 387
 388
 389
 390                                 Create a new Roo.form.HtmlEditor
 391
 392
 393
 394
 395
 396
 397
 398
 399
 400
 401
 402
 403                     </div>
 404                 </div>
 405
 406             </td>
 407             <td class="msource">
 408                 &nbsp;
 409             </td>
 410         </tr>
 411
 412
 413           <tr class="method-row config-row-alt1 expandable notInherited">
 414             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 415
 416
 417             <td class="sig">
 418                 <a id="Roo.form.HtmlEditor-method-cleanHtml"   name=".cleanHtml"></a>
 419                 <div class="fixedFont">
 420                         <span class="attributes"></span><b class="itemname">cleanHtml</b>
 421
 422                                  (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>html</i></B>)
 423
 424
 425
 426                 </div>
 427                 <div class="mdesc">
 428
 429                    <div class="short">Protected method that will not generally be called directly.</div>
 430
 431
 432
 433                     <div class="long">
 434
 435                                 Protected method that will not generally be called directly. If you need/want<br/>custom HTML cleanup, this is the method you should override.
 436
 437
 438
 439
 440
 441
 442                                 <dl class="detailList">
 443                                 <dt class="heading">Parameters:</dt>
 444
 445                                         <dt>
 446                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  <b>html</b>
 447
 448                                         </dt>
 449                                         <dd>The HTML to be cleaned<br/>return {String} The cleaned HTML</dd>
 450
 451                                 </dl>
 452
 453
 454
 455
 456
 457
 458
 459
 460
 461
 462
 463                     </div>
 464                 </div>
 465
 466             </td>
 467             <td class="msource">
 468
 469                         Roo.form.HtmlEditor
 470                 &nbsp;
 471             </td>
 472         </tr>
 473
 474
 475           <tr class="method-row config-row-alt0 expandable notInherited">
 476             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 477
 478
 479             <td class="sig">
 480                 <a id="Roo.form.HtmlEditor-method-createToolbar"   name=".createToolbar"></a>
 481                 <div class="fixedFont">
 482                         <span class="attributes"></span><b class="itemname">createToolbar</b>
 483
 484                                  (HtmlEditor <B><i>editor</i></B>)
 485
 486
 487
 488                 </div>
 489                 <div class="mdesc">
 490
 491                    <div class="short">Protected method that will not generally be called directly.</div>
 492
 493
 494
 495                     <div class="long">
 496
 497                                 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.
 498
 499
 500
 501
 502
 503
 504                                 <dl class="detailList">
 505                                 <dt class="heading">Parameters:</dt>
 506
 507                                         <dt>
 508                                                 <span class="fixedFont">HtmlEditor</span>  <b>editor</b>
 509
 510                                         </dt>
 511                                         <dd></dd>
 512
 513                                 </dl>
 514
 515
 516
 517
 518
 519
 520
 521
 522
 523
 524
 525                     </div>
 526                 </div>
 527
 528             </td>
 529             <td class="msource">
 530
 531                         Roo.form.HtmlEditor
 532                 &nbsp;
 533             </td>
 534         </tr>
 535
 536
 537           <tr class="method-row config-row-alt1 expandable notInherited">
 538             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 539
 540
 541             <td class="sig">
 542                 <a id="Roo.form.HtmlEditor-method-execCmd"   name=".execCmd"></a>
 543                 <div class="fixedFont">
 544                         <span class="attributes"></span><b class="itemname">execCmd</b>
 545
 546                                  (<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>)
 547
 548
 549
 550                 </div>
 551                 <div class="mdesc">
 552
 553                    <div class="short">Executes a Midas editor command directly on the editor document.</div>
 554
 555
 556
 557                     <div class="long">
 558
 559                                 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>
 560
 561
 562
 563
 564
 565
 566                                 <dl class="detailList">
 567                                 <dt class="heading">Parameters:</dt>
 568
 569                                         <dt>
 570                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  <b>cmd</b>
 571
 572                                         </dt>
 573                                         <dd>The Midas command</dd>
 574
 575                                         <dt>
 576                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/Boolean</span>  <b>value</b>
 577
 578                                         </dt>
 579                                         <dd>(optional) The value to pass to the command (defaults to null)</dd>
 580
 581                                 </dl>
 582
 583
 584
 585
 586
 587
 588
 589
 590
 591
 592
 593                     </div>
 594                 </div>
 595
 596             </td>
 597             <td class="msource">
 598
 599                         Roo.form.HtmlEditor
 600                 &nbsp;
 601             </td>
 602         </tr>
 603
 604
 605           <tr class="method-row config-row-alt0 expandable notInherited">
 606             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 607
 608
 609             <td class="sig">
 610                 <a id="Roo.form.HtmlEditor-method-getDocMarkup"   name=".getDocMarkup"></a>
 611                 <div class="fixedFont">
 612                         <span class="attributes"></span><b class="itemname">getDocMarkup</b>
 613
 614                                  ()
 615
 616
 617
 618                 </div>
 619                 <div class="mdesc">
 620
 621                    <div class="short">Protected method that will not generally be called directly.</div>
 622
 623
 624
 625                     <div class="long">
 626
 627                                 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).
 628
 629
 630
 631
 632
 633
 634
 635
 636
 637
 638
 639
 640
 641
 642
 643
 644                     </div>
 645                 </div>
 646
 647             </td>
 648             <td class="msource">
 649
 650                         Roo.form.HtmlEditor
 651                 &nbsp;
 652             </td>
 653         </tr>
 654
 655
 656           <tr class="method-row config-row-alt1 expandable notInherited">
 657             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 658
 659
 660             <td class="sig">
 661                 <a id="Roo.form.HtmlEditor-method-insertAtCursor"   name=".insertAtCursor"></a>
 662                 <div class="fixedFont">
 663                         <span class="attributes"></span><b class="itemname">insertAtCursor</b>
 664
 665                                  (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>text</i></B>)
 666
 667
 668
 669                 </div>
 670                 <div class="mdesc">
 671
 672                    <div class="short">Inserts the passed text at the current cursor position.</div>
 673
 674
 675
 676                     <div class="long">
 677
 678                                 Inserts the passed text at the current cursor position. Note: the editor must be initialized and activated<br/>to insert tRoo.
 679
 680
 681
 682
 683
 684
 685                                 <dl class="detailList">
 686                                 <dt class="heading">Parameters:</dt>
 687
 688                                         <dt>
 689                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  <b>text</b>
 690
 691                                         </dt>
 692                                         <dd></dd>
 693
 694                                 </dl>
 695
 696
 697
 698
 699
 700
 701
 702
 703
 704
 705
 706                     </div>
 707                 </div>
 708
 709             </td>
 710             <td class="msource">
 711
 712                         Roo.form.HtmlEditor
 713                 &nbsp;
 714             </td>
 715         </tr>
 716
 717
 718           <tr class="method-row config-row-alt0 expandable notInherited">
 719             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 720
 721
 722             <td class="sig">
 723                 <a id="Roo.form.HtmlEditor-method-pushValue"   name=".pushValue"></a>
 724                 <div class="fixedFont">
 725                         <span class="attributes"></span><b class="itemname">pushValue</b>
 726
 727                                  ()
 728
 729
 730
 731                 </div>
 732                 <div class="mdesc">
 733
 734                    <div class="short">Protected method that will not generally be called directly.</div>
 735
 736
 737
 738                     <div class="long">
 739
 740                                 Protected method that will not generally be called directly. Pushes the value of the textarea<br/>into the iframe editor.
 741
 742
 743
 744
 745
 746
 747
 748
 749
 750
 751
 752
 753
 754
 755
 756
 757                     </div>
 758                 </div>
 759
 760             </td>
 761             <td class="msource">
 762
 763                         Roo.form.HtmlEditor
 764                 &nbsp;
 765             </td>
 766         </tr>
 767
 768
 769           <tr class="method-row config-row-alt1 expandable notInherited">
 770             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 771
 772
 773             <td class="sig">
 774                 <a id="Roo.form.HtmlEditor-method-relayCmd"   name=".relayCmd"></a>
 775                 <div class="fixedFont">
 776                         <span class="attributes"></span><b class="itemname">relayCmd</b>
 777
 778                                  (<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>)
 779
 780
 781
 782                 </div>
 783                 <div class="mdesc">
 784
 785                    <div class="short">Executes a Midas editor command on the editor document and performs necessary focus and<br/>toolbar updates.</div>
 786
 787
 788
 789                     <div class="long">
 790
 791                                 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>
 792
 793
 794
 795
 796
 797
 798                                 <dl class="detailList">
 799                                 <dt class="heading">Parameters:</dt>
 800
 801                                         <dt>
 802                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  <b>cmd</b>
 803
 804                                         </dt>
 805                                         <dd>The Midas command</dd>
 806
 807                                         <dt>
 808                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/Boolean</span>  <b>value</b>
 809
 810                                         </dt>
 811                                         <dd>(optional) The value to pass to the command (defaults to null)</dd>
 812
 813                                 </dl>
 814
 815
 816
 817
 818
 819
 820
 821
 822
 823
 824
 825                     </div>
 826                 </div>
 827
 828             </td>
 829             <td class="msource">
 830
 831                         Roo.form.HtmlEditor
 832                 &nbsp;
 833             </td>
 834         </tr>
 835
 836
 837           <tr class="method-row config-row-alt0 expandable notInherited">
 838             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 839
 840
 841             <td class="sig">
 842                 <a id="Roo.form.HtmlEditor-method-syncValue"   name=".syncValue"></a>
 843                 <div class="fixedFont">
 844                         <span class="attributes"></span><b class="itemname">syncValue</b>
 845
 846                                  ()
 847
 848
 849
 850                 </div>
 851                 <div class="mdesc">
 852
 853                    <div class="short">Protected method that will not generally be called directly.</div>
 854
 855
 856
 857                     <div class="long">
 858
 859                                 Protected method that will not generally be called directly. Syncs the contents<br/>of the editor iframe with the textarea.
 860
 861
 862
 863
 864
 865
 866
 867
 868
 869
 870
 871
 872
 873
 874
 875
 876                     </div>
 877                 </div>
 878
 879             </td>
 880             <td class="msource">
 881
 882                         Roo.form.HtmlEditor
 883                 &nbsp;
 884             </td>
 885         </tr>
 886
 887
 888           <tr class="method-row config-row-alt1 expandable notInherited">
 889             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 890
 891
 892             <td class="sig">
 893                 <a id="Roo.form.HtmlEditor-method-toggleSourceEdit"   name=".toggleSourceEdit"></a>
 894                 <div class="fixedFont">
 895                         <span class="attributes"></span><b class="itemname">toggleSourceEdit</b>
 896
 897                                  (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a> <B><i>sourceEdit</i></B>)
 898
 899
 900
 901                 </div>
 902                 <div class="mdesc">
 903
 904                    <div class="short">Toggles the editor between standard and source edit mode.</div>
 905
 906
 907
 908                     <div class="long">
 909
 910                                 Toggles the editor between standard and source edit mode.
 911
 912
 913
 914
 915
 916
 917                                 <dl class="detailList">
 918                                 <dt class="heading">Parameters:</dt>
 919
 920                                         <dt>
 921                                                 <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>
 922
 923                                         </dt>
 924                                         <dd>(optional) True for source edit, false for standard</dd>
 925
 926                                 </dl>
 927
 928
 929
 930
 931
 932
 933
 934
 935
 936
 937
 938                     </div>
 939                 </div>
 940
 941             </td>
 942             <td class="msource">
 943
 944                         Roo.form.HtmlEditor
 945                 &nbsp;
 946             </td>
 947         </tr>
 948
 949
 950     </table>
 951
 952
 953   <!-- ============================== events summary / details ======================== -->
 954
 955
 956   <a id="Roo.form.HtmlEditor-events"></a>
 957
 958
 959
 960
 961
 962
 963
 964
 965       <table cellspacing="0" class="member-table">
 966                 <caption>Events</caption>
 967               <thead>
 968                 <tr>
 969                     <th class="sig-header" colspan="2">Event</th>
 970                     <th class="msource-header">Defined By</th>
 971
 972                 </tr>
 973               </thead>
 974
 975
 976
 977
 978
 979           <tr class="method-row expandable config-row-alt0 notInherited">
 980             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 981
 982             <td class="sig">
 983                 <a id="Roo.form.HtmlEditor-event-*activate"></a>
 984
 985                <div class="fixedFont">
 986                 <b class="itemname">activate</b> (HtmlEditor <B><i>this</i></B>)
 987
 988                 </div>
 989
 990                 <div class="mdesc">
 991
 992                    <div class="short">Fires when the editor is first receives the focus.
 993
 994                 </div>
 995
 996                     <div class="long">
 997
 998                         Fires when the editor is first receives the focus. Any insertion must wait<br/>until after this event.
 999
1000
1001
1002
1003
1004                                 <dl class="detailList">
1005                                 <dt class="heading">Parameters:</dt>
1006
1007                                         <dt>
1008                                                 <span class="fixedFont">HtmlEditor</span> <b>this</b>
1009
1010                                         </dt>
1011                                         <dd></dd>
1012
1013                                 </dl>
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025                     </div>
1026                 </div>
1027
1028             </td>
1029             <td class="msource">
1030                 Roo.form.HtmlEditor
1031             </td>
1032         </tr>
1033
1034           <tr class="method-row expandable config-row-alt1 notInherited">
1035             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1036
1037             <td class="sig">
1038                 <a id="Roo.form.HtmlEditor-event-*beforepush"></a>
1039
1040                <div class="fixedFont">
1041                 <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>)
1042
1043                 </div>
1044
1045                 <div class="mdesc">
1046
1047                    <div class="short">Fires before the iframe editor is updated with content from the textarea.
1048
1049                 </div>
1050
1051                     <div class="long">
1052
1053                         Fires before the iframe editor is updated with content from the textarea. Return false<br/>to cancel the push.
1054
1055
1056
1057
1058
1059                                 <dl class="detailList">
1060                                 <dt class="heading">Parameters:</dt>
1061
1062                                         <dt>
1063                                                 <span class="fixedFont">HtmlEditor</span> <b>this</b>
1064
1065                                         </dt>
1066                                         <dd></dd>
1067
1068                                         <dt>
1069                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>html</b>
1070
1071                                         </dt>
1072                                         <dd></dd>
1073
1074                                 </dl>
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086                     </div>
1087                 </div>
1088
1089             </td>
1090             <td class="msource">
1091                 Roo.form.HtmlEditor
1092             </td>
1093         </tr>
1094
1095           <tr class="method-row expandable config-row-alt0 notInherited">
1096             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1097
1098             <td class="sig">
1099                 <a id="Roo.form.HtmlEditor-event-*beforesync"></a>
1100
1101                <div class="fixedFont">
1102                 <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>)
1103
1104                 </div>
1105
1106                 <div class="mdesc">
1107
1108                    <div class="short">Fires before the textarea is updated with content from the editor iframe.
1109
1110                 </div>
1111
1112                     <div class="long">
1113
1114                         Fires before the textarea is updated with content from the editor iframe. Return false<br/>to cancel the sync.
1115
1116
1117
1118
1119
1120                                 <dl class="detailList">
1121                                 <dt class="heading">Parameters:</dt>
1122
1123                                         <dt>
1124                                                 <span class="fixedFont">HtmlEditor</span> <b>this</b>
1125
1126                                         </dt>
1127                                         <dd></dd>
1128
1129                                         <dt>
1130                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>html</b>
1131
1132                                         </dt>
1133                                         <dd></dd>
1134
1135                                 </dl>
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147                     </div>
1148                 </div>
1149
1150             </td>
1151             <td class="msource">
1152                 Roo.form.HtmlEditor
1153             </td>
1154         </tr>
1155
1156           <tr class="method-row expandable config-row-alt1 notInherited">
1157             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1158
1159             <td class="sig">
1160                 <a id="Roo.form.HtmlEditor-event-*editmodechange"></a>
1161
1162                <div class="fixedFont">
1163                 <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>)
1164
1165                 </div>
1166
1167                 <div class="mdesc">
1168
1169                    <div class="short">Fires when the editor switches edit modes
1170
1171                 </div>
1172
1173                     <div class="long">
1174
1175                         Fires when the editor switches edit modes
1176
1177
1178
1179
1180
1181                                 <dl class="detailList">
1182                                 <dt class="heading">Parameters:</dt>
1183
1184                                         <dt>
1185                                                 <span class="fixedFont">HtmlEditor</span> <b>this</b>
1186
1187                                         </dt>
1188                                         <dd></dd>
1189
1190                                         <dt>
1191                                                 <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>
1192
1193                                         </dt>
1194                                         <dd>True if source edit, false if standard editing.</dd>
1195
1196                                 </dl>
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208                     </div>
1209                 </div>
1210
1211             </td>
1212             <td class="msource">
1213                 Roo.form.HtmlEditor
1214             </td>
1215         </tr>
1216
1217           <tr class="method-row expandable config-row-alt0 notInherited">
1218             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1219
1220             <td class="sig">
1221                 <a id="Roo.form.HtmlEditor-event-*editorevent"></a>
1222
1223                <div class="fixedFont">
1224                 <b class="itemname">editorevent</b> (HtmlEditor <B><i>this</i></B>)
1225
1226                 </div>
1227
1228                 <div class="mdesc">
1229
1230                    <div class="short">Fires when on any editor (mouse up/down cursor movement etc.
1231
1232                 </div>
1233
1234                     <div class="long">
1235
1236                         Fires when on any editor (mouse up/down cursor movement etc.) - used for toolbar hooks.
1237
1238
1239
1240
1241
1242                                 <dl class="detailList">
1243                                 <dt class="heading">Parameters:</dt>
1244
1245                                         <dt>
1246                                                 <span class="fixedFont">HtmlEditor</span> <b>this</b>
1247
1248                                         </dt>
1249                                         <dd></dd>
1250
1251                                 </dl>
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263                     </div>
1264                 </div>
1265
1266             </td>
1267             <td class="msource">
1268                 Roo.form.HtmlEditor
1269             </td>
1270         </tr>
1271
1272           <tr class="method-row expandable config-row-alt1 notInherited">
1273             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1274
1275             <td class="sig">
1276                 <a id="Roo.form.HtmlEditor-event-*initialize"></a>
1277
1278                <div class="fixedFont">
1279                 <b class="itemname">initialize</b> (HtmlEditor <B><i>this</i></B>)
1280
1281                 </div>
1282
1283                 <div class="mdesc">
1284
1285                    <div class="short">Fires when the editor is fully initialized (including the iframe)
1286
1287                 </div>
1288
1289                     <div class="long">
1290
1291                         Fires when the editor is fully initialized (including the iframe)
1292
1293
1294
1295
1296
1297                                 <dl class="detailList">
1298                                 <dt class="heading">Parameters:</dt>
1299
1300                                         <dt>
1301                                                 <span class="fixedFont">HtmlEditor</span> <b>this</b>
1302
1303                                         </dt>
1304                                         <dd></dd>
1305
1306                                 </dl>
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318                     </div>
1319                 </div>
1320
1321             </td>
1322             <td class="msource">
1323                 Roo.form.HtmlEditor
1324             </td>
1325         </tr>
1326
1327           <tr class="method-row expandable config-row-alt0 notInherited">
1328             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1329
1330             <td class="sig">
1331                 <a id="Roo.form.HtmlEditor-event-*push"></a>
1332
1333                <div class="fixedFont">
1334                 <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>)
1335
1336                 </div>
1337
1338                 <div class="mdesc">
1339
1340                    <div class="short">Fires when the iframe editor is updated with content from the textarea.
1341
1342                 </div>
1343
1344                     <div class="long">
1345
1346                         Fires when the iframe editor is updated with content from the textarea.
1347
1348
1349
1350
1351
1352                                 <dl class="detailList">
1353                                 <dt class="heading">Parameters:</dt>
1354
1355                                         <dt>
1356                                                 <span class="fixedFont">HtmlEditor</span> <b>this</b>
1357
1358                                         </dt>
1359                                         <dd></dd>
1360
1361                                         <dt>
1362                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>html</b>
1363
1364                                         </dt>
1365                                         <dd></dd>
1366
1367                                 </dl>
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379                     </div>
1380                 </div>
1381
1382             </td>
1383             <td class="msource">
1384                 Roo.form.HtmlEditor
1385             </td>
1386         </tr>
1387
1388           <tr class="method-row expandable config-row-alt1 notInherited">
1389             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1390
1391             <td class="sig">
1392                 <a id="Roo.form.HtmlEditor-event-*sync"></a>
1393
1394                <div class="fixedFont">
1395                 <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>)
1396
1397                 </div>
1398
1399                 <div class="mdesc">
1400
1401                    <div class="short">Fires when the textarea is updated with content from the editor iframe.
1402
1403                 </div>
1404
1405                     <div class="long">
1406
1407                         Fires when the textarea is updated with content from the editor iframe.
1408
1409
1410
1411
1412
1413                                 <dl class="detailList">
1414                                 <dt class="heading">Parameters:</dt>
1415
1416                                         <dt>
1417                                                 <span class="fixedFont">HtmlEditor</span> <b>this</b>
1418
1419                                         </dt>
1420                                         <dd></dd>
1421
1422                                         <dt>
1423                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>html</b>
1424
1425                                         </dt>
1426                                         <dd></dd>
1427
1428                                 </dl>
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440                     </div>
1441                 </div>
1442
1443             </td>
1444             <td class="msource">
1445                 Roo.form.HtmlEditor
1446             </td>
1447         </tr>
1448
1449
1450     </table>
1451
1452
1453
1454
1455
1456 <!-- ============================== footer ================================= -->
1457                 <div class="fineprint" style="clear:both">
1458
1459                         Documentation generated by <a href="http://www.akbkhome.com" target="_blankt">Introspection Doc Generator</a>  on Tue Aug 16 2011 19:19:10 GMT+0800 (HKT)
1460                         Based on
1461                         <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a>
1462                 </div>
1463         </body>
1464 </html>