API列表

接口声明

js回调java的接口设计

文字文档

文字文档行为的回调接口

ActionJSCallback

//搜索结果数量返回
void onSearchResult(String result);
//编辑器获得focus后回调
void onEditorFocus();
//触摸后回调
void onTouchStart();
//点击link链接回调
void onLinkClick(Link link);

文档编辑器协作模块的回调接口

CollaborationJSCallback

//编辑器协作连接成功时触发此事件
void onCollaborationSuccess();
//编辑器协作连接异常时触发此事件
void onCollaborationError();
//token无效时，触发
void onTokenInvalid();
//离线内容回调
void saveDocContent(String content);
//离线ops回调
void saveOfflineOps(String ops);
//文档不存在
void onDocNotExist();

文字文档样式修改模块的回调接口

FormatJSCallback

//格式当前选区selection变化 触发
void onFormatChange(IFlyDocsFormatInfo format);

文字文档其他功能的回调接口

NoteEditorEventHandler

//DOM加载完成后回调
void onDomLoaded();
//刷新token
void refreshToken();
//音频信息回调
void onAudioMore(AudioInfo info);
//图片
void onImagePreview(ImageListBean bean);
//撤销状态
void queryUndoRedoState(UndoRedoState state);
//文件下载
void onFileDownload(String objectId,String name, int size, String type);
//字数统计
void onTextCount(TextLength textLength);
//选区改变
void onSelectionChange(String param);
//读
void onRead(ReadTextBean data);
//html
void onHtmlData(String param);
//双击
void onDbClick();
//占位
void transferPlaceholder(String param);
//重新上传
void retryUpload(String param, String type);
//粘贴板
void onClipboardFile(String param, String type);
//取消上传
void cancelUpload(String param);
//同步状态
void syncState();
//批注相关的回调
void editorAnnotation(String param);

void mentionRemind(String param);

void mentionInformat(String param);

void deleteOneAnnotation(String param);

void createOneAnnotation(String param);
//滑动编辑器光标位置
void scrollToCursorPosition(String param);
//提及@删除 的回调
void mentionDelete(String param);
//用户协作权限变更
void notifyPermissionChange(String param);

使用示例

//实例化对应接口，进行回调
noteView.setNoteEditorEventHandler(noteEditorEventHandler);
noteView.setCollaborationJSCallback(collaborationJSCallback);
noteView.setFormatJSCallback(formatJSCallback);
noteView.setActionJSCallback(actionJSCallback);

表格文档

表格文档样式修改模块的回调接口

FormatSheetJSCallback

//格式当前选区selection变化 触发
void onFormatSheetChange(SheetFormat format);

表格文档其他功能的回调接口

SheetEditorEventHandler

 //表格加载完成
void onSheetLoadedDone();
//表格缩放
void onSheetZoom(String rate);
//双击单元格
void onSheetDBClick(String cell,String placeholder);
//选区改变
void onSheetSelectionChange(String cell,String placeholder);
//当前表格信息
void onSheetInfo(List<SheetInfo> infoList);
//表格上下文菜单单元格操作
void onSheetContextCellOpt();
//表格上下文菜单行列操作
void onSheetContextRowColOpt();
//表格权限回调
void onSheetPermissionChange(EditSheetPermission editSheetPermission);
//查看大图
void onSheetPreviewImage(String param);
//图片加载
void onSheetImageLoad(List<String> objectIds);
//协作用户列表
void onSheetCollaborateUser(List<Editor> users);
//token失效
void onSheetTokenInvalid();
//表格被删除
void onSheetDeleted();
//表格该变
void onSheetChanged();
//表格筛选数据
void onSheetSiftData(FilterMenuData filterMenuData);

使用示例

//实例化对应接口，进行回调
sheetView.setSheetEditorEventHandler(sheetEditorEventHandler);
sheetView.setFormatSheetJSCallback(sheetFormatCallback);

协作模块-IFlyDocsCollaboration

API

initCollaboration

• 功能

初始化文字文档编辑器

• 定义

initCollaboration(IFLYDocsCollaborationConfig config)

• 参数

