git.roojs.org Git - roojs1/blob - docs/symbols/Roo.form.FCKeditor.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.FCKeditor</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.FCKeditor-props"><img src="resources/s.gif" class="item-icon icon-prop">Properties</a>
  35         <a class="inner-link" href="#Roo.form.FCKeditor-methods"><img src="resources/s.gif" class="item-icon icon-method">Methods</a>
  36         <a class="inner-link" href="#Roo.form.FCKeditor-events"><img src="resources/s.gif" class="item-icon icon-event">Events</a>
  37         <a class="inner-link" href="#Roo.form.FCKeditor-configs"><img src="resources/s.gif" class="item-icon icon-config">Config Options</a>
  38         <a class="bookmark" href="NEED_TO_CREATE_DIRECT_LINK_HREF"><img src="resources/s.gif" class="item-icon icon-fav">Direct Link</a>
  39         -->
  40     </div>
  41
  42
  43 <!-- ============================== inheritance Block. ================================= -->
  44
  45                 <div class="inheritance res-block">
  46                    <pre class="res-block-inner"><a href="./Roo.form.TextArea.html#constructor" roo:cls="Roo.form.TextArea.html#constructor">Roo.form.TextArea</a>
  47 <img src="../../images/default/s.gif" height="1"  width="20"/><img class="elbow" src="../../images/default/tree/elbow-end.gif"/>Roo.form.FCKeditor
  48
  49                    </pre>
  50                 </div>
  51
  52 <!-- ============================== class title / details ============================ -->
  53
  54
  55     <h1 class="classTitle">
  56
  57                                 Class Roo.form.FCKeditor
  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_FCKeditor.js.html">Roo/form/FCKeditor.js</a>.
  67
  68         </td></tr>
  69         <tr><td class="label">Class:</td><td class="hd-info">FCKeditor</td></tr>
  70
  71
  72
  73
  74                 <tr><td class="label">Extends:</td><td class="hd-info">
  75                         <a href="./Roo.form.TextArea.html#constructor" roo:cls="Roo.form.TextArea.html#constructor">Roo.form.TextArea</a>
  76
  77                 </td></tr>
  78
  79
  80     </table>
  81
  82
  83 <!-- ============================== class summary ========================== -->
  84     <div class="description">
  85         Wrapper around the FCKEditor http://www.fckeditor.net
  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.FCKeditor';">[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.FCKeditor.html"></iframe>
  97 </div>
  98
  99
 100
 101 <!-- ============================== config options ========================== -->
 102
 103
 104
 105
 106     <div class="hr"></div>
 107     <a id="Roo.form.FCKeditor-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.FCKeditor-cfg-fck" name=".fck"></a>
 132                         <div class="fixedFont">
 133                                 <b  class="itemname">fck</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a>
 134
 135
 136                         </div>
 137
 138                         <div class="mdesc">
 139                             <div class="short">options - see fck manual for details.</div>
 140                         </div>
 141
 142                         <div class="mdesc">
 143                             <div class="long">options - see fck manual for details.</div>
 144                         </div>
 145
 146
 147
 148                     </td>
 149                     <td class="msource">
 150
 151                         Roo.form.FCKeditor
 152
 153                     </td>
 154                 </tr>
 155
 156
 157     </table>
 158
 159
 160
 161
 162
 163
 164
 165
 166
 167   <!-- ============================== public properties ==================== -->
 168
 169
 170
 171     <a id="Roo.form.FCKeditor-props"></a>
 172
 173
 174
 175
 176
 177      <table cellspacing="0" class="member-table">
 178       <caption class="Empty">Public Properties - Has None</caption>
 179      </table>
 180
 181
 182
 183
 184   <!-- ============================== methods summary / details ======================== -->
 185
 186
 187   <a id="Roo.form.FCKeditor-methods"></a>
 188         <!-- constructor?? -->
 189
 190         <!-- static's first
 191
 192
 193         -->
 194
 195         <!-- then dynamics first -->
 196
 197
 198
 199
 200
 201
 202       <table cellspacing="0" class="member-table">
 203       <caption>Public Methods</caption>
 204         <tr>
 205             <th class="sig-header" colspan="2">Method</th>
 206             <th class="msource-header">Defined By</th>
 207
 208         </tr>
 209
 210
 211
 212
 213
 214
 215
 216           <tr class="method-row config-row-alt0 expandable notInherited">
 217             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 218
 219
 220             <td class="sig">
 221                 <a id="Roo.form-method-FCKeditor"   name=".FCKeditor"></a>
 222                 <div class="fixedFont">
 223                         <span class="attributes">new <B>Roo.form.</B></span><b class="itemname">FCKeditor</b>
 224
 225                                  (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>config</i></B>)
 226
 227
 228
 229                 </div>
 230                 <div class="mdesc">
 231
 232
 233                         <div class="short">Create a new Roo.form.FCKeditor</div>
 234
 235
 236                     <div class="long">
 237
 238
 239
 240                                 Create a new Roo.form.FCKeditor
 241
 242
 243                                 <dl class="detailList">
 244                                 <dt class="heading">Parameters:</dt>
 245
 246                                         <dt>
 247                                                 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span>  <b>config</b>
 248
 249                                         </dt>
 250                                         <dd>Configuration options</dd>
 251
 252                                 </dl>
 253
 254
 255
 256
 257
 258
 259
 260
 261
 262
 263
 264                     </div>
 265                 </div>
 266
 267             </td>
 268             <td class="msource">
 269                 &nbsp;
 270             </td>
 271         </tr>
 272
 273
 274           <tr class="method-row config-row-alt1 expandable notInherited">
 275             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 276
 277
 278             <td class="sig">
 279                 <a id="Roo.form.FCKeditor-method-getRawValue"   name=".getRawValue"></a>
 280                 <div class="fixedFont">
 281                         <span class="attributes"></span><b class="itemname">getRawValue</b>
 282
 283                                  ()
 284
 285
 286                                          :
 287
 288
 289                                                 Mixed
 290
 291
 292
 293
 294
 295                 </div>
 296                 <div class="mdesc">
 297
 298                    <div class="short">Returns the raw data value which may or may not be a valid, defined value.</div>
 299
 300
 301
 302                     <div class="long">
 303
 304                                 Returns the raw data value which may or may not be a valid, defined value.  To return a normalized value see {<b>link</b> <b>getValue</b>}.
 305
 306
 307
 308
 309
 310
 311
 312
 313
 314
 315                                 <dl class="detailList">
 316                                 <dt class="heading">Returns:</dt>
 317
 318                                         <dd><span class="fixedFont">Mixed</span>  value The field value</dd>
 319
 320                                 </dl>
 321
 322
 323
 324
 325
 326
 327
 328                     </div>
 329                 </div>
 330
 331             </td>
 332             <td class="msource">
 333
 334                         Roo.form.FCKeditor
 335                 &nbsp;
 336             </td>
 337         </tr>
 338
 339
 340           <tr class="method-row config-row-alt0 expandable notInherited">
 341             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 342
 343
 344             <td class="sig">
 345                 <a id="Roo.form.FCKeditor-method-getValue"   name=".getValue"></a>
 346                 <div class="fixedFont">
 347                         <span class="attributes"></span><b class="itemname">getValue</b>
 348
 349                                  ()
 350
 351
 352                                          :
 353
 354
 355                                                 Mixed
 356
 357
 358
 359
 360
 361                 </div>
 362                 <div class="mdesc">
 363
 364                    <div class="short">Returns the normalized data value (undefined or emptyText will be returned as '').</div>
 365
 366
 367
 368                     <div class="long">
 369
 370                                 Returns the normalized data value (undefined or emptyText will be returned as '').  To return the raw value see {<b>link</b> <b>getRawValue</b>}.
 371
 372
 373
 374
 375
 376
 377
 378
 379
 380
 381                                 <dl class="detailList">
 382                                 <dt class="heading">Returns:</dt>
 383
 384                                         <dd><span class="fixedFont">Mixed</span>  value The field value</dd>
 385
 386                                 </dl>
 387
 388
 389
 390
 391
 392
 393
 394                     </div>
 395                 </div>
 396
 397             </td>
 398             <td class="msource">
 399
 400                         Roo.form.FCKeditor
 401                 &nbsp;
 402             </td>
 403         </tr>
 404
 405
 406           <tr class="method-row config-row-alt1 expandable notInherited">
 407             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 408
 409
 410             <td class="sig">
 411                 <a id="Roo.form.FCKeditor-method-setValue"   name=".setValue"></a>
 412                 <div class="fixedFont">
 413                         <span class="attributes"></span><b class="itemname">setValue</b>
 414
 415                                  (Mixed <B><i>value</i></B>)
 416
 417
 418
 419                 </div>
 420                 <div class="mdesc">
 421
 422                    <div class="short">Sets a data value into the field and validates it.</div>
 423
 424
 425
 426                     <div class="long">
 427
 428                                 Sets a data value into the field and validates it.  To set the value directly without validation see {<b>link</b> <b>setRawValue</b>}.
 429
 430
 431
 432
 433
 434
 435                                 <dl class="detailList">
 436                                 <dt class="heading">Parameters:</dt>
 437
 438                                         <dt>
 439                                                 <span class="fixedFont">Mixed</span>  <b>value</b>
 440
 441                                         </dt>
 442                                         <dd>The value to set</dd>
 443
 444                                 </dl>
 445
 446
 447
 448
 449
 450
 451
 452
 453
 454
 455
 456                     </div>
 457                 </div>
 458
 459             </td>
 460             <td class="msource">
 461
 462                         Roo.form.FCKeditor
 463                 &nbsp;
 464             </td>
 465         </tr>
 466
 467
 468     </table>
 469
 470
 471   <!-- ============================== events summary / details ======================== -->
 472
 473
 474   <a id="Roo.form.FCKeditor-events"></a>
 475
 476
 477
 478
 479
 480
 481
 482
 483       <table cellspacing="0" class="member-table">
 484                 <caption>Events</caption>
 485               <thead>
 486                 <tr>
 487                     <th class="sig-header" colspan="2">Event</th>
 488                     <th class="msource-header">Defined By</th>
 489
 490                 </tr>
 491               </thead>
 492
 493
 494
 495
 496
 497           <tr class="method-row expandable config-row-alt0 notInherited">
 498             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 499
 500             <td class="sig">
 501                 <a id="Roo.form.FCKeditor-event-*editorinit"></a>
 502
 503                <div class="fixedFont">
 504                 <b class="itemname">editorinit</b> (FCKeditor <B><i>this</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>the</i></B>)
 505
 506                 </div>
 507
 508                 <div class="mdesc">
 509
 510                    <div class="short">Fired when the editor is initialized - you can add extra handlers here.
 511
 512                 </div>
 513
 514                     <div class="long">
 515
 516                         Fired when the editor is initialized - you can add extra handlers here..
 517
 518
 519
 520
 521
 522                                 <dl class="detailList">
 523                                 <dt class="heading">Parameters:</dt>
 524
 525                                         <dt>
 526                                                 <span class="fixedFont">FCKeditor</span> <b>this</b>
 527
 528                                         </dt>
 529                                         <dd></dd>
 530
 531                                         <dt>
 532                                                 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span> <b>the</b>
 533
 534                                         </dt>
 535                                         <dd>FCK object.</dd>
 536
 537                                 </dl>
 538
 539
 540
 541
 542
 543
 544
 545
 546
 547
 548
 549                     </div>
 550                 </div>
 551
 552             </td>
 553             <td class="msource">
 554                 Roo.form.FCKeditor
 555             </td>
 556         </tr>
 557
 558
 559     </table>
 560
 561
 562
 563
 564
 565 <!-- ============================== footer ================================= -->
 566                 <div class="fineprint" style="clear:both">
 567
 568                         Documentation generated by <a href="http://www.akbkhome.com" target="_blankt">Introspection Doc Generator</a>  on Fri Jul 16 2010 15:55:27 GMT+0800 (HKT)
 569                         Based on
 570                         <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a>
 571                 </div>
 572         </body>
 573 </html>