Xheditor/API函数接口列表

来自站长百科
Qianlei讨论 | 贡献2011年12月27日 (二) 16:50的版本
(差异) ←上一版本 | 最后版本 (差异) | 下一版本→ (差异)
跳转至: 导航、​ 搜索

Xheditor | 入门基础 | 进阶使用|其它相关

API接口示例代码

   var editor=$('#elm1').xheditor({tools:'full',skin:'default'});

   editor.focus();

   editor.setSource('str')

   sHtml=editor.getSource()

   editor.appendHTML('<p>aaa</p>')

   editor.pasteHTML('<p>aaa</p>')

   editor.pasteText('str')

   sHtml=editor.formatXHTML('<b>aaa</b>')

   editor.toggleSource()

   editor.toggleFullscreen()

   alert(editor.settings.upImgExt);

   editor.settings.upImgExt='txt,doc'

API接口列表:

  • focus:使编辑器获得焦点

无参数

  • setSource:设置编辑器源代码

参数1:要设置的源代码内容,例:'

aaa

'

  • getSource:返回编辑器格式后的源代码

无参数

  • appendHTML:粘贴HTML内容到编辑器结尾处

参数1:要粘贴的HTML代码,例:'

uuu

' 注:0.9.5版添加

  • getSelect:返回当前选中的内容

参数1:返回格式,可选'text'返回文本格式,其它所有值都返回HTML格式

  • pasteHTML:粘贴HTML内容到编辑器当前光标处

参数1:要粘贴的HTML代码,例:'

uuu

'

参数2:是否覆盖粘贴,留空(覆盖粘贴)、true(粘贴在光标选择区域之前)、false(粘贴在光标选择区域之后)

  • pasteText:粘贴文本到编辑器当前光标处

参数1:要粘贴的文本,例:'这里的内容完全原样显示aaa'

参数2:是否覆盖粘贴,留空(覆盖粘贴)、true(粘贴在光标选择区域之前)、false(粘贴在光标选择区域之后)

  • formatXHTML:格式化XHTML代码

参数1:需要格式化的HTML代码,例:'aaa',返回'aaa'

参数2:是否代码缩进换行,true(执行缩进格式化),false(不执行缩进格式化),默认为false

  • toggleSource:在源代码模式和编辑模式之间切换

参数1:空(切换),true(显示源代码模式),false(显示编辑模式)

  • toggleFullscreen:在全屏模式和标准大小之间切换

参数1:空(切换),true(显示全屏模式),false(显示标准模式)

  • toggleShowBlocktag:切换块标签显示状态

参数1:空(切换),true(切换为显示块标签),false(切换为不显示块标签)

  • addShortcuts:添加快捷键

参数1:快捷键值,例:'ctrl+enter'

参数2:用户按下快捷键后需要响应的程序代码,例:function(){$('#frmTest').submit();}

说明:允许为某个相同快捷键值重复添加多个响应代码 备注:1.0.0 beta2新添加

  • delShortcuts:删除快捷键

参数1:快捷键值,例:'ctrl+enter'

备注:1.0.0 Final新添加

  • exec:立即执行按钮及插件

参数1:工具按钮名称(不区分大小写),例:Link、img 说明:此函数可以在插件内部或者外部Javascript代码中进行调用

  • showModal:显示模式窗口

参数1:模式窗口的标题title

参数2:模式窗口的内容content

参数3:模式窗口的宽度w

参数4:模式窗口的高度h

参数5:模式窗口关闭时的回调函数onRemove

  • showIframeModal:显示iframe式的模式窗口

参数1:模式窗口的标题

参数2:iframe的地址ifmurl,可使用内置变量:{editorRoot},代表当前编辑器的根路径,例:{editorRoot}xheditor_plugins/test.html

参数3:提供给目标iframe页面回调用的回调函数,可以在iframe页面中以这样的形式调用:callback('1.gif');

参数4:模式窗口的宽度w

参数5:模式窗口的高度h

参数6:模式窗口关闭时的回调函数onRemove

  • settings:获取或者修改编辑器内部参数
    internalScript:是否清除内部代码
    inlineScript:是否清除内联代码
    internalStyle:是否清除内部样式
    inlineStyle:是否清除内联样式
    forcePtag:强制使用P标签
    upLinkUrl:[[超链接]]上传接口地址
    upLinkExt:超链接本地上传扩展限制
    upImgUrl:图片上传接口地址
    upImgExt:图片本地上传扩展限制
    upFlashUrl:动画上传接口地址
    upFlashExt:动画本地上传扩展限制
    upMediaUrl:视频上传接口地址
    upMediaExt:视频本地上传扩展限制
    beforeSetSource:在设置源代码到[[编辑器]]前调用此函数
    beforeGetSource:从编辑器返回源代码前调用此函数
    focus:编辑器获得焦点时回调此函数
    blur:编辑器失去焦点时回调此函数

注:修改有效变量仅限以上,其它的变量都仅在编辑器初始化时使用

参考来源[ ]

Xheditor使用手册导航

入门基础

进阶使用

进阶使用指导|初始化参数列表|API函数接口列表|上传程序开发规范|插件开发指南|皮肤设计指南

其它相关