[Sommaire] [Imprimer]

   1  <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
   2  <html>
   3  <head>
   4  <title>Javascript Functions</title>
   5  <link href="css/screen.css" rel="stylesheet" type="text/css" />
   6  </head>
   7  <body>
   8  
   9  <div class="header">
  10      <h1>Javascript Functions</h1>
  11  </div>
  12  
  13  <div class="content">
  14  <p>This is for advanced users, TinyMCE has a global instance with some public functions that can be called from the page.</p>
  15  <h3>tinyMCE.triggerSave([skip_cleanup], [skip_callback]);</h3>
  16  <p>
  17  Makes a cleanup and moves the contents from the editor to the form field. This method is automaticly called by tinyMCE by adding a trigger on the forms submit method.
  18  </p>
  19  <p>
  20  <table border="1" cellspacing="0" cellpadding="4">
  21  <thead>
  22  <tr>
  23      <td colspan="2">Parameters</td>
  24  </tr>
  25  </thead>
  26  <tbody>
  27  <tr>
  28      <td>[skip_cleanup]</td>
  29      <td>Disables the cleanup process of trigger save. Defaults to false. (Optional)</td>
  30  </tr>
  31  <tr>
  32      <td>[skip_callback]</td>
  33      <td>Disables the execution of the <a href="option_save_callback.html">save_callback</a> function. Defaults to false. (Optional)</td>
  34  </tr>
  35  </tbody>
  36  </table>
  37  
  38  skip_callback
  39  </p>
  40  <p>
  41  Returns: Nothing
  42  </p>
  43  <div class="separator"></div>
  44  <h3>tinyMCE.updateContent(form_element_name);</h3>
  45  <p>
  46  Moves the contents from the form element to the editor, this does the opposite of triggerSave(). This method can be used when you want to change the contents of the editor dynamicly.
  47  </p>
  48  <p>
  49  <table border="1" cellspacing="0" cellpadding="4">
  50  <thead>
  51  <tr>
  52      <td colspan="2">Parameters</td>
  53  </tr>
  54  </thead>
  55  <tbody>
  56  <tr>
  57      <td>form_element_name</td>
  58      <td>The name of the form element to get contents from.</td>
  59  </tr>
  60  </tbody>
  61  </table>
  62  </p>
  63  <p>
  64  Returns: Nothing
  65  </p>
  66  <div class="separator"></div>
  67  <h3>tinyMCE.execInstanceCommand(editor_id, command, [user_interface], [value]);</h3>
  68  <p>
  69  This method executes a command by name on the editor instance specified by the editor_id parameter.
  70  </p>
  71  <p>
  72  <table border="1" cellspacing="0" cellpadding="4">
  73  <thead>
  74  <tr>
  75      <td colspan="2">Parameters</td>
  76  </tr>
  77  </thead>
  78  <tbody>
  79  <tr>
  80      <td>editor_id</td>
  81      <td>ID of editor instance or element id/name of the replaced element.</td>
  82  </tr>
  83  <tr>
  84      <td>command</td>
  85      <td>Command to execute check the execCommand function for details.</td>
  86  </tr>
  87  <tr>
  88      <td>[user_interface]</td>
  89      <td>Is a user interface to be used or not.</td>
  90  </tr>
  91  <tr>
  92      <td>[value]</td>
  93      <td>Value to pass with command for example a URL..</td>
  94  </tr>
  95  </tbody>
  96  </table>
  97  </p>
  98  <p>
  99  Returns: Nothing 
 100  </p>
 101  <div class="separator"></div>
 102  <h3>tinyMCE.execCommand(command, [user_interface], [value]);</h3>
 103  <p>
 104  This method executes a command by name on the selected editor instance.
 105  </p>
 106  <p>
 107  <table border="1" cellspacing="0" cellpadding="4">
 108  <thead>
 109  <tr>
 110      <td colspan="2">Parameters</td>
 111  </tr>
 112  </thead>
 113  <tbody>
 114  <tr>
 115      <td>command</td>
 116      <td>Command to execute for example &quot;Bold&quot; or &quot;Italic&quot;. These are defined by Mozilla <a href="http://www.mozilla.org/editor/midas-spec.html">Midas specification</a> or <a href="http://msdn.microsoft.com/workshop/author/dhtml/reference/commandids.asp">Microsoft specification</a>. But there are a some TinyMCE specific commands many other commands are available within plugins and themes.<br /><br />
 117      <table border="0" cellspacing="0" cellpadding="2">
 118      <tr>
 119          <td>mceLink</td>
 120          <td>Opens the insert link dialog and inserts a link.</td>
 121      </tr>
 122      <tr>
 123          <td>mceImage</td>
 124          <td>Opens the insert image dialog and inserts a image.</td>
 125      </tr>
 126      <tr>
 127          <td>mceCleanup</td>
 128          <td>Removed unwanted elements and attributes from the HTML code.</td>
 129      </tr>
 130      <tr>
 131          <td>mceHelp</td>
 132          <td>Opens the manual pages.</td>
 133      </tr>
 134      <tr>
 135          <td>mceAddControl</td>
 136          <td>Adds a editor control to the element id/name specified as value.</td>
 137      </tr>
 138      <tr>
 139          <td>mceRemoveControl</td>
 140          <td>Removes a specific control by editor_id name. The value is the editor_id to remove, editor ids are in the following format: &quot;mce_editor_&lt;index&gt;&quot;. DOM element ids and form element names can allso be used.</td>
 141      </tr>
 142      <tr>
 143          <td>mceFocus</td>
 144          <td>Focuses the editor by the id placed in value. Editor id's are in the format "mce_editor_<index>". DOM element ids and form element names can allso be used.</td>
 145      </tr>
 146      <tr>
 147          <td>mceSetCSSClass</td>
 148          <td>Sets the CSS class attribute or creates a new span of the selection. The value is the css class name to assign to selected element or new span element.</td>
 149      </tr>
 150      <tr>
 151          <td>mceInsertContent</td>
 152          <td>Inserts contents of value parameter to current cursor position.</td>
 153      </tr>
 154      <tr>
 155          <td>mceReplaceContent</td>
 156          <td>Replaces the current selection with the HTML code in value. The {$selection} variable gets replaced with the currently selected text contents.</td>
 157      </tr>
 158      <tr>
 159          <td>mceSetAttribute</td>
 160          <td>Sets a attribute of the currenly selected element. The value of this command should be a name/value array with the following parameters.<br /><br />
 161          name - Attribute name to set.<br />
 162          value - Attrbute value to set.<br />
 163          [targets] - Target elements to add attribute on. Default: p,img,span,div,td,h1,h2,h3,h4,h5,h6,pre,address.<br /><br />
 164          Example of usage:<br />
 165          tinyMCE.execCommand('mceSetAttribute',false,{name:'align',value:'right'});<br />
 166          </td>
 167      </tr>
 168      <tr>
 169          <td>mceToggleVisualAid</td>
 170          <td>Toggles visual aid/guidelines mode on/off.</td>
 171      </tr>
 172      <tr>
 173          <td>mceAnchor</td>
 174          <td>Inserts a named anchor element, the value is the name of the anchor.</td>
 175      </tr>
 176      <tr>
 177          <td>mceResetDesignMode</td>
 178          <td>Resets the designMode state of all editor instances, this command is useful on Firefox if the editor is placed in tabs or shown/hidden with style.display="none/block". Call this command after the editor displayed again.</td>
 179      </tr>
 180      <tr>
 181          <td>mceSelectNode</td>
 182          <td>Selects the node/element passed as value. This command will also scroll to the elements location within the editor.</td>
 183      </tr>
 184      <tr>
 185          <td>mceSelectNodeDepth</td>
 186          <td>Selects the node/element by depth relative from the current node. So a value of 0 will select the currently focused node. This command will also scroll to the elements location within the editor.</td>
 187      </tr>
 188      <tr>
 189          <td></td>
 190          <td></td>
 191      </tr>
 192      </tbody>
 193  </table>
 194      </td>
 195  </tr>
 196  <tr>
 197      <td>[user_interface]</td>
 198      <td>Tells if the command is to display a user interface or not. True/False option.</td>
 199  </tr>
 200  <tr>
 201      <td>[value]</td>
 202      <td>Value to pass for the command for example to insertLink it's the URL of the link.</td>
 203  </tr>
 204  </tbody>
 205  </table>
 206  
 207  </p>
 208  <p>
 209  Returns: Nothing
 210  </p>
 211  <p>
 212  Example:
 213  </p>
 214  <p>
 215  <div class="example">
 216  <pre>
 217  &lt;a href=&quot;javascript:tinymce.execCommand('Bold');&quot;&gt;[Do bold]&lt;/a&gt;
 218  </pre>
 219  </div>
 220  </p>
 221  <div class="separator"></div>
 222  <h3>tinyMCE.insertLink(href, target);</h3>
 223  
 224  <p>This method inserts a link a the cursor position of the selected editor instance or updates the selected link with new data. This method should be called upon "ok" in the insertLink popup when you create custom themes.
 225  </p>
 226  <table border="1" cellspacing="0" cellpadding="4">
 227  <thead>
 228  <tr>
 229      <td colspan="2">Parameters</td>
 230  </tr>
 231  </thead>
 232  <tbody>
 233  <tr>
 234      <td>href</td>
 235      <td>HREF/URL of the link.</td>
 236  </tr>
 237  <tr>
 238      <td>target</td>
 239      <td>Target of the link.</td>
 240  </tr>
 241  </tbody>
 242  </table>
 243  <p>
 244  Returns: Nothing
 245  </p>
 246  <div class="separator"></div>
 247  <h3>tinyMCE.insertImage(src, alt, border, hspace, vspace, width, height, align, title, onmouseover, onmouseout);</h4>
 248  <p>
 249  This method inserts a image a the cursor position of the selected editor instance or updates the selected image with new data. This method should be called upon "ok" in the insertImage popup when you create custom themes.
 250  </p>
 251  <table border="1" cellspacing="0" cellpadding="4">
 252  <thead>
 253  <tr>
 254      <td colspan="2">Parameters</td>
 255  </tr>
 256  </thead>
 257  <tbody>
 258  <tr>
 259      <td>src</td>
 260      <td>Image src url.</td>
 261  </tr>
 262  <tr>
 263      <td>alt</td>
 264      <td>Alternative text of img element.</td>
 265  </tr>
 266  <tr>
 267      <td>border</td>
 268      <td>Border of image element.</td>
 269  </tr>
 270  <tr>
 271      <td>hspace</td>
 272      <td>Horizontal spacing of image element.</td>
 273  </tr>
 274  <tr>
 275      <td>vspace</td>
 276      <td>Vertical spacing of image element.</td>
 277  </tr>
 278  <tr>
 279      <td>width</td>
 280      <td>Width of image element.</td>
 281  </tr>
 282  <tr>
 283      <td>height</td>
 284      <td>Height of image element.</td>
 285  </tr>
 286  <tr>
 287      <td>align</td>
 288      <td>Alignment of image element.</td>
 289  </tr>
 290  <tr>
 291      <td>title</td>
 292      <td>Link title of image element.</td>
 293  </tr>
 294  <tr>
 295      <td>onmouseover</td>
 296      <td>On mouse over event handler of image element.</td>
 297  </tr>
 298  <tr>
 299      <td>onmouseout</td>
 300      <td>On mouse out event handler of image element.</td>
 301  </tr>
 302  </tbody>
 303  </table>
 304  <p>
 305  Returns: Nothing
 306  </p>
 307  <div class="separator"></div>
 308  <h3>tinyMCE.triggerNodeChange();</h3>
 309  <p>This method is to be called when external changes is made to the editor. This method will then call the "handleNodeChangeCallback" callback in the theme.
 310  </p>
 311  <p>
 312  Parameters:
 313  </p>
 314  <p>
 315  None
 316  </p>
 317  <p>
 318  Returns: Nothing
 319  </p>
 320  <div class="separator"></div>
 321  <h3>tinyMCE.getContent();</h3>
 322  <p>
 323  This method returns the HTML contents of the currently selected editor or null if no editor was selected.
 324  </p>
 325  <p>
 326  Parameters:
 327  </p>
 328  <p>
 329  None
 330  </p>
 331  <p>
 332  Returns: HTML contents of the currently selected editor or null. 
 333  </p>
 334  <div class="separator"></div>
 335  <h3>Syntax: tinyMCE.setContent(html);</h3>
 336  
 337  <p>This method sets the HTML contents of the currently selected editor.</p>
 338  
 339  <p>
 340  <table border="1" cellspacing="0" cellpadding="4">
 341  <thead>
 342  <tr>
 343      <td colspan="2">Parameters</td>
 344  </tr>
 345  </thead>
 346  <tbody>
 347  <tr>
 348      <td>html</td>
 349      <td>HTML Source code to set.</td>
 350  </tr>
 351  </tbody>
 352  </table>
 353  </p>
 354  <p>
 355  Returns: None.
 356  </p>
 357  <div class="separator"></div>
 358  <h3>tinyMCE.getInstanceById(editor_id);</h3>
 359  <p>
 360  This method returns a editor instance by editor id.
 361  </p>
 362  <p>
 363  <table border="1" cellspacing="0" cellpadding="4">
 364  <thead>
 365  <tr>
 366      <td colspan="2">Parameters</td>
 367  </tr>
 368  </thead>
 369  <tbody>
 370  <tr>
 371      <td>editor_id</td>
 372      <td>Editor instance to retrive.</td>
 373  </tr>
 374  </tbody>
 375  </table>
 376  </p>
 377  <p>
 378  Returns: TinyMCE Editor instance (TinyMCEControl). 
 379  </p>
 380  <div class="separator"></div>
 381  <h3>tinyMCE.importThemeLanguagePack([theme]);</h3>
 382  <p>
 383  This method imports/loads theme specific language packs. This may be called from custom themes.
 384  </p>
 385  <p>
 386  <table border="1" cellspacing="0" cellpadding="4">
 387  <thead>
 388  <tr>
 389      <td colspan="2">Parameters</td>
 390  </tr>
 391  </thead>
 392  <tbody>
 393  <tr>
 394      <td>[theme]</td>
 395      <td>Name of the current theme. This is a optional parameter it defaults to the global "theme" setting. This parameter is useful within theme plugins.</td>
 396  </tr>
 397  </tbody>
 398  </table>
 399  </p>
 400  <p>
 401  Returns: None.
 402  </p>
 403  <div class="separator"></div>
 404  <h3>tinyMCE.importPluginLanguagePack(plugin, valid_languages);</h3>
 405  <p>
 406  This method imports/loads plugin specific language packs. This may be called from custom plugins.
 407  </p>
 408  <p>
 409  <table border="1" cellspacing="0" cellpadding="4">
 410  <thead>
 411  <tr>
 412      <td colspan="2">Parameters</td>
 413  </tr>
 414  </thead>
 415  <tbody>
 416  <tr>
 417      <td>plugin</td>
 418      <td>Name of the current plugin.</td>
 419  </tr>
 420  <tr>
 421      <td>valid_languages</td>
 422      <td>Comma separated list of supported languagepacks.</td>
 423  </tr>
 424  </tbody>
 425  </table>
 426  </p>
 427  <p>
 428  Returns: None.
 429  </p>
 430  <div class="separator"></div>
 431  <h3>tinyMCE.applyTemplate(html);</h3>
 432  <p>
 433  This method replaces settings and lang variables in the theme.
 434  </p>
 435  <p>
 436  <table border="1" cellspacing="0" cellpadding="4">
 437  <thead>
 438  <tr>
 439      <td colspan="2">Parameters</td>
 440  </tr>
 441  </thead>
 442  <tbody>
 443  <tr>
 444      <td>html</td>
 445      <td>HTML code to apply theme variable substitution on.</td>
 446  </tr>
 447  </tbody>
 448  </table>
 449  </p>
 450  <p>
 451  Returns: New converted, HTML code. 
 452  </p>
 453  <div class="separator"></div>
 454  <h3>tinyMCE.openWindow(template, [args]);</h3>
 455  <p>This method opens a new window by the template data assigned, it will get the width, height and html data from template parameters. The args array contains variable names to be substituted.</p>
 456  <p>
 457  There are some custom window arguments:
 458  </p>
 459  <p>
 460  <table border="1" cellspacing="0" cellpadding="4">
 461  <thead>
 462  <tr>
 463      <td colspan="2">Parameters</td>
 464  </tr>
 465  </thead>
 466  <tbody>
 467  <tr>
 468      <td>mce_replacevariables</td>
 469      <td>Enables/Disables the language/variable replacement of the document HTML. Enabled by default.</td>
 470  </tr>
 471  <tr>
 472      <td>mce_windowresize</td>
 473      <td>Enables/Disables the auto resize feature of popupwindows. Enabled by default.</td>
 474  </tr>
 475  </tbody>
 476  </table>
 477  </p>
 478  
 479  <p>
 480  <table border="1" cellspacing="0" cellpadding="4">
 481  <thead>
 482  <tr>
 483      <td colspan="2">Parameters</td>
 484  </tr>
 485  </thead>
 486  <tbody>
 487  <tr>
 488      <td>template</td>
 489      <td>Name/Value array with width, height, html and file keys in it.</td>
 490  </tr>
 491  <tr>
 492      <td>[args]</td>
 493      <td>Name/Value array with variable names to replace. Variables in the template file key value (URL) gets replaced with the argument list.</td>
 494  </tr>
 495  </tbody>
 496  </table>
 497  </p>
 498  <p>
 499  Returns: None.
 500  </p>
 501  <div class="separator"></div>
 502  <h3>tinyMCE.getWindowArg(name, [default_value]);</h3>
 503  <p>
 504  This method returns a window argument defined by name. This function is to be used in theme popup windows to retrive dialog parameters.
 505  </p>
 506  <p>
 507  <table border="1" cellspacing="0" cellpadding="4">
 508  <thead>
 509  <tr>
 510      <td colspan="2">Parameters</td>
 511  </tr>
 512  </thead>
 513  <tbody>
 514  <tr>
 515      <td>name</td>
 516      <td>Name of window argument to get.</td>
 517  </tr>
 518  <tr>
 519      <td>[default_value]</td>
 520      <td>Default value to be returned if window argument is missing.</td>
 521  </tr>
 522  </tbody>
 523  </table>
 524  </p>
 525  <p>
 526  Returns: Window argument value.
 527  </p>
 528  <div class="separator"></div>
 529  <h3>tinyMCE.setWindowArg(name, value);</h3>
 530  <p>This method sets a window argument by name. This can for example be useful if plugin are to call other plugins.</p>
 531  <p>
 532  <table border="1" cellspacing="0" cellpadding="4">
 533  <thead>
 534  <tr>
 535      <td colspan="2">Parameters</td>
 536  </tr>
 537  </thead>
 538  <tbody>
 539  <tr>
 540      <td>name</td>
 541      <td>Name of window argument to set.</td>
 542  </tr>
 543  <tr>
 544      <td>value</td>
 545      <td>Value to set in window argument.</td>
 546  </tr>
 547  </tbody>
 548  </table>
 549  </p>
 550  <p>
 551  Returns: Window argument value.
 552  </p>
 553  <div class="separator"></div>
 554  <h3>tinyMCE.getParam(name, [default_value], [strip_whitespace]);</h3>
 555  <p>This method returns a TinyMCE configuration parameter.</p>
 556  <p>
 557  <table border="1" cellspacing="0" cellpadding="4">
 558  <thead>
 559  <tr>
 560      <td colspan="2">Parameters:</td>
 561  </tr>
 562  </thead>
 563  <tbody>
 564  <tr>
 565      <td>name</td>
 566      <td>Name of window argument to get.</td>
 567  </tr>
 568  <tr>
 569      <td>[default_value]</td>
 570      <td>Default value to be returned if window argument is missing.</td>
 571  </tr>
 572  <tr>
 573      <td>[strip_whitespace]</td>
 574      <td>If true all whitespace will be removed from return value, default: false.</td>
 575  </tr>
 576  </tbody>
 577  </table>
 578  </p>
 579  <p>
 580  Returns: TinyMCE configuration parameter.
 581  </p>
 582  </div>
 583  
 584  <div class="footer">
 585      <div class="helpindexlink"><a href="index.html">Index</a></div>
 586      <div class="copyright">Copyright &copy; 2005 Moxiecode Systems AB</div>
 587      <br style="clear: both" />
 588  </div>
 589  
 590  </body>
 591  </html>