config：协作配置参数，详细见IFLYDocsCollaborationConfig

• 返回

无

调用示例

* @param {String} fid 协作文档 id
* @param {String} token 用户登录标识 accessToken
* @param {String} title 标题
* @param {String} role 当前角色
* @param {String} snapshot 快照 如果为空客户端直接传 'null' 字符串
* @param {String} ops 操作序列ops 如果为空客户端直接传 'null' 字符串
* @param {String} wsUrl 协作服务 url
* @param {String} sid 用户协作会话 id
* @param {Boolean} onlineStatus 是否在线

IFLYDocsCollaborationConfig iflyDocsCollaborationConfig = new IFLYDocsCollaborationConfig();
//参数赋值
iflyDocsCollaborationConfig.fid = fid;
iflyDocsCollaborationConfig.accessToken = accessToken;
iflyDocsCollaborationConfig.title = title;
iflyDocsCollaborationConfig.role = role;
iflyDocsCollaborationConfig.wsUrl = wsUrl;
iflyDocsCollaborationConfig.snapshot = snap;
iflyDocsCollaborationConfig.ops = ops;
iflyDocsCollaborationConfig.sid = sid;
iflyDocsCollaborationConfig.onlineStatus = isNetAvailable;
//发起调用
iFlyDocsCollaboration.initCollaboration(iflyDocsCollaborationConfig);

注意事项

必须在编辑器加载完毕后激活，否则无效。

refreshToken

• 功能

刷新用户登录验证的token

• 定义

refreshToken(String accessToken)

• 参数

accessToken：用户登录验证

• 返回

无

refreshFid

• 功能

刷新编辑器文档唯一标识

• 定义

refreshFid(String fid)

• 参数

fid：文档唯一标识

• 返回

无

setOnlineStatus

• 功能

设置是否为在线模式

• 定义

setOnlineStatus(boolean isOnline)

• 参数

isOnline:是否在线

• 返回

无

通用样式模块-IFlyDocsBaseFormat

样式设置 ，编辑器通用的样式设置

API

setFontStyle

• 功能

设置字号样式

• 定义

setFontStyle(EditorFontStyle fontStyle)

• 参数

fontStyle：字体样式，详细见EditorFontStyle

• 返回

无

setAlignSyle

• 功能

设置段样式

• 定义

setAlignStyle(EditorAlignSyle alignStyle)

• 参数

alignStyle：段落对齐样式，详细见EditorAlignStye

• 返回

无

setFontSizeStyle

• 功能

设置字号样式

• 定义

setFontSizeStyle(EditorFontSizeStyle fontSizeStyle)

• 参数

fontSizeStyle：字号样式，详细见EditorFontSizeStyle

• 返回

无

setFontColorStyle

• 功能

设置字体颜色样式

• 定义

setFontStyle(EditorColorStyle colorStyle)

• 参数

colorStyle：字体颜色样式，详细见EditorColorStyle

• 返回

无

setBold

• 功能

设置加粗

• 定义

setFontBold(boolean isBold)

• 参数

isBold：是否加粗

• 返回

无

setItalic

• 功能

设置斜体

• 定义

setItalic(boolean isItalic)

• 参数

isItalic：是否为斜体

• 返回

无

setUnderline

• 功能

设置下划线

• 定义

setUnderline(boolean isUnderline)

• 参数

isUnderline：是否有下划线

• 返回

无

setStrike

• 功能

设置删除线

• 定义

setStrike(boolean isStrike)

• 参数

isStrike：是否有删除线

• 返回

无

setColor

• 功能

设置字体颜色

• 定义

setColor(EditorColorStyle color)

• 参数

color：颜色样式，详细见EditorColorStyle

• 返回

无

文字文档样式模块-IFlyDocsFormat

文字文档样式设置入口

API

setScriptStyle

• 功能

设置上下标

• 定义

setScript(EditorScriptStyle script,boolean isCheck)

• 参数

script：上下标样式

isCheck: boolean值，是否选中

• 返回

无

setBackgroundColor

• 功能

设置背景颜色

• 定义

