V3版本编辑器的javascript客户端常用接口
V3 版本为程序员提供了更加方便和简单的二次开发接口,程序员可以容易的为编辑器按照实际应用开发各种插件以扩展编辑器的功能。
当编辑器加载到某个页面(A页)后,页面将新增加一个编辑器对象(对象名为 $+编辑器ID,如$editor)。
A页面可以通过javascript代码, $eidotr来进一步调用编辑器的一些常见功能接口函数和对象。
如: $editor.pasteHTML("<img src='http://www.abc.com/logo.gif'>");
此代码意思是,往编辑器当前光标除加入一张图片。
| 常用功能接口函数 | 功能说明 | 参数说明 | 返回值 |
|---|---|---|---|
| setHTML(sHTML,savetohistory) | 设置编辑器的正文内容。 | 1)sHTML:正文内容
2)savetohistory:在设置正文内容后,是否同时记录在操作历史记录里面。 |
无 |
| getHTML() | 获取编辑器的正文内容的HTML代码。 如果启用编辑器的分页编辑功能,那么只获取当前页的正文内容。 | 无 | |
| getText() | 获取编辑器的正文纯文本内容。 主要用户获取文章摘要的用途。 | String | |
| pasteHTML(sHTML) | 在当前光标处插入html内容。 | sHTM: html代码内容 | 无 |
| hasContent() | 判断编辑器是否有内容。 | true/false | |
| onbeforesubmit() | 该函数在表单onsubmit事件函数执行后,表单提交前触发执行的。主要完成了客户端文件上传,url地址转换,html代码清理过滤等编辑器内部工作。PHP,JSP,ASP版本都将自动执行此函数,.net版本无需调用此函数。如果在您的表单页面中要调用此函数,主要是通常为了不修改后台代码,而又要兼容2.0版本所部署的应用。 | true/false | |
| getImagesURL() | 获取编辑器内容含有的图片地址。如果含多张图片地址,返回值使用"|"符号隔开。 | String | |
| getFlashsURL() | 获取编辑器中的Flash地址。如果含多个Flash地址,返回值使用"|"符号隔开。 | String | |
| getAttachFilesURL() | 获取所有附件地址。如果含多个附件地址,返回值使用"|"符号隔开。 | String | |
| getAllFiles() | 获取编辑器含有的图片,flash和附件。多个文件地址, 返回值使用"|"符号隔开。 | String | |
| getPageCount() | 返回编辑器当前分页编辑的总页面数。 | Number | |
| getAbsolutePage() | 获取当前所在分页的页码 | Number | |
| gotoAbsolutePage(sPage) | 转向到制定页码的分页 | sPage页码值。 | 无 |
| selectPic() | 弹出图片缩图选择对话框。 | String/null | |
| DesignModeEnable(b) | 是否允许编辑内容 | b为true或false | 无 |
| OnPasteEnable(b) | 是否允许粘贴 | b为true或false | 无 |
| OnSelectStartEnable(b) | 是否允许选择内容 | b为true或false | 无 |
| ContextMenuEnable(b) | 是否允许右键功能菜单 | b为true或false | 无 |
| getFileName(sStr,spliter) | 返回文件名 | 1)sStr为文件url地址。
2)spliter为地址分割符号。 如getFileName("c:\abc\d.jpg"),返回d.jpg。 如getFileName("http://www.abc.com/abc/d.jpg","/"),返回d.jpg。 |
String |
| getFileExt(sStr) | 返回文件的扩展名 | sStr为文件名,或文件url地址。 | String |
| isRemoteFile(url) | 判断url是否属于远程文件。 | true/false | |
| isRemoteWebSiteFile(url) | 判断url是否属于远程,而且不在本网站域下的文件。 | true/false |
| 接口对象 | 对象说明 |
|---|---|
| XEditor | 编辑器正文窗体对象。(*重要) |
| $toolbar | 编辑器工具栏对象。 |
| $browser | 浏览器信息对象。 |
| 接口对象的方法和属性 | 功能说明 | 参数说明 | 返回值 |
|---|---|---|---|
| XEditor.objselected | 获取编辑器当前的选中的对象 | ||
| XEditor.selectstatus | 获取编辑器当前的状态 | 0/1/2/3
0表示:选中多项内容。 1表示:没选中任何内容。 2表示:选中文本内容。 3表示:选中某个HTML对象。 | |
| $toolbar.display(s) | 控制编辑器是否显示工具栏。 | s为"display"或"none" | 无 |
| $browser.name | 返回浏览器的应用程序名称 | String | |
| $browser.version | 返回浏览器应用程序版本信息 | String | |
| $browser.language | 返回浏览器的语言设置 | String | |
| $browser.isIE | 返回是否属于ie内核的浏览器 | true/false | |
| $browser.isFireFox | 返回是否FireFox浏览器 | true/false |