Engine 基础

目录

• 目录
• EditorInterface

EditorInterface

Editor 大概分为一下部分的内容：

• locale: 语言本地化
• kind: 类型、编辑模式和预览模式
• container: 容器
• command：命令管理
• request: 网络请求
• card: 卡片管理
• plugin: 插件系统
• node: 节点管理，包括 list、mark node、inline node、block node 等
• event: 事件系统，包括 Event、event hooks 和 on/off/trigger
• schema 和 conversion：标签过滤和标签转换
• clipboard: 剪贴板管理
• message: 消息管理：包括 messageSuccess、messageError 和 messageConfirm

export interface EditorInterface {
 /**
  * 类型
  */
 readonly kind: 'engine' | 'view';
 /**
  * 语言
  */
 language: LanguageInterface;
 /**
  * 编辑器节点
  */
 container: NodeInterface;
 /**
  * 滚动条节点
  */
 readonly scrollNode: NodeInterface | null;
 /**
  * 编辑器根节点，默认为编辑器父节点
  */
 root: NodeInterface;
 /**
  * 编辑器命令
  */
 command: CommandInterface;
 /**
  * 请求
  */
 request: RequestInterface;
 /**
  * 卡片
  */
 card: CardModelInterface;
 /**
  * 插件
  */
 plugin: PluginModelInterface;
 /**
  * 节点管理
  */
 node: NodeModelInterface;
 /**
  * 节点id管理器
  */
 nodeId: NodeIdInterface;
 /**
  * List 列表标签管理
  */
 list: ListModelInterface;
 /**
  * Mark 标签管理
  */
 mark: MarkModelInterface;
 /**
  * inline 标签管理
  */
 inline: InlineModelInterface;
 /**
  * block 标签管理
  */
 block: BlockModelInterface;
 /**
  * 事件
  */
 event: EventInterface;
 /**
  * 标签过滤规则
  */
 schema: SchemaInterface;
 /**
  * 标签转换规则
  */
 conversion: ConversionInterface;
 /**
  * 剪切板
  */
 clipboard: ClipboardInterface;
 /**
  * 绑定事件
  * @param eventType 事件类型
  * @param listener 事件回调
  * @param rewrite 是否重写
  */
 on(eventType: string, listener: EventListener, rewrite?: boolean): void;
 /**
  * 全选ctrl+a键按下，返回false，终止处理其它监听
  * @param eventType
  * @param listener
  * @param rewrite
  */
 on(
  eventType: 'keydown:all',
  listener: (event: KeyboardEvent) => boolean | void,
  rewrite?: boolean,
 ): void;
 /**
  * 卡片最小化时触发
  * @param eventType
  * @param listener name:插件名称、args:参数
  * @param rewrite
  */
 on(
  eventType: 'card:minimize',
  listener: (card: CardInterface) => void,
  rewrite?: boolean,
 ): void;
 /**
  * 卡片最大化时触发
  * @param eventType
  * @param listener name:插件名称、args:参数
  * @param rewrite
  */
 on(
  eventType: 'card:maximize',
  listener: (card: CardInterface) => void,
  rewrite?: boolean,
 ): void;
 /**
  * 解析DOM节点，生成符合标准的 XML 代码之前触发
  * @param root DOM节点
  */
 on(
  eventType: 'parse:value-before',
  listener: (root: NodeInterface) => void,
  rewrite?: boolean,
 ): void;
 /**
  * 解析DOM节点，生成符合标准的 XML，遍历子节点时触发。返回false跳过当前节点
  * @param node 当前遍历的节点
  * @param attributes 当前节点已过滤后的属性
  * @param styles 当前节点已过滤后的样式
  * @param value 当前已经生成的xml代码
  */
 on(
  eventType: 'parse:value',
  listener: (
   node: NodeInterface,
   attributes: { [key: string]: string },
   styles: { [key: string]: string },
   value: Array<string>,
  ) => boolean | void,
  rewrite?: boolean,
 ): void;
 /**
  * 解析DOM节点，生成符合标准的 XML。生成xml代码结束后触发
  * @param value xml代码
  */
 on(
  eventType: 'parse:value-after',
  listener: (value: Array<string>) => void,
  rewrite?: boolean,
 ): void;
 /**
  * 转换为HTML代码之前触发
  * @param root 需要转换的根节点
  */
 on(
  eventType: 'parse:html-before',
  listener: (root: NodeInterface) => void,
  rewrite?: boolean,
 ): void;
 /**
  * 转换为HTML代码
  * @param root 需要转换的根节点
  */
 on(
  eventType: 'parse:html',
  listener: (root: NodeInterface) => void,
  rewrite?: boolean,
 ): void;
 /**
  * 转换为HTML代码之后触发
  * @param root 需要转换的根节点
  */
 on(
  eventType: 'parse:html-after',
  listener: (root: NodeInterface) => void,
  rewrite?: boolean,
 ): void;
 /**
  * 复制DOM节点时触发
  * @param node 当前遍历的子节点
  */
 on(
  eventType: 'copy',
  listener: (root: NodeInterface) => void,
  rewrite?: boolean,
 ): void;
 /**
  * 移除绑定事件
  * @param eventType 事件类型
  * @param listener 事件回调
  */
 off(eventType: string, listener: EventListener): void;
 /**
  * 全选ctrl+a键按下，返回false，终止处理其它监听
  * @param eventType
  * @param listener
  */
 off(
  eventType: 'keydown:all',
  listener: (event: KeyboardEvent) => boolean | void,
 ): void;
 /**
  * 卡片最小化时触发
  * @param eventType
  * @param listener name:插件名称、args:参数
  */
 off(
  eventType: 'card:minimize',
  listener: (card: CardInterface) => void,
 ): void;
 /**
  * 卡片最大化时触发
  * @param eventType
  * @param listener name:插件名称、args:参数
  */
 off(
  eventType: 'card:maximize',
  listener: (card: CardInterface) => void,
 ): void;
 /**
  * 解析DOM节点，生成符合标准的 XML 代码之前触发
  * @param root DOM节点
  */
 off(
  eventType: 'parse:value-before',
  listener: (root: NodeInterface) => void,
 ): void;
 /**
  * 解析DOM节点，生成符合标准的 XML，遍历子节点时触发。返回false跳过当前节点
  * @param node 当前遍历的节点
  * @param attributes 当前节点已过滤后的属性
  * @param styles 当前节点已过滤后的样式
  * @param value 当前已经生成的xml代码
  */
 off(
  eventType: 'parse:value',
  listener: (
   node: NodeInterface,
   attributes: { [key: string]: string },
   styles: { [key: string]: string },
   value: Array<string>,
  ) => boolean | void,
 ): void;
 /**
  * 解析DOM节点，生成符合标准的 XML。生成xml代码结束后触发
  * @param value xml代码
  */
 off(
  eventType: 'parse:value-after',
  listener: (value: Array<string>) => void,
 ): void;
 /**
  * 转换为HTML代码之前触发
  * @param root 需要转换的根节点
  */
 off(
  eventType: 'parse:html-before',
  listener: (root: NodeInterface) => void,
 ): void;
 /**
  * 转换为HTML代码
  * @param root 需要转换的根节点
  */
 off(eventType: 'parse:html', listener: (root: NodeInterface) => void): void;
 /**
  * 转换为HTML代码之后触发
  * @param root 需要转换的根节点
  */
 off(
  eventType: 'parse:html-after',
  listener: (root: NodeInterface) => void,
 ): void;
 /**
  * 复制DOM节点时触发
  * @param node 当前遍历的子节点
  */
 off(eventType: 'copy', listener: (root: NodeInterface) => void): void;
 /**
  * 触发事件
  * @param eventType 事件名称
  * @param args 触发参数
  */
 trigger(eventType: string, ...args: any): any;
 /**
  * 全选ctrl+a键按下，返回false，终止处理其它监听
  * @param eventType
  * @param listener
  */
 trigger(eventType: 'keydown:all', event: KeyboardEvent): boolean | void;
 /**
  * 卡片最小化时触发
  * @param eventType
  * @param listener name:插件名称、args:参数
  */
 trigger(eventType: 'card:minimize', card: CardInterface): void;
 /**
  * 卡片最大化时触发
  * @param eventType
  * @param listener name:插件名称、args:参数
  */
 trigger(eventType: 'card:maximize', card: CardInterface): void;
 /**
  * 解析DOM节点，生成符合标准的 XML 代码之前触发
  * @param root DOM节点
  */
 trigger(eventType: 'parse:value-before', root: NodeInterface): void;
 /**
  * 解析DOM节点，生成符合标准的 XML，遍历子节点时触发。返回false跳过当前节点
  * @param node 当前遍历的节点
  * @param attributes 当前节点已过滤后的属性
  * @param styles 当前节点已过滤后的样式
  * @param value 当前已经生成的xml代码
  */
 trigger(
  eventType: 'parse:value',
  node: NodeInterface,
  attributes: { [key: string]: string },
  styles: { [key: string]: string },
  value: Array<string>,
 ): boolean | void;
 /**
  * 解析DOM节点，生成符合标准的 XML。生成xml代码结束后触发
  * @param value xml代码
  */
 trigger(eventType: 'parse:value-after', value: Array<string>): void;
 /**
  * 转换为HTML代码之前触发
  * @param root 需要转换的根节点
  */
 trigger(eventType: 'parse:html-before', root: NodeInterface): void;
 /**
  * 转换为HTML代码
  * @param root 需要转换的根节点
  */
 trigger(eventType: 'parse:html', root: NodeInterface): void;
 /**
  * 转换为HTML代码之后触发
  * @param root 需要转换的根节点
  */
 trigger(eventType: 'parse:html-after', root: NodeInterface): void;
 /**
  * 复制DOM节点时触发
  * @param node 当前遍历的子节点
  */
 trigger(eventType: 'copy', root: NodeInterface): void;
 /**
  * 显示成功的信息
  * @param message 信息
  */
 messageSuccess(message: string): void;
 /**
  * 显示错误信息
  * @param error 错误信息
  */
 messageError(error: string): void;
 /**
  * 消息确认
  * @param message 消息
  */
 messageConfirm(message: string): Promise<boolean>;
}