当前位置:文档之家› ueitor1.4.3 jsp使用说明

ueitor1.4.3 jsp使用说明

前端配置项说明

UEditor 的配置项分为两类:前端配置项和后端配置项

后端配置项具体看这个文档L:后端配置项说明

本文档介绍如何通过设置前端配置项,定制编辑器的特性,配置方法主要通过修改ueditor.config.js,另外在编辑器实例化的时候也可以传入配置参数

读取配置项可以通过getOpt方法读取

以下的"URL"是ueditor.config.js文件所在目录

?UEDITOR_HOME_URL {Path String} [默认值:根据config文件路径自动获取] // 为编辑器实例添加一个路径,这个不能被注释

?serverUrl {Path String} [默认值:URL + "php/controller.php"] // 服务器统一请求接口路径

?toolbars {2d Array} //工具栏上的所有的功能按钮和下拉框,可以在new编辑器的实例时选择自己需要的从新定义

?labelMap {Object} [默认:从lang包的labelMap项获取] //参数格式是键值对,键名对应toolbar参数的项:{"bold": "加粗"} ],当鼠标放在工具栏上时显示的tooltip 提示,留空支持自动多语言配置,否则以配置值为准

?lang {String} [默认值:"zh-cn"] //lang值也可以通过自动获取

(https://www.doczj.com/doc/e512801210.html,nguage||navigator.browserLanguage

||https://www.doczj.com/doc/e512801210.html,erLanguage).toLowerCase(),语言配置项,默认是zh-cn。有需要的话也可以使用如下这样的方式来自动多语言切换,当然,前提条件是lang文件夹下存在对应的语言文件:

?langPath {Path String} [默认值:URL +"lang/"] //语言包文件存放目录

?theme {String} [默认值:'default'] //主题配置项,默认是default。有需要的话也可以使用如下这样的方式来自动多主题切换,当然,前提条件是themes文件夹下存在对应的主题文件:

?themePath {Path String} [默认值:URL +"themes/"] //现有如下皮肤:default

?zIndex {Number} [默认值:900] //编辑器在页面上的z-index层级的基数,默认是900

?charset {String} [默认值:"utf-8"] //针对getAllHtml方法,会在对应的head标签中增加该编码设置。

?customDomain {Boolean} [默认值:false] //若实例化编辑器的页面手动修改的domain,此处需要设置为true

?isShow {Boolean} [默认值:true] //默认显示编辑器

?textarea {String} [默认值:'editorValue'] // 提交表单时,服务器获取编辑器提交内容的所用的参数,多实例时可以给容器name属性,会将name给定的值最为每个实例的键值,不用每次实例化的时候都设置这个值

?initialContent {String} [默认值:'欢迎使用ueditor!'] //初始化编辑器的内容,也可以通过textarea/script给值,看官网例子

?autoClearinitialContent {Boolean} [默认值:true] //是否自动清除编辑器初始内容,注意:如果focus属性设置为true,这个也为真,那么编辑器一上来就会触发导致初始化的内容看不到了

?focus {Boolean} [默认值:false] //初始化时,是否让编辑器获得焦点true或false ?initialStyle {String} [默认值:'p{line-height:1em}']//编辑器层级的基数,可以用来改变字体等//如果自定义,最好给p标签如下的行高,要不输入中文时,会有跳动感?iframeCssUrl {Path String} [默认值:URL + '/themes/iframe.css'] //给编辑器内部引入一个css文件

?indentValue {String} [默认值:'2em'] //首行缩进距离,默认是2em

?initialFrameWidth {Number} [默认值:1000] //初始化编辑器宽度,默认1000

?initialFrameHeight {Number} [默认值:320] //初始化编辑器高度,默认320

?readonly {Boolean} [默认值:false] //编辑器初始化结束后,编辑区域是否是只读的,默认是false

?autoClearEmptyNode {Boolean} [默认值:true] //getContent时,是否删除空的inlineElement节点(包括嵌套的情况)

?enableAutoSave {Boolean} [默认值:true] //启用自动保存

?saveInterval {Number} [默认值:500] //自动保存间隔时间,单位ms

?imageScaleEnabled {Boolean} [默认值:true] //启用图片拉伸缩放

?fullscreen {Boolean} [默认值:false] //是否开启初始化时即全屏,默认关闭

?imagePopup {Boolean} [默认值:true] //图片操作的浮层开关,默认打开

?autoSyncData {Boolean} [默认值:true] //自动同步编辑器要提交的数据

?emotionLocalization {Boolean} [默认值:false] //是否开启表情本地化,默认关闭。若要开启请确保emotion文件夹下包含官网提供的images表情文件夹

?retainOnlyLabelPasted {Boolean} [默认值:false] //粘贴只保留标签,去除标签所有属性

?pasteplain {Boolean} [默认值:false] //是否默认为纯文本粘贴。false为不使用纯文本粘贴,true为使用纯文本粘贴

?filterTxtRules {Object} //纯文本粘贴模式下的过滤规则

?allHtmlEnabled [默认值:false] //提交到后台的数据是否包含整个html字符串

?insertorderedlist //有序列表的下拉配置,值留空时支持多语言自动识别,若配置值,则以此值为准

?insertunorderedlist //无序列表的下拉配置,值留空时支持多语言自动识别,若配置值,则以此值为准

`

?listDefaultPaddingLeft [默认值:'30'//默认的左边缩进的基数倍

?listiconpath [默认值:'https://www.doczj.com/doc/e512801210.html,/listicon/']//自定义标号的路径?maxListLevel [默认值:3] //限制可以tab的级数,设置-1为不限制

?autoTransWordToList [默认值:false] //禁止word中粘贴进来的列表自动变成列表标签

?fontfamily //字体设置label留空支持多语言自动切换,若配置,则以配置值为准

?fontsize {Array} //字号

?paragraph {Object} //段落格式值留空时支持多语言自动识别,若配置,则以配置值为准

?rowspacingtop {Array} //段间距值和显示的名字相同

?rowspacingbottom //段间距值和显示的名字相同

?lineheight [默认值:['1', '1.5','1.75','2', '3', '4', '5'] ] //行内间距值和显示的名字相同

?customstyle [Array] //自定义样式,不支持国际化,此处配置值即可最后显示值block 的元素是依据设置段落的逻辑设置的,inline的元素依据BIU的逻辑设置,尽量使用一些常用的标签

?enableContextMenu {Boolean} [默认值:true] //打开右键菜单功能

?contextMenu {Object} //右键菜单的内容,可以参考plugins/contextmenu.js里边的默认菜单的例子,label留空支持国际化,否则以此配置为准

?shortcutMenu {Array} //快捷菜单

?elementPathEnabled {Boolean} [默认值:true] //是否启用元素路径,默认是显示?wordCount {Boolean} [默认值:true] //是否开启字数统计

?maximumWords {Number} [默认值:10000] //允许的最大字符数

?wordCountMsg {String} [默认值:] //当前已输入{#count} 个字符,您还可以输入{#leave} 个字符,字数统计提示,{#count}代表当前字数,{#leave}代表还可以输入多少字符数,留空支持多语言自动切换,否则按此配置显示

?wordOverFlowMsg {String} [默认值:] //超出字数限制提示留空支持多语言自动切换,否则按此配置显示

?tabSize {Number} [默认值:4] //点击tab键时移动的距离,tabSize倍数,tabNode 什么字符做为单位

?tabNode {String} [默认值:' ']

?removeFormatTags //清除格式时可以删除的标签和属性

?removeFormatAttributes [默认值:

'class,style,lang,width,height,align,hspace,valign'

?maxUndoCount {Number} [默认值:20] //undo操作,可以最多回退的次数,默认20

?maxInputCount {Number} [默认值:1] //undo操作,当输入的字符数超过该值时,保存一次现场

?autoHeightEnabled {Boolean} [默认值:true] //是否自动长高,默认true

?scaleEnabled {Boolean} [默认值:false] //是否可以拉伸长高,默认true(当开启时,自动长高失效)

?minFrameWidth {Number} [默认值:800] //编辑器拖动时最小宽度,默认800 ?minFrameHeight {Number} [默认值:220] //编辑器拖动时最小高度,默认220 ?autoFloatEnabled [默认值:true] //是否保持toolbar的位置不动,默认true

?topOffset [默认值:30] //浮动时工具栏距离浏览器顶部的高度,用于某些具有固定头部的页面

?toolbarTopOffset [默认值:400] //编辑器底部距离工具栏高度(如果参数大于等于编辑器高度,则设置无效)

?pageBreakTag [默认值:'ueditor page break tag'] //分页标识符,默认是

ueditor page break tag

?autotypeset {Object} //自动排版参数默认值:

?tableDragable {Boolean} [默认值:true] //表格是否可以拖拽

?disabledTableInTable {Boolean} [默认值:true] //禁止表格嵌套

?sourceEditor {String} [默认值:"codemirror"] //源码的查看方式,codemirror是代码高亮,textarea是文本框,默认是codemirror,注意默认codemirror只能在ie8+和非ie中使用

?codeMirrorJsUrl {Path String} [默认值:URL +

"third-party/codemirror/codemirror.js"] //如果sourceEditor是codemirror需要配置这项,codeMirror js加载的路径

?codeMirrorCssUrl {Path String} [默认值:URL +

"third-party/codemirror/codemirror.css"] //如果sourceEditor是codemirror需要配置这项,codeMirror css加载的路径

?sourceEditorFirst {String} [默认值:false] //编辑器初始化完成后是否进入源码模式,默认为否。

?iframeUrlMap {Object} //dialog内容的路径~会被替换成URL,垓属性一旦打开,将覆盖所有的dialog的默认路径

?webAppKey {String} //webAppKey 百度应用的APIkey,每个站长必须首先去百度官网注册一个key后方能正常使用app功能,注册介绍,

https://www.doczj.com/doc/e512801210.html,/static/cms/getapikey.html

?allowDivTransToP {Boolean} 默认会将外部进入的html数据中的Div标签转换成P 标签,外部进入的数据包括粘贴和调用setContent接口进入编辑器的数据。如果设置成false将不在做这个转换。

后端配置项说明

ueditor的配置项分为两类:前端配置项和后端配置项

前端配置项具体看这个文档:前端配置项说明

本文档介绍后端配置项的使用

前后端的配置统一写在后端(PHP版本的config在php/config.json),编辑器实例化时,异步读取后端配置信息,覆盖到前端的配置里。

后端获取的配置项> 实例化传入的配置项> ueditor.config.js文件的配置项。

读取配置项可以通过getOpt方法读取

实例化的ue对象上有以下几个方法:

?[方法]:loadServerConfig执行这个方法,会向后端请求config

?[方法]:isServerConfigLoaded判断是否已加载后端config

?[方法]:afterConfigReady加载后端配置项结束后会执行回调函数,假如已加载,立即执行该回调函数

?[事件]:serverConfigLoaded加载后端配置项结束后,会触发这个事件

1. 上传图片配置项

?imageCompressEnable {Boolean} [默认值:true] //是否压缩图片,默认是true ?imageCompressBorder {Number} [默认值:1600] //图片压缩最长边限制

?imageInsertAlign {String} [默认值:"none"] //插入的图片浮动方式

?imageUrlPrefix {String} [默认值:""] //图片访问路径前缀

?imagePathFormat {String} [默认值:

"/ueditor/php/upload/image/{yyyy}{mm}{dd}/{time}{rand:6}"] //上传保存路径,可以自定义保存路径和文件名格式,上传路径配置

2. 涂鸦图片上传配置项

?scrawlActionName {String} [默认值:"uploadscrawl"] //执行上传涂鸦的action名称

?scrawlFieldName {String} [默认值:"upfile"] //提交的图片表单名称

?scrawlPathFormat {String} [默认值:

"/ueditor/php/upload/image/{yyyy}{mm}{dd}/{time}{rand:6}"] //上传保存路径,可以自定义保存路径和文件名格式,上传路径配置

?scrawlMaxSize {Number} [默认值:2048000] //上传大小限制,单位B

?scrawlUrlPrefix {String} [默认值:""] //图片访问路径前缀

?scrawlInsertAlign {String} [默认值:"none"]

3. 截图工具上传

?snapscreenActionName {String} [默认值:"uploadimage"] //执行上传截图的action 名称

?snapscreenPathFormat {String} [默认值:

"/ueditor/php/upload/image/{yyyy}{mm}{dd}/{time}{rand:6}"] //上传保存路径,可以自定义保存路径和文件名格式,上传路径配置

?snapscreenUrlPrefix {String} [默认值:""] //图片访问路径前缀

?snapscreenInsertAlign {String} "none", //插入的图片浮动方式

4. 抓取远程图片配置

?catcherLocalDomain {Array} 默认值:["127.0.0.1", "localhost",

"https://www.doczj.com/doc/e512801210.html,"]//例外的图片抓取域名

?catcherActionName {String} [默认值:"catchimage"] //执行抓取远程图片的action 名称

?catcherFieldName {String} [默认值:"source"] //提交的图片列表表单名称

?catcherPathFormat {String} [默认值:

"/ueditor/php/upload/image/{yyyy}{mm}{dd}/{time}{rand:6}"] //上传保存路径,可以自定义保存路径和文件名格式,上传路径配置

5. 上传视频配置

6. 上传文件配置

7. 列出指定目录下的图片

?imageManagerActionName {String} [默认值:"listimage"] //执行图片管理的action 名称

?imageManagerListPath {String} [默认值:"/ueditor/php/upload/image/"] //指定要列出图片的目录

相关主题
文本预览
相关文档 最新文档