editor.execCommand("cmdName"[,opt]);
- *
- *
- * 检测当前命令是否可用的方法是
- * editor.queryCommandState("cmdName");
- *
- *
- * 部分命令可以返回命令值，其格式为
- * editor.queryCommandValue("cmdName");
- */
-/**
- * 插入锚点
- * @name anchor
- * @grammar editor.execCommand("anchor","name"); //锚点的名字
- */
-/**
- * 为当前选中文字添加粗体效果
- * @name bold
- * @grammar editor.execCommand("bold");
- */
-/**
- * 为当前选中文字添加斜体效果
- * @name italic
- * @grammar editor.execCommand("italic");
- */
-/**
- * 为当前选中文字添加下划线效果
- * @name underline
- * @grammar editor.execCommand("underline");
- */
-
-
-/**
- * 为当前选中文字添加删除线效果
- * @name strikethrough
- * @grammar editor.execCommand("strikethrough");
- */
-/**
- * 将当前选中文字转换成上标
- * @name superscript
- * @grammar editor.execCommand("superscript");
- */
-/**
- * 将当前选中文字转换成下标
- * @name subscript
- * @grammar editor.execCommand("subscript");
- */
-/**
- * 为当前选中文字添加颜色
- * @name foreColor
- * @grammar editor.execCommand("foreColor","#ffffff");
- */
-/**
- * 为当前选中文字添加背景颜色
- * @name backColor
- * @grammar editor.execCommand("backColor","#dddddd");
- */
-/**
- * 设置当前选中文字的字体
- * @name fontFamily
- * @grammar editor.execCommand("fontFamily","微软雅黑,Microsoft YaHei");
- */
-/**
- * 设置当前选中文字的字号
- * @name fontSize
- * @grammar editor.execCommand("fontSize","32px");
- */
-/**
- * 设置当前选区的段落格式,如p,h1,h2,h3,...
- * @name paragraph
- * @grammar editor.execCommand("paragraph","h1");
- */
-/**
- * 将当前选区变换成有序或者无序列表
- * @name insert(Un)OrderedList
- * @grammar editor.execCommand("insertOrderedList");
- */
-/**
- * 设置当前选区的行间距
- * @name lineHeight
- * @grammar editor.execCommand("lineHeight");
- */
-/**
- * 设置当前选区中的字体对齐方式
- * @name justify
- * @grammar editor.execCommand("justify",align); //align可为Left，Right，Center，Justify
- */
-/**
- * 将当前选中文字中的字母转换成大写
- * @name toUppercase
- * @grammar editor.execCommand("toUppercase");
- */
-/**
- * 将当前选中文字中的字母转换成小写
- * @name toLowercase
- * @grammar editor.execCommand("toLowercase");
- */
-/**
- * 为当前选区所在的块级元素添加引用标记
- * @name blockquote
- * @grammar editor.execCommand("blockquote");
- */
-/**
- * 设置当前选区所在块级元素的文字输入方向
- * @name directionality
- * @grammar editor.execCommand("directionality",dir); //dir可为LTR,RTL
- */
-/**
- * 清除当前选中文字上的所有样式或者指定样式
- * @name removeFormat
- * @grammar editor.execCommand("removeFormat") //根据ueditor.config.js里的removeFormatTags，removeFormatAttributes两个属性作为规则
- * @grammar editor.execCommand("removeFormat",tags,style); //清除指定tags上的指定style
- * @example
- * editor.execCommand("removeFormat",'span,a','color,background-color')
- */
-/**
- * 切换纯文本粘贴模式
- * @name pastePlain
- * @grammar ue.execCommand("pastePlain");
- */
-/**
- * 开启格式刷功能
- * @name formatMatch
- * @grammar editor.execCommand("formatMatch");
- */
-/**
- * 清空文档
- * @name clearDoc
- * @grammar editor.execCommand("clearDoc");
- */
-/**
- * 删除当前选中文本
- * @name delete
- * @grammar editor.execCommand("delete");
- */
-/**
- * 全部选择
- * @name selectAll
- * @grammar editor.execCommand("selectAll");
- */
-/**
- * 撤销操作
- * @name undo
- * @grammar editor.execCommand("undo");
- */
-/**
- * 恢复操作
- * @name redo
- * @grammar editor.execCommand("redo");
- */
-/**
- * 对整个编辑文档进行自动排版
- * @name autoTypeset
- * @grammar editor.execCommand("autoTypeset");
- */
-/**
- * 在当前选区位置插入一段html代码，最基本功能。大部分其他插入命令都会调用此命令完成最后的插入
- * @name insertHtml
- * @grammar editor.execCommand("insertHtml","欢迎使用UEditor！")
- */
-/**
- * 在当前选区位置插入一个超链接
- * @name link
- * @grammar editor.execCommand("link",linkObj);
- * @example
- * editor.execCommand("link",{
- * href: "http://ueditor.baidu.com", //超链地址，必选
- * _src: "http://ueditor.baidu.com", //UE内部使用参数，与href保持一致即可，可选
- * target: "_self", //目标窗口，可选
- * textValue: "UEditor", //链接显示文本，可选
- * title: "百度开源富文本编辑器UEditor官网" //标题，可选
- * })
- */
-/**
- * 在当前选区位置插入一个图片
- * @name insertImage
- * @grammar editor.execCommand("insertImage",imageObj);
- * @example
- * editor.execCommand("insertImage",{
- * src: "http://ueditor.baidu.com/logo.jpg", //图片链接地址,必选
- * _src: "http://ueditor.baidu.com/logo.jpg", //UE内部使用参数，与src保持一致即可，可选
- * width: 300, //图片显示宽度，可选
- * height: 400, //图片显示高度，可选
- * border: 2, //图片边框，可选
- * hspace: 5, //图片左右边距，可选
- * vspace: 2, //图片上下边距，可选
- * alt: 'UEditor-logo', //图片替换文字，可选
- * title: "百度开源富文本编辑器UEditor官网" //图片标题，可选
- * })
- */
-/**
- * 在当前选区位置插入一个视频
- * @name insertVideo
- * @grammar editor.execCommand("insertVideo",videoObj);
- * @example
- * editor.execCommand("insertVideo",{
- * url: "http://youku.com/id?id=1233122", //视频地址，必选
- * width: 420, //视频宽度，可选
- * height: 280, //视频高度，可选
- * align: "none" //对齐方式，支持right，left，center，none ，可选
- * })
- */
-/**
- * 在当前选区位置插入一个日期或者时间
- * @name date|time
- * @grammar editor.execCommand("date");
- */
-/**
- * 在当前选区位置插入一个分页符标记
- * @name pageBreak
- * @grammar editor.execCommand("pageBreak");
- */
-/**
- * 切换源码编辑模式和富文本编辑模式
- * @name source
- * @grammar editor.execCommand("source");
- */
-/**
- * IE下进入截屏模式
- * @name snapScreen
- * @grammar editor.execCommand("snapScreen");
- */
-/**
- * 插入表格
- * @name insertTable
- * @grammar editor.execCommand("insertTable",rows,cols);
- */
-
-/**
- * 查找替换
- * @name searchreplace
- * @grammar editor.execCommand("searchreplace",opt);
- * @desc
- * opt是个json对象,属性如下
- * * ''all'' true表示查找整个文档，false表示从上次的位置开始查找,默认是false
- * * ''casesensitive'' 大小写铭感，true是铭感,默认是false
- * * ''dir'' 1表示从前往后查，－1表示从后往前
- * * ''searchStr'' 查找的字符串
- * * ''replaceStr'' 替换用的字符串
- */
-
-
-
-
-
-
-
-
-
diff --git a/_src/core/Editor.js b/_src/core/Editor.js
index 2cc367d7e..687e919eb 100644
--- a/_src/core/Editor.js
+++ b/_src/core/Editor.js
@@ -1,18 +1,33 @@
/**
+ * 编辑器主类，包含编辑器提供的大部分公用接口
* @file
- * @name UE.Editor
- * @short Editor
- * @import editor.js,core/utils.js,core/EventBase.js,core/browser.js,core/dom/dtd.js,core/dom/domUtils.js,core/dom/Range.js,core/dom/Selection.js,plugins/serialize.js
- * @desc 编辑器主类，包含编辑器提供的大部分公用接口
+ * @module UE
+ * @class Editor
+ * @since 1.2.6.1
*/
+
+/**
+ * UEditor公用空间，UEditor所有的功能都挂载在该空间下
+ * @unfile
+ * @module UE
+ */
+
+/**
+ * UEditor的核心类，为用户提供与编辑器交互的接口。
+ * @unfile
+ * @module UE
+ * @class Editor
+ */
+
(function () {
var uid = 0, _selectionChangeTimer;
+
/**
+ * 获取编辑器的html内容，赋值到编辑器所在表单的textarea文本域里面
* @private
- * @ignore
- * @param form 编辑器所在的form元素
- * @param editor 编辑器实例对象
+ * @method setValue
+ * @param { UE.Editor } editor 编辑器事例
*/
function setValue(form, editor) {
var textarea;
@@ -41,7 +56,14 @@
(editor.options.allHtmlEnabled ? editor.getAllHtml() : editor.getContent(null, null, true)) :
''
}
- function loadPlugins(me){
+
+ /**
+ * 初始化插件
+ * @private
+ * @method loadPlugins
+ * @param { UE.Editor } editor 编辑器事例
+ */
+ function loadPlugins(me) {
//初始化插件
for (var pi in UE.plugins) {
UE.plugins[pi].call(me);
@@ -50,21 +72,168 @@
me.fireEvent("langReady");
}
- function checkCurLang(I18N){
- for(var lang in I18N){
+
+ /**
+ * 获取语言包列里面的第一种语言
+ * @private
+ * @method checkCurLang
+ * @param { Object } I18N 编辑器事例
+ */
+ function checkCurLang(I18N) {
+ for (var lang in I18N) {
return lang
}
}
+
+ /**
+ * 编辑器准备就绪后会触发该事件
+ * @module UE
+ * @class Editor
+ * @event ready
+ * @remind render方法执行完成之后,会触发该事件
+ * @remind
+ * @example
+ * ```javascript
+ * editor.addListener( 'ready', function( editor ) {
+ * editor.execCommand( 'focus' ); //编辑器家在完成后，让编辑器拿到焦点
+ * } );
+ * ```
+ */
+ /**
+ * 执行destroy方法,会触发该事件
+ * @module UE
+ * @class Editor
+ * @event destroy
+ * @see UE.Editor:destroy()
+ */
+ /**
+ * 执行reset方法,会触发该事件
+ * @module UE
+ * @class Editor
+ * @event reset
+ * @see UE.Editor:reset()
+ */
+ /**
+ * 执行focus方法,会触发该事件
+ * @module UE
+ * @class Editor
+ * @event focus
+ * @see UE.Editor:focus(Boolean)
+ */
+ /**
+ * 语言加载完成会触发该事件
+ * @module UE
+ * @class Editor
+ * @event langReady
+ */
+ /**
+ * 运行命令之后会触发该命令
+ * @module UE
+ * @class Editor
+ * @event beforeExecCommand
+ */
+ /**
+ * 运行命令之后会触发该命令
+ * @module UE
+ * @class Editor
+ * @event afterExecCommand
+ */
+ /**
+ * 运行命令之前会触发该命令
+ * @module UE
+ * @class Editor
+ * @event firstBeforeExecCommand
+ */
+ /**
+ * 在getContent方法执行之前会触发该事件
+ * @module UE
+ * @class Editor
+ * @event beforeGetContent
+ * @see UE.Editor:getContent()
+ */
+ /**
+ * 在getContent方法执行之后会触发该事件
+ * @module UE
+ * @class Editor
+ * @event afterGetContent
+ * @see UE.Editor:getContent()
+ */
+ /**
+ * 在getAllHtml方法执行时会触发该事件
+ * @module UE
+ * @class Editor
+ * @event getAllHtml
+ * @see UE.Editor:getAllHtml()
+ */
+ /**
+ * 在setContent方法执行之前会触发该事件
+ * @module UE
+ * @class Editor
+ * @event beforeSetContent
+ * @see UE.Editor:setContent(String)
+ */
+ /**
+ * 在setContent方法执行之后会触发该事件
+ * @module UE
+ * @class Editor
+ * @event afterSetContent
+ * @see UE.Editor:setContent(String)
+ */
+ /**
+ * 每当编辑器内部选区发生改变时，将触发该事件
+ * @event selectionchange
+ * @warning 该事件的触发非常频繁，不建议在该事件的处理过程中做重量级的处理
+ * @example
+ * ```javascript
+ * editor.addListener( 'selectionchange', function( editor ) {
+ * console.log('选区发生改变');
+ * }
+ */
+ /**
+ * 在所有selectionchange的监听函数执行之前，会触发该事件
+ * @module UE
+ * @class Editor
+ * @event beforeSelectionChange
+ * @see UE.Editor:selectionchange
+ */
/**
- * UEditor编辑器类
- * @name Editor
- * @desc 创建一个跟编辑器实例
- * - ***container*** 编辑器容器对象
- * - ***iframe*** 编辑区域所在的iframe对象
- * - ***window*** 编辑区域所在的window
- * - ***document*** 编辑区域所在的document对象
- * - ***body*** 编辑区域所在的body对象
- * - ***selection*** 编辑区域的选区对象
+ * 在所有selectionchange的监听函数执行完之后，会触发该事件
+ * @module UE
+ * @class Editor
+ * @event afterSelectionChange
+ * @see UE.Editor:selectionchange
+ */
+ /**
+ * 编辑器内容发生改变时会触发该事件
+ * @module UE
+ * @class Editor
+ * @event contentChange
+ */
+
+
+ /**
+ * 以默认参数构建一个编辑器实例
+ * @constructor
+ * @remind 通过 改构造方法实例化的编辑器,不带ui层.需要render到一个容器,编辑器实例才能正常渲染到页面
+ * @example
+ * ```javascript
+ * var editor = new UE.Editor();
+ * editor.execCommand('blod');
+ * ```
+ * @see UE.Config
+ */
+
+ /**
+ * 以给定的参数集合创建一个编辑器实例，对于未指定的参数，将应用默认参数。
+ * @constructor
+ * @remind 通过 改构造方法实例化的编辑器,不带ui层.需要render到一个容器,编辑器实例才能正常渲染到页面
+ * @param { Object } setting 创建编辑器的参数
+ * @example
+ * ```javascript
+ * var editor = new UE.Editor();
+ * editor.execCommand('blod');
+ * ```
+ * @see UE.Config
*/
var Editor = UE.Editor = function (options) {
var me = this;
@@ -79,7 +248,7 @@
me.setOpt({
isShow: true,
initialContent: '',
- initialStyle:'',
+ initialStyle: '',
autoClearinitialContent: false,
iframeCssUrl: me.options.UEDITOR_HOME_URL + 'themes/iframe.css',
textarea: 'editorValue',
@@ -99,14 +268,14 @@
allHtmlEnabled: false,
scaleEnabled: false,
tableNativeEditInFF: false,
- autoSyncData : true
+ autoSyncData: true
});
- if(!utils.isEmptyObject(UE.I18N)){
+ if (!utils.isEmptyObject(UE.I18N)) {
//修改默认的语言类型
me.options.lang = checkCurLang(UE.I18N);
loadPlugins(me)
- }else{
+ } else {
utils.loadFile(document, {
src: me.options.langPath + me.options.lang + "/" + me.options.lang + ".js",
tag: "script",
@@ -120,17 +289,21 @@
UE.instants['ueditorInstant' + me.uid] = me;
};
Editor.prototype = {
+
+
/**
- * 当编辑器ready后执行传入的fn,如果编辑器已经完成ready，就马上执行fn，fn的中的this是编辑器实例。
- * 大部分的实例接口都需要放在该方法内部执行，否则在IE下可能会报错。
- * @name ready
- * @grammar editor.ready(fn) fn是当编辑器渲染好后执行的function
+ * 编辑器对外提供的监听ready事件的接口， 通过调用该方法，达到的效果与监听ready事件是一致的
+ * @method ready
+ * @param { Function } fn 编辑器ready之后所执行的回调, 如果在注册事件之前编辑器已经ready，将会
+ * 立即触发该回调。
+ * @remind 需要等待编辑器加载完成后才能执行的代码,可以使用该方法传入
* @example
- * var editor = new UE.ui.Editor();
- * editor.render("myEditor");
- * editor.ready(function(){
- * editor.setContent("欢迎使用UEditor！");
- * })
+ * ```javascript
+ * editor.ready( function( editor ) {
+ * editor.setContent('初始化完毕');
+ * } );
+ * ```
+ * @see UE.Editor.event:ready
*/
ready: function (fn) {
var me = this;
@@ -138,10 +311,33 @@
me.isReady ? fn.apply(me) : me.addListener('ready', fn);
}
},
+
+
+ /**
+ * 该方法是提供给插件里面使用，设置配置项默认值
+ * @method setOpt
+ * @warning 三处设置配置项的优先级: 实例化时传入参数 > setOpt()设置 > config文件里设置
+ * @warning 该方法仅供编辑器插件内部和编辑器初始化时调用，其他地方不能调用。
+ * @param { String } key 编辑器的可接受的选项名称
+ * @param { * } val 该选项可接受的值
+ * @example
+ * ```javascript
+ * editor.setOpt( 'initContent', '欢迎使用编辑器' );
+ * ```
+ */
+
/**
- * 为编辑器设置默认参数值。若用户配置为空，则以默认配置为准
- * @grammar editor.setOpt(key,value); //传入一个键、值对
- * @grammar editor.setOpt({ key:value}); //传入一个json对象
+ * 该方法是提供给插件里面使用，以{key:value}集合的方式设置插件内用到的配置项默认值
+ * @method setOpt
+ * @warning 三处设置配置项的优先级: 实例化时传入参数 > setOpt()设置 > config文件里设置
+ * @warning 该方法仅供编辑器插件内部和编辑器初始化时调用，其他地方不能调用。
+ * @param { Object } options 将要设置的选项的键值对对象
+ * @example
+ * ```javascript
+ * editor.setOpt( {
+ * 'initContent': '欢迎使用编辑器'
+ * } );
+ * ```
*/
setOpt: function (key, val) {
var obj = {};
@@ -152,10 +348,15 @@
}
utils.extend(this.options, obj, true);
},
+
+
/**
- * 销毁编辑器实例对象
- * @name destroy
- * @grammar editor.destroy();
+ * 销毁编辑器实例，使用textarea代替
+ * @method destroy
+ * @example
+ * ```javascript
+ * editor.destroy();
+ * ```
*/
destroy: function () {
@@ -185,83 +386,94 @@
}
UE.delEditor(key);
},
+
/**
- * 渲染编辑器的DOM到指定容器，必须且只能调用一次
- * @name render
- * @grammar editor.render(containerId); //可以指定一个容器ID
- * @grammar editor.render(containerDom); //也可以直接指定容器对象
+ * 渲染编辑器的DOM到指定容器
+ * @method render
+ * @param { String } containerId 指定一个容器ID
+ * @remind 执行该方法,会触发ready事件
+ * @warning 必须且只能调用一次
+ */
+
+ /**
+ * 渲染编辑器的DOM到指定容器
+ * @method render
+ * @param { Element } containerDom 直接指定容器对象
+ * @remind 执行该方法,会触发ready事件
+ * @warning 必须且只能调用一次
*/
render: function (container) {
var me = this,
options = me.options,
- getStyleValue=function(attr){
- return parseInt(domUtils.getComputedStyle(container,attr));
+ getStyleValue = function (attr) {
+ return parseInt(domUtils.getComputedStyle(container, attr));
};
if (utils.isString(container)) {
container = document.getElementById(container);
}
if (container) {
- if(options.initialFrameWidth){
+ if (options.initialFrameWidth) {
options.minFrameWidth = options.initialFrameWidth
- }else{
+ } else {
options.minFrameWidth = options.initialFrameWidth = container.offsetWidth;
}
- if(options.initialFrameHeight){
+ if (options.initialFrameHeight) {
options.minFrameHeight = options.initialFrameHeight
- }else{
+ } else {
options.initialFrameHeight = options.minFrameHeight = container.offsetHeight;
}
- container.style.width = /%$/.test(options.initialFrameWidth) ? '100%' : options.initialFrameWidth-
- getStyleValue("padding-left")- getStyleValue("padding-right") +'px';
- container.style.height = /%$/.test(options.initialFrameHeight) ? '100%' : options.initialFrameHeight -
- getStyleValue("padding-top")- getStyleValue("padding-bottom") +'px';
+ container.style.width = /%$/.test(options.initialFrameWidth) ? '100%' : options.initialFrameWidth -
+ getStyleValue("padding-left") - getStyleValue("padding-right") + 'px';
+ container.style.height = /%$/.test(options.initialFrameHeight) ? '100%' : options.initialFrameHeight -
+ getStyleValue("padding-top") - getStyleValue("padding-bottom") + 'px';
container.style.zIndex = options.zIndex;
- var html = ( ie && browser.version < 9 ? '' : '') +
- '' +
- '' +
- ( options.iframeCssUrl ? '' : '' ) +
- (options.initialStyle ? '' : '') +
- '' +
- '';
+ var html = ( ie && browser.version < 9 ? '' : '') +
+ '' +
+ '' +
+ ( options.iframeCssUrl ? '' : '' ) +
+ (options.initialStyle ? '' : '') +
+ '' +
+ '';
container.appendChild(domUtils.createElement(document, 'iframe', {
id: 'ueditor_' + me.uid,
width: "100%",
height: "100%",
frameborder: "0",
- src: 'javascript:void(function(){document.open();' + (options.customDomain && document.domain != location.hostname ? 'document.domain="' + document.domain + '";' : '') +
+ src: 'javascript:void(function(){document.open();' + (options.customDomain && document.domain != location.hostname ? 'document.domain="' + document.domain + '";' : '') +
'document.write("' + html + '");document.close();}())'
}));
container.style.overflow = 'hidden';
//解决如果是给定的百分比，会导致高度算不对的问题
- setTimeout(function(){
- if( /%$/.test(options.initialFrameWidth)){
+ setTimeout(function () {
+ if (/%$/.test(options.initialFrameWidth)) {
options.minFrameWidth = options.initialFrameWidth = container.offsetWidth;
container.style.width = options.initialFrameWidth + 'px';
}
- if(/%$/.test(options.initialFrameHeight)){
+ if (/%$/.test(options.initialFrameHeight)) {
options.minFrameHeight = options.initialFrameHeight = container.offsetHeight;
container.style.height = options.initialFrameHeight + 'px';
}
})
}
},
+
/**
* 编辑器初始化
+ * @method _setup
* @private
- * @ignore
- * @param {Element} doc 编辑器Iframe中的文档对象
+ * @param { Element } doc 编辑器Iframe中的文档对象
*/
_setup: function (doc) {
@@ -291,11 +503,11 @@
for (var form = this.iframe.parentNode; !domUtils.isBody(form); form = form.parentNode) {
if (form.tagName == 'FORM') {
me.form = form;
- if(me.options.autoSyncData){
- domUtils.on(me.window,'blur',function(){
- setValue(form,me);
+ if (me.options.autoSyncData) {
+ domUtils.on(me.window, 'blur', function () {
+ setValue(form, me);
});
- }else{
+ } else {
domUtils.on(form, 'submit', function () {
setValue(this, me);
});
@@ -388,17 +600,24 @@
!options.isShow && me.setHide();
options.readonly && me.setDisabled();
},
+
/**
- * 同步编辑器的数据，为提交数据做准备，主要用于你是手动提交的情况
- * @name sync
- * @grammar editor.sync(); //从编辑器的容器向上查找，如果找到就同步数据
- * @grammar editor.sync(formID); //formID制定一个要同步数据的form的id,编辑器的数据会同步到你指定form下
- * @desc
- * 后台取得数据得键值使用你容器上得''name''属性，如果没有就使用参数传入的''textarea''
+ * 同步数据到编辑器所在的form
+ * 从编辑器的容器节点向上查找form元素，若找到，就同步编辑内容到找到的form里，为提交数据做准备，主要用于是手动提交的情况
+ * 后台取得数据的键值，使用你容器上的name属性，如果没有就使用参数里的textarea项
+ * @method sync
* @example
+ * ```javascript
* editor.sync();
* form.sumbit(); //form变量已经指向了form元素
- *
+ * ```
+ */
+
+ /**
+ * 根据传入的formId，在页面上查找要同步数据的表单，若找到，就同步编辑内容到找到的form里，为提交数据做准备
+ * 后台取得数据的键值，该键值默认使用给定的编辑器容器的name属性，如果没有name属性则使用参数项里给定的“textarea”项
+ * @method sync
+ * @param { String } formID 指定一个要同步数据的form的id,编辑器的数据会同步到你指定form下
*/
sync: function (formId) {
var me = this,
@@ -408,12 +627,18 @@
}, true);
form && setValue(form, me);
},
+
/**
* 设置编辑器高度
- * @name setHeight
- * @grammar editor.setHeight(number); //纯数值，不带单位
+ * @method setHeight
+ * @remind 当配置项autoHeightEnabled为真时,该方法无效
+ * @param { Number } number 设置的高度值，纯数值，不带单位
+ * @example
+ * ```javascript
+ * editor.setHeight(number);
+ * ```
*/
- setHeight: function (height,notSetHeight) {
+ setHeight: function (height, notSetHeight) {
if (height !== parseInt(this.iframe.parentNode.style.height)) {
this.iframe.parentNode.style.height = height + 'px';
}
@@ -422,6 +647,29 @@
this.body.style.height = height + 'px';
},
+ /**
+ * 为编辑器的编辑命令提供快捷键
+ * 这个接口是为插件扩展提供的接口,主要是为新添加的插件，如果需要添加快捷键，所提供的接口
+ * @method addshortcutkey
+ * @param { Object } keyset 命令名和快捷键键值对对象，多个按钮的快捷键用“＋”分隔
+ * @example
+ * ```javascript
+ * editor.addshortcutkey({
+ * "Bold" : "ctrl+66",//^B
+ * "Italic" : "ctrl+73", //^I
+ * });
+ * ```
+ */
+ /**
+ * 这个接口是为插件扩展提供的接口,主要是为新添加的插件，如果需要添加快捷键，所提供的接口
+ * @method addshortcutkey
+ * @param { String } cmd 触发快捷键时，响应的命令
+ * @param { String } keys 快捷键的字符串，多个按钮用“＋”分隔
+ * @example
+ * ```javascript
+ * editor.addshortcutkey("Underline", "ctrl+85"); //^U
+ * ```
+ */
addshortcutkey: function (cmd, keys) {
var obj = {};
if (keys) {
@@ -431,6 +679,12 @@
}
utils.extend(this.shortcutkeys, obj)
},
+
+ /**
+ * 对编辑器设置keydown事件监听，绑定快捷键和命令，当快捷键组合触发成功，会响应对应的命令
+ * @method _bindshortcutKeys
+ * @private
+ */
_bindshortcutKeys: function () {
var me = this, shortcutkeys = this.shortcutkeys;
me.addListener('keydown', function (type, e) {
@@ -447,7 +701,7 @@
) ||
keyCode == RegExp.$1
) {
- if (me.queryCommandState(i,param) != -1)
+ if (me.queryCommandState(i, param) != -1)
me.execCommand(i, param);
domUtils.preventDefault(e);
}
@@ -457,19 +711,38 @@
}
});
},
+
/**
- * 获取编辑器内容
- * @name getContent
- * @grammar editor.getContent() => String //若编辑器中只包含字符"<p><br /></p/>"会返回空。
- * @grammar editor.getContent(fn) => String
+ * 获取编辑器的内容
+ * @method getContent
+ * @warning 该方法获取到的是经过编辑器内置的过滤规则进行过滤后得到的内容
+ * @return { String } 编辑器的内容字符串, 如果编辑器的内容为空，或者是空的标签内容（如:”<p><br/></p>“）， 则返回空字符串
* @example
- * getContent默认是会现调用hasContents来判断编辑器是否为空，如果是，就直接返回空字符串
- * 你也可以传入一个fn来接替hasContents的工作，定制判断的规则
- * editor.getContent(function(){
- * return false //编辑器没有内容 ，getContent直接返回空
- * })
+ * ```javascript
+ * //编辑器html内容:123456
+ * var content = editor.getContent(); //返回值:123456
+ * ``` */ - getContent: function (cmd, fn,notSetCursor,ignoreBlank,formatter) { + + /** + * 获取编辑器的内容。 可以通过参数定义编辑器内置的判空规则 + * @method getContent + * @param { Function } fn 自定的判空规则， 要求该方法返回一个boolean类型的值， + * 代表当前编辑器的内容是否空， + * 如果返回true， 则该方法将直接返回空字符串；如果返回false，则编辑器将返回 + * 经过内置过滤规则处理后的内容。 + * @remind 该方法在处理包含有初始化内容的时候能起到很好的作用。 + * @warning 该方法获取到的是经过编辑器内置的过滤规则进行过滤后得到的内容 + * @return { String } 编辑器的内容字符串 + * @example + * ```javascript + * // editor 是一个编辑器的实例 + * var content = editor.getContent( function ( editor ) { + * return editor.body.innerHTML === '欢迎使用UEditor'; //返回空字符串 + * } ); + * ``` + */ + getContent: function (cmd, fn, notSetCursor, ignoreBlank, formatter) { var me = this; if (cmd && utils.isFunction(cmd)) { fn = cmd; @@ -479,15 +752,20 @@ return ''; } me.fireEvent('beforegetcontent'); - var root = UE.htmlparser(me.body.innerHTML,ignoreBlank); + var root = UE.htmlparser(me.body.innerHTML, ignoreBlank); me.filterOutputRule(root); me.fireEvent('aftergetcontent', cmd); return root.toHtml(formatter); }, + /** * 取得完整的html代码，可以直接显示成完整的html文档 - * @name getAllHtml - * @grammar editor.getAllHtml() => String + * @method getAllHtml + * @return { String } 编辑器的内容html文档字符串 + * @eaxmple + * ```javascript + * editor.getAllHtml(); //返回格式大致是: ...... + * ``` */ getAllHtml: function () { var me = this, @@ -508,10 +786,16 @@ + (headHtmlForIE9 || me.document.getElementsByTagName('head')[0].innerHTML) + headHtml.join('\n') + '' + '' + me.getContent(null, null, true) + '