@hailin-zheng/editor-core 2.2.27 → 2.2.29

package/med_editor/framework/document-change.d.ts

@@ -1,341 +1,341 @@
-import { DocumentInput, InputData } from "./document-input-cursor";
-import { SelectionState } from "./selection/document-selection";
-import { BlockContainerElement, BranchElement, Element, LeafElement, SelectionContentRange } from "./element-define";
-import { ParagraphElement, TableElement, TextGroupElement, TrackRunTypeEnum } from "./impl";
-import { ParagraphNumberType, ParagraphProps, TextProps } from "./element-props";
-import { ElementReader } from "./element-reader";
-import { EditorContext } from "./document-context";
-import { DocumentComment } from "./document-comment";
-/**
- * 文档内容改变
- */
-export declare class DocumentChange {
-    private eleReader;
-    private docCtx;
-    private docComment;
-    private documentInput;
-    private selectionState;
-    private viewOptions;
-    constructor(eleReader: ElementReader, docCtx: EditorContext, docComment: DocumentComment, documentInput: DocumentInput);
-    newInput(data: InputData): void;
-    private correctInputEle;
-    /**
-     * 选中区域后进行输入
-     * 需要处理将选中的区域删除后，进行输入的情况
-     */
-    onInputBySelectRange(data: InputData): void;
-    /**
-     * 当前元素是否在正确的留痕区域(ins-run、del-run)，情况分为以下情况
-     * 1.留痕块类型为新增，但是留痕块的创建者为其他用户，此时需要拆分留痕区域
-     * 2.留痕块为当前用户创建，但是创建时间大于有效的时间，此时需要拆分留痕区域
-     * @param startControl
-     * @param trackType
-     * @returns
-     */
-    isInCorrectTrackRegion(startControl: Element, trackType: TrackRunTypeEnum): boolean;
-    /**
-     * 当前元素是否在留痕区域(ins-run、del-run)中
-     * @param target
-     * @param trackType
-     * @returns
-     */
-    isInTrackBlock(target: Element, trackType?: TrackRunTypeEnum | null): boolean;
-    /**
-     * 留痕输入
-     * @param data
-     * @param startControl
-     * @param startOffset
-     * @returns
-     */
-    newInputTrackChanges(data: InputData, startControl: LeafElement, startOffset: number): void;
-    /**
-     * 创建新留痕块,并返回留痕块输入定位文本
-     * @param startControl
-     * @param startOffset
-     * @param trackType
-     * @returns
-     */
-    createNewTrackInput(startControl: LeafElement, startOffset: number, trackType: TrackRunTypeEnum): TextGroupElement;
-    /**
-     * 获取当前输入节点的文本属性
-     * @param startControl
-     * @param offset
-     * @returns
-     */
-    getDefaultTextProps(startControl: LeafElement, offset: number): TextProps;
-    /**
-     * 根据选项配置返回创建文本的默认文本属性
-     * @private
-     */
-    private getDefaultTextPropsByOptions;
-    /**
-     * 当前元素位于留痕区域内，但是当前编辑模式为非留痕模式，需要将当前留痕元素分割开来，插入新普通文本元素对象,并返回
-     * @param startControl
-     * @param startOffset
-     * @returns
-     */
-    splitTrackElement(startControl: LeafElement, startOffset: number): TextGroupElement;
-    /**
-     * 创建插入(ins-run) 留痕,并且返回留痕的文本元素对象
-     * @param startControl
-     * @returns
-     */
-    private createTextTrackElement;
-    private createTrackElement;
-    private inputTextGroup;
-    /**
-     * backspace,向前删除
-     */
-    onBackspace(evt: KeyboardEvent): void;
-    /**
-     * delete,向后删除
-     * @param evt
-     */
-    onDeleteKeyHandler(evt: KeyboardEvent): void;
-    /**
-     * 根据选择范围删除
-     */
-    onRangeDelete(): void;
-    private capturingForSelection;
-    private getSelectionRangeStack;
-    /**
-     * backspace删除
-     * @param control
-     * @param offset
-     * @returns
-     */
-    private onBackspaceElement;
-    /**
-     * 跳到上一个数据元中
-     * @param currEle
-     */
-    private jumpToPrevDataElement;
-    /**
-     * delete删除
-     * @param control
-     * @param offset
-     * @returns
-     */
-    private onKeyDeleteElement;
-    /**
-     * 判断是否可以删除数据组
-     * @param dataEle
-     * @private
-     */
-    private canDeleteInlineGroup;
-    private onDeleteText;
-    private onDeleteItem;
-    /**
-     * 当前元素是否在留痕元素内
-     * @param target
-     * @param trackType
-     * @returns
-     */
-    private isInCurrentUserTrack;
-    private isInTrackElement;
-    /**
-     * 留痕除文本以外的其他元素
-     * @param target
-     */
-    private onTrackDeleteElement;
-    /**
-     * 更新文本删除留痕
-     */
-    private updateDeletedTrackText;
-    private getNextTrackInputElement;
-    /**
-     * 创建一个待输入的文本元素
-     * @private
-     */
-    private createNewInputText;
-    private getNextTrackElement;
-    /**
-     * 删除元素并定位光标
-     * @param control
-     * @returns
-     */
-    private removeElement;
-    /**
-     * 处理在表单模式下光标定位的问题
-     * @param target
-     * @param targetOffset
-     * @param deleteTarget
-     * @private
-     */
-    private setSelectionStateByDeleteEvent;
-    /**
-     * 回车事件
-     */
-    onEnter(): void;
-    /**
-     * 插入表格
-     * @param tb
-     * @returns
-     */
-    insertTable(tb: TableElement): void;
-    /**
-     * 插入布局容器，比如表格、数据容器等
-     * @param ele
-     */
-    insertLayoutContainer(ele: BlockContainerElement): void;
-    /**
-     * 分割当前段落用于插入表格或者粘贴的内容
-     * @param insertItems 分割后插入的内容，内容需要是block或者表格对象
-     */
-    private splitCurrentParagraph;
-    /**
-     * 合并段落
-     */
-    combineParagraph(prevPara: ParagraphElement, currPara: ParagraphElement, currElement: Element): void;
-    /**
-     * 删除选中的区域内容
-     * @param range
-     */
-    deleteRange(range: SelectionContentRange): void;
-    /**
-     * 表单区域删除处理
-     * @param range
-     * @param startPointElement
-     * @returns
-     */
-    private deleteRangeInFormEdit;
-    /**
-     * 表单模式:删除选中的区域内容
-     */
-    private loopForDelDataEleRange;
-    /**
-     * 向目标移动元素
-     * @param targetElement
-     * @param targetOffset
-     * @param moveElement
-     * @param moveOffset
-     * @param ss
-     */
-    moveElement(targetElement: Element, targetOffset: number, moveElement: Element, moveOffset: number, ss: SelectionState): void;
-    /**
-     * 向指定的目标插入元素
-     * @param targetElement
-     * @param targetOffset
-     * @param destEleArray
-     */
-    insertElement(targetElement: Element, targetOffset: number, destEleArray: Array<Element>): Element | null;
-    /**
-     * 校验容器是否允许插入元素
-     * @param container
-     * @param ele
-     * @returns
-     */
-    canInsertElement(container: BranchElement, ele: Element): boolean;
-    /**
-     * 根据开始位置和结束位置，将字符切割成指定的区间
-     * @param text
-     * @param start
-     * @param end
-     * @returns
-     */
-    static splitTextGroupByRange(text: TextGroupElement, start: number, end: number): TextGroupElement | null;
-    splitText(text: TextGroupElement, offset: number): {
-        leftElement: TextGroupElement | null;
-        rightElement: TextGroupElement | null;
-    };
-    /**
-     * 设置选中的文本样式
-     * @param ss
-     * @param setterFunc
-     * @returns
-     */
-    static setTextStyle(ss: SelectionState, setterFunc: (text: TextGroupElement) => void): void;
-    private static recursionSetRangeTextStyle;
-    static setParaAlign(ss: SelectionState, setterFunc: (tp: ParagraphProps) => void): void;
-    static setParaStyle(ss: SelectionState, setterFunc: (tp: ParagraphProps) => void): void;
-    /**
-     * 复制
-     * @param evt
-     * @returns
-     */
-    onCopy(evt: ClipboardEvent): void;
-    /**
-     * 剪切
-     * @param evt
-     */
-    onCut(evt: ClipboardEvent): void;
-    /**
-     * 粘贴
-     * @param evt
-     * @returns
-     */
-    onPaste(evt: ClipboardEvent): void;
-    /**
-     * 在光标处插入内容
-     * @param data
-     */
-    onInsertContent(data: {
-        text: string;
-        doc: string;
-    }): void;
-    /**
-     * 处理粘贴的内容
-     * @private
-     */
-    private handlePasteContent;
-    /**
-     * 处理表单模式下的粘贴事件
-     * @param data 要粘贴的元素
-     */
-    handlePasteInFormEditMode(data: Array<Element>): void;
-    /**
-     * 复制单元格向另一个单元格粘贴
-     * @private
-     */
-    private pasteTableToCell;
-    insertSoftBr(): void;
-    insertPageBreakSymbol(): void;
-    /**
-     * 处理黏贴的纯文本
-     * @param text
-     */
-    private pastePlainText;
-    /**
-     * 当前光标位置是否允许分割生成两个段落
-     */
-    allowSplitParagraph(target?: {
-        startControl: LeafElement;
-        startOffset: number;
-    }): boolean;
-    /**
-     * 向当前光标追加文本
-     * @param appendStr
-     * @param inputOffset
-     * @param replaceLength
-     * @private
-     */
-    appendText(appendStr: string, replaceText: string): void;
-    /**
-     * 设置当前段落项目符号类型
-     */
-    setParagraphNumberType(numType?: ParagraphNumberType): void;
-    /**
-     * 插入批注
-     */
-    insertComment(text: string): void;
-    validate(): boolean;
-    /**
-     * 移除空字符串
-     * @param text
-     */
-    removeEmptyText(text: TextGroupElement): void;
-    setCursorForDeleteAction(control: Element): void;
-    getCursorElementByDeleteAction(control: Element): {
-        ele: LeafElement;
-        offset: number;
-    } | null;
-    /**
-     * 移除空行内标签
-     * @param ele
-     */
-    removeEmptyInlineBlock(ele: Element): void;
-    /**
-     * 插入Tab制表位
-     */
-    insertTabElement(): void;
-}
+import { DocumentInput, InputData } from "./document-input-cursor";
+import { SelectionState } from "./selection/document-selection";
+import { BlockContainerElement, BranchElement, Element, LeafElement, SelectionContentRange } from "./element-define";
+import { ParagraphElement, TableElement, TextGroupElement, TrackRunTypeEnum } from "./impl";
+import { ParagraphNumberType, ParagraphProps, TextProps } from "./element-props";
+import { ElementReader } from "./element-reader";
+import { EditorContext } from "./document-context";
+import { DocumentComment } from "./document-comment";
+/**
+ * 文档内容改变
+ */
+export declare class DocumentChange {
+    private eleReader;
+    private docCtx;
+    private docComment;
+    private documentInput;
+    private selectionState;
+    private viewOptions;
+    constructor(eleReader: ElementReader, docCtx: EditorContext, docComment: DocumentComment, documentInput: DocumentInput);
+    newInput(data: InputData): void;
+    private correctInputEle;
+    /**
+     * 选中区域后进行输入
+     * 需要处理将选中的区域删除后，进行输入的情况
+     */
+    onInputBySelectRange(data: InputData): void;
+    /**
+     * 当前元素是否在正确的留痕区域(ins-run、del-run)，情况分为以下情况
+     * 1.留痕块类型为新增，但是留痕块的创建者为其他用户，此时需要拆分留痕区域
+     * 2.留痕块为当前用户创建，但是创建时间大于有效的时间，此时需要拆分留痕区域
+     * @param startControl
+     * @param trackType
+     * @returns
+     */
+    isInCorrectTrackRegion(startControl: Element, trackType: TrackRunTypeEnum): boolean;
+    /**
+     * 当前元素是否在留痕区域(ins-run、del-run)中
+     * @param target
+     * @param trackType
+     * @returns
+     */
+    isInTrackBlock(target: Element, trackType?: TrackRunTypeEnum | null): boolean;
+    /**
+     * 留痕输入
+     * @param data
+     * @param startControl
+     * @param startOffset
+     * @returns
+     */
+    newInputTrackChanges(data: InputData, startControl: LeafElement, startOffset: number): void;
+    /**
+     * 创建新留痕块,并返回留痕块输入定位文本
+     * @param startControl
+     * @param startOffset
+     * @param trackType
+     * @returns
+     */
+    createNewTrackInput(startControl: LeafElement, startOffset: number, trackType: TrackRunTypeEnum): TextGroupElement;
+    /**
+     * 获取当前输入节点的文本属性
+     * @param startControl
+     * @param offset
+     * @returns
+     */
+    getDefaultTextProps(startControl: LeafElement, offset: number): TextProps;
+    /**
+     * 根据选项配置返回创建文本的默认文本属性
+     * @private
+     */
+    private getDefaultTextPropsByOptions;
+    /**
+     * 当前元素位于留痕区域内，但是当前编辑模式为非留痕模式，需要将当前留痕元素分割开来，插入新普通文本元素对象,并返回
+     * @param startControl
+     * @param startOffset
+     * @returns
+     */
+    splitTrackElement(startControl: LeafElement, startOffset: number): TextGroupElement;
+    /**
+     * 创建插入(ins-run) 留痕,并且返回留痕的文本元素对象
+     * @param startControl
+     * @returns
+     */
+    private createTextTrackElement;
+    private createTrackElement;
+    private inputTextGroup;
+    /**
+     * backspace,向前删除
+     */
+    onBackspace(evt: KeyboardEvent): void;
+    /**
+     * delete,向后删除
+     * @param evt
+     */
+    onDeleteKeyHandler(evt: KeyboardEvent): void;
+    /**
+     * 根据选择范围删除
+     */
+    onRangeDelete(): void;
+    private capturingForSelection;
+    private getSelectionRangeStack;
+    /**
+     * backspace删除
+     * @param control
+     * @param offset
+     * @returns
+     */
+    private onBackspaceElement;
+    /**
+     * 跳到上一个数据元中
+     * @param currEle
+     */
+    private jumpToPrevDataElement;
+    /**
+     * delete删除
+     * @param control
+     * @param offset
+     * @returns
+     */
+    private onKeyDeleteElement;
+    /**
+     * 判断是否可以删除数据组
+     * @param dataEle
+     * @private
+     */
+    private canDeleteInlineGroup;
+    private onDeleteText;
+    private onDeleteItem;
+    /**
+     * 当前元素是否在留痕元素内
+     * @param target
+     * @param trackType
+     * @returns
+     */
+    private isInCurrentUserTrack;
+    private isInTrackElement;
+    /**
+     * 留痕除文本以外的其他元素
+     * @param target
+     */
+    private onTrackDeleteElement;
+    /**
+     * 更新文本删除留痕
+     */
+    private updateDeletedTrackText;
+    private getNextTrackInputElement;
+    /**
+     * 创建一个待输入的文本元素
+     * @private
+     */
+    private createNewInputText;
+    private getNextTrackElement;
+    /**
+     * 删除元素并定位光标
+     * @param control
+     * @returns
+     */
+    private removeElement;
+    /**
+     * 处理在表单模式下光标定位的问题
+     * @param target
+     * @param targetOffset
+     * @param deleteTarget
+     * @private
+     */
+    private setSelectionStateByDeleteEvent;
+    /**
+     * 回车事件
+     */
+    onEnter(): void;
+    /**
+     * 插入表格
+     * @param tb
+     * @returns
+     */
+    insertTable(tb: TableElement): void;
+    /**
+     * 插入布局容器，比如表格、数据容器等
+     * @param ele
+     */
+    insertLayoutContainer(ele: BlockContainerElement): void;
+    /**
+     * 分割当前段落用于插入表格或者粘贴的内容
+     * @param insertItems 分割后插入的内容，内容需要是block或者表格对象
+     */
+    private splitCurrentParagraph;
+    /**
+     * 合并段落
+     */
+    combineParagraph(prevPara: ParagraphElement, currPara: ParagraphElement, currElement: Element): void;
+    /**
+     * 删除选中的区域内容
+     * @param range
+     */
+    deleteRange(range: SelectionContentRange): void;
+    /**
+     * 表单区域删除处理
+     * @param range
+     * @param startPointElement
+     * @returns
+     */
+    private deleteRangeInFormEdit;
+    /**
+     * 表单模式:删除选中的区域内容
+     */
+    private loopForDelDataEleRange;
+    /**
+     * 向目标移动元素
+     * @param targetElement
+     * @param targetOffset
+     * @param moveElement
+     * @param moveOffset
+     * @param ss
+     */
+    moveElement(targetElement: Element, targetOffset: number, moveElement: Element, moveOffset: number, ss: SelectionState): void;
+    /**
+     * 向指定的目标插入元素
+     * @param targetElement
+     * @param targetOffset
+     * @param destEleArray
+     */
+    insertElement(targetElement: Element, targetOffset: number, destEleArray: Array<Element>): Element | null;
+    /**
+     * 校验容器是否允许插入元素
+     * @param container
+     * @param ele
+     * @returns
+     */
+    canInsertElement(container: BranchElement, ele: Element): boolean;
+    /**
+     * 根据开始位置和结束位置，将字符切割成指定的区间
+     * @param text
+     * @param start
+     * @param end
+     * @returns
+     */
+    static splitTextGroupByRange(text: TextGroupElement, start: number, end: number): TextGroupElement | null;
+    splitText(text: TextGroupElement, offset: number): {
+        leftElement: TextGroupElement | null;
+        rightElement: TextGroupElement | null;
+    };
+    /**
+     * 设置选中的文本样式
+     * @param ss
+     * @param setterFunc
+     * @returns
+     */
+    static setTextStyle(ss: SelectionState, setterFunc: (text: TextGroupElement) => void): void;
+    private static recursionSetRangeTextStyle;
+    static setParaAlign(ss: SelectionState, setterFunc: (tp: ParagraphProps) => void): void;
+    static setParaStyle(ss: SelectionState, setterFunc: (tp: ParagraphProps) => void): void;
+    /**
+     * 复制
+     * @param evt
+     * @returns
+     */
+    onCopy(evt: ClipboardEvent): void;
+    /**
+     * 剪切
+     * @param evt
+     */
+    onCut(evt: ClipboardEvent): void;
+    /**
+     * 粘贴
+     * @param evt
+     * @returns
+     */
+    onPaste(evt: ClipboardEvent): void;
+    /**
+     * 在光标处插入内容
+     * @param data
+     */
+    onInsertContent(data: {
+        text: string;
+        doc: string;
+    }): void;
+    /**
+     * 处理粘贴的内容
+     * @private
+     */
+    private handlePasteContent;
+    /**
+     * 处理表单模式下的粘贴事件
+     * @param data 要粘贴的元素
+     */
+    handlePasteInFormEditMode(data: Array<Element>): void;
+    /**
+     * 复制单元格向另一个单元格粘贴
+     * @private
+     */
+    private pasteTableToCell;
+    insertSoftBr(): void;
+    insertPageBreakSymbol(): void;
+    /**
+     * 处理黏贴的纯文本
+     * @param text
+     */
+    private pastePlainText;
+    /**
+     * 当前光标位置是否允许分割生成两个段落
+     */
+    allowSplitParagraph(target?: {
+        startControl: LeafElement;
+        startOffset: number;
+    }): boolean;
+    /**
+     * 向当前光标追加文本
+     * @param appendStr
+     * @param inputOffset
+     * @param replaceLength
+     * @private
+     */
+    appendText(appendStr: string, replaceText: string): void;
+    /**
+     * 设置当前段落项目符号类型
+     */
+    setParagraphNumberType(numType?: ParagraphNumberType): void;
+    /**
+     * 插入批注
+     */
+    insertComment(text: string): void;
+    validate(): boolean;
+    /**
+     * 移除空字符串
+     * @param text
+     */
+    removeEmptyText(text: TextGroupElement): void;
+    setCursorForDeleteAction(control: Element): void;
+    getCursorElementByDeleteAction(control: Element): {
+        ele: LeafElement;
+        offset: number;
+    } | null;
+    /**
+     * 移除空行内标签
+     * @param ele
+     */
+    removeEmptyInlineBlock(ele: Element): void;
+    /**
+     * 插入Tab制表位
+     */
+    insertTabElement(): void;
+}