Javascript 函数

针对高级用户，TinyMCE 有一个全局实例，可以在页面中调用它的公共函数。

tinyMCE.triggerSave([skip_cleanup], [skip_callback]);

对内容进行清除，并将编辑器内容放回到表单中。通过在表单提交方法中增加触发器，tinyMCE 会自动调用此函数。

参数
[skip_cleanup]	禁用触发器的清除功能。默认为 false。(可选)
[skip_callback]	禁用 save_callback 函数。默认为 false。(可选)

返回：无

tinyMCE.updateContent(form_element_name);

将表单中的内容放回到编辑器中，这与 triggerSave() 函数功能相反。当你想要动态更改编辑器内容时可以用这个方法。

参数
form_element_name	内容所在表单的名字。

返回：无

tinyMCE.execInstanceCommand(editor_id, command, [user_interface], [value]);

这个方法在根据 editor_id 参数指定的编辑器实例上执行一个命令。

参数
editor_id	编辑器实例的 ID 或者被替换的元素 ID。
command	要执行的命令，详细信息请查看 execCommand 函数。
[user_interface]	是否使用用户接口。
[value]	命令传递的参数，比如一个 URL ...

返回：无

tinyMCE.execCommand(command, [user_interface], [value]);

这个方法在选中的编辑器实例上执行方法。

参数

command

要执行的命令，比如 "Bold" 或 "Italic"。这些是根据 Mozilla Midas specification 或 Microsoft specification定义的。但是也有一些 TinyMCE 自己的特别命令，它们能在插件和主题中被使用。

mceLink	打开插入链接对话框并插入链接。
mceImage	打开插入图片对话框并插入图片。
mceCleanup	从 HTML 代码中清楚不需要的元素和属性。
mceHelp	打开手册页面。
mceAddControl	向元素增加编辑器控制，元素的 id/name 由 value 指定。
mceRemoveControl	通过 editor_id 来取消编辑器控制。 value 是要取消控制的编辑器的 editor_id ，编辑器 editor_id 格式如下： "mce_editor_<index>"。也可以使用DOM 元素的 id 和表单元素的 names 。
mceFocus	将焦点移到 value 指定的编辑器。编辑器ID的格式如下："mce_editor_"。也可以使用DOM元素的 id 和表单元素的 names。
mceSetCSSClass	设置 CSS class 的属性或者新建一个选择器的 span。 value 是选定组件的css class 的名称或者 span 元素的名称。
mceInsertContent	在当前鼠标的位置插入 value 参数的内容。
mceReplaceContent	将当前选择的内容替换成 value 的HTML代码。 {$selection} 变量的内容被替换成当前选定的内容。
mceSetAttribute	设置当前选定元素的属性。这个命令的值应该是一个含有下面参数的 name/value 数组。 name - 要设置的属性名称。 value - 要设置的属性值。 [targets] - 要增加属性的目标元素。默认是： p,img,span,div,td,h1,h2,h3,h4,h5,h6,pre,address。使用例子： tinyMCE.execCommand('mceSetAttribute',false,{name:'align',value:'right'});
mceToggleVisualAid	是否开启视觉辅助/指导模式。
mceAnchor	插入一个书签， value 是书签的名字。
mceResetDesignMode	重置所有编辑器实例的设计模式状态，如果在 Firefox 里编辑器被放在 tabs 或者通过 style.display="none/block" 来控制是否显示，这个命令是有效的。当编辑器重新显示后可以调用这个命令。
mceSelectNode	选择 value 指定的节点或者元素。这个命令同时会定位到编辑器中元素所在的位置。
mceSelectNodeDepth	从当前节点根据深度关系选择节点或者元素。所以深度为0会选择到当前焦点所在的节点。这个命令同时会定位到编辑器中元素所在的位置。
mceRemoveNode	去掉指定的节点，并将节点的内容放在同样的位置。如果要去除当前选择的节点，需要在 value 参数中指定或者置为 null。

[user_interface]

指定命令是否有用户接口。选项有 True/False 。

[value]

命令参数的值。例：如果要执行 insertLink 命令， value 是链接的URL

返回：无

例子:

<a href="javascript:tinymce.execCommand('Bold');">[Do bold]</a>

(建议不要使用) tinyMCE.insertLink(href, target);

建议不用使用这个命令，它在 2.0.3 版中已被去除了。可以使用 tinyMCE.execCommand('mceInsertContent',false,'custom html'); 来替代，以及使用 tinyMCE.getInstanceById('<inst>').selection.getFocusElement() 来更新选定的元素。

虽然被内部标记，但如果你真的需要用这个旧函数，可以在高级主题中使用。你可以通过 tinyMCE.themes['advanced']._insertLink(href, target);来使用。推荐使用上面的函数来修改你的代码。

这个命令在当前鼠标位置插入一个链接，或者更新选中的链接。在你创建的主题中，这个方法应该在插入链接对话框的OK按钮被按下时调用。

参数
href	链接的 HREF/URL 。
target	链接的目标。

返回：无

(建议不要使用) tinyMCE.insertImage(src, alt, border, hspace, vspace, width, height, align, title, onmouseover, onmouseout);

建议不用使用这个命令，它在 2.0.3 版中已被去除了。使用 tinyMCE.execCommand('mceInsertContent',false,'custom html'); 来替代。虽然被内部标记，但如果你真的需要用这个旧函数，可以在高级主题中使用。你可以通过 tinyMCE.themes['advanced']._insertImage(src, alt, border, hspace, vspace, width, height, align, title, onmouseover, onmouseout);来使用。推荐使用上面的函数来修改你的代码。

这个命令在当前鼠标位置插入图片，或者更新当前选择的图片。在你创建的主题中，这个方法应该在插入图片对话框的OK按钮被按下时调用。

参数
src	图片的URL。
alt	图片的替代文字。
border	图片边框大小。
hspace	图片水平间距。
vspace	图片垂直间距
width	图片宽度。
height	图片高度。
align	图片对齐方式。
title	图片链接的标题。
onmouseover	当鼠标移到图片上时的处理。
onmouseout	当鼠标移出图片时的处理。

返回：无

tinyMCE.triggerNodeChange();

当编辑器发生外部改变时这个方法被调用，然后方法会回调主题中的 "handleNodeChangeCallback" 方法。

参数：无

返回：无

tinyMCE.getContent();

如果有编辑器被选中，这个方法返回其中的 HTML 内容，否则返回 null 。

参数：无

返回：当前被选中编辑器中的 HTML 内容或者为 null。

Syntax: tinyMCE.setContent(html);

这个方法设置当前被选择编辑器中的内容。

参数
html	要设置的 HTML 源代码。

返回：无

tinyMCE.getInstanceById(editor_id);

这个方法根据 editor id 返回编辑器实例。

参数
editor_id	要返回的编辑器ID。

返回： TinyMCE 编辑器实例(TinyMCE_Control).

tinyMCE.importThemeLanguagePack([theme]);

这个方法导入主题的特定语言包。在自定义主题时被用到。

参数
[theme]	当前主题的名称。这是一个可选参数，默认是主题的全局设置。在主题插件中整个参数很有效。

返回：无

tinyMCE.importPluginLanguagePack(plugin, valid_languages);

这个方法导入插件的特定语言包。在自定义插件时被用到。

参数
plugin	当前插件的名称。
valid_languages	用逗号分隔开的所支持语言包列表。

返回：无

tinyMCE.applyTemplate(html);

这个方法改变主题中 setting 和 lang 变量。

参数
html	用来替换主题中变量的 HTML 代码。

返回：转后新的 HTML 代码。

tinyMCE.openWindow(template, [args]);

这个方法根据 template 变量获得的 width, height 和 html 参数来打开新窗口。args 数组中包含要替换的变量名。

这是一些定制窗口的参数：

参数
mce_replacevariables	是否打开HTML文件中的语言/变量替换。默认打开。
mce_windowresize	是否打开弹出窗口的自动重定大小特性(resize)。默认打开。

参数
template	包含 width, height, html 和 file keys 的名/值数组。
[args]	包含要替换变量名的名/值数组。模版文件中 key value (URL) 被参数列表替换。

返回：无

tinyMCE.getWindowArg(name, [default_value]);

这个方法根据 name 返回窗口参数。这个函数用来获得弹出对话框的内容参数。

参数
name	要获得参数的窗口的名字。
[default_value]	如果窗口参数丢失时的默认返回值。

返回：窗口参数值。

tinyMCE.setWindowArg(name, value);

这个方法通过 name 来设置窗口参数。例如，当一个插件要调用另一个插件时很有效。

参数
name	要设置的窗口参数的名称。
value	要设置的窗口参数的值。

返回：窗口参数值。

tinyMCE.getParam(name, [default_value], [strip_whitespace]);

这个方法返回 TinyMCE 的配置参数。

参数:
name	要获得的窗口参数的名称。
[default_value]	如果窗口参数丢失时的默认返回值。
[strip_whitespace]	若为 true ，将除去返回值中的空白，默认为 false。

返回： TinyMCE 的配置参数。