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