setBackgroundColor(EditorColorStyle colorStyle)

• 参数

colorStyle：颜色样式，详细见EditorColorStyle

• 返回

无

setListStyle

• 功能

设置段落样式，设置待办事项

• 定义

setListStyle(EditorListStyle listStyle)

• 参数

listStyle：段落列表样式，详细见EditorListStyle

• 返回

无

setIndentStyle

• 功能

设置段落缩进样式

• 定义

setIndentStyle(EditorIndentStyle indentStyle)

• 参数

indentStyle：段落缩进样式，详细见EditorIndentStyle

• 返回

无

setHeaderStyle

• 功能

设置段落缩进样式

• 定义

setHeaderStyle(EditorHeaderStyle headerStyle)

• 参数

headerStyle：标题样式，详细见EditorHeaderStyle

• 返回

无

通用行为模块-IFlyDocsBaseAction

编辑器通用行为，如查找替换、插入链接等

API

search

• 功能

查找文本内容

• 定义

search(String searchText)

• 参数

searchText：查找文本内容

• 返回

无

searchPrev

• 功能

查找上一个

• 定义

searchPrev()

• 参数

无

• 返回

无

searchNext

• 功能

查找下一个

• 定义

searchNext()

• 参数

无

• 返回

无

replaceText

• 功能

替换查找到的文本

• 定义

replaceText(boolean isAll，String replaceText)

• 参数

isAll：是否全部替换

replaceText：替换文本

• 返回

无

文字文档行为模块-IFlyDocsAction

文字文档行为模块，如插入文件占位、通知上传完成、设置高亮等

API

insertText

• 功能

插入文本

• 定义

insertText(String text，int index)

• 参数

text：插入的文本内容

index：插入索引

• 返回

无

通用表格模块-IFlyDocsBaseSheet

表格文档通用模块，包括撤销重做、聚焦、失焦、查找等等。

API

包括撤销重做、聚焦、失焦、查找等等

initEditSheet

• 功能

初始化表格

• 定义

initEditSheet(String param)

• 参数

param：json形式，表格文档的fid，token，wsurl，sheetdata数据

• 返回

无

sheetSearch

• 功能

初始化表格

• 定义

sheetSearch(String searchText)

• 参数

searchText：查找字符串

• 返回

无

表格样式模块-IFlySheetFormat

表格文档字体模块，包括字体的粗体，斜体等等。

API

sheetFontSize

• 功能

字体的大小样式

• 定义

sheetFontSize(String fontSize)

• 参数

fontSize：String，取值 '9','18'等

• 返回

无

sheetSetBold

• 功能

字体加粗

• 定义

sheetSetBold(boolean isBold)

• 参数

isBold：boolean

• 返回

无

表格边界模块-IFlySheetBorder

表格文档边界模块，包括边界的线条颜色，数据样式等。

API

sheetSetRangeBorder

• 功能

边界的线条设置

• 定义

sheetSetRangeBorder(String style, int borderStyleD, String borderColor)

• 参数

style : String, all 全部 |outside 外边框 |inside 内边框 |left 左边框 |innerVertical 中间竖 | right 右边框|top 上边框 |innerHorizontal 横中边框 |bottom 下边框 |diagonalUp 斜上 |diagonalDown 斜下

borderStyle :String, 边框样式

borderColor : String

• 返回

无

sheetSetBoldsheetSetFormatter

• 功能

数据样式设置

• 定义

sheetSetFormatter(String format)

• 参数

format：String，数据样式的格式

• 返回

无

表格单元格模块-IFlySheetCell

表格文档单元格模块，包括增加行列，冻结行列等。

API

sheetRowColAdd

• 功能

增加行列

• 定义

sheetRowColAdd(String rowOrCol, String direction)

• 参数

rowOrCol: String, 'row'和'col'

direction:String ，'top'、'bottom'、'left'、'right'

• 返回

无

sheetRowColFrozen

• 功能

行列冻结，保持在可视界面上

• 定义

sheetRowColFrozen(String rowOrCol)

• 参数

rowOrCol: 'row'、'col'、'row-col'、''

• 返回

无