@hailin-zheng/editor-core 1.0.1 → 1.0.5

package/dist/framework/element-util.d.ts

@@ -1,369 +0,0 @@
-import { EditorContext } from "./document-context";
-import { BlockContainerElement, BranchElement, Element, LeafElement, Position, Rect, SelectionContentRange, ViewOptions } from "./element-define";
-import { HitRegion } from "./element-event-define";
-import { DataEleBaseProps, TextProps } from "./element-props";
-import { DataElementInlineGroup } from "./impl/data-element/data-element-base-impl";
-import { ParagraphElement, ParagraphLineRectRenderObject } from "./impl/paragraph/p-impl";
-import { TableCellRenderObject } from "./impl/table/table-cell-impl";
-import { TableElement, TableRenderObject } from "./impl/table/table-impl";
-import { TableRowRenderObject } from "./impl/table/table-row-impl";
-import { TextGroupElement, TextGroupRenderObject } from "./impl/text/text-impl";
-import { TrackRunElement, TrackRunTypeEnum } from "./impl/text/track-run-impl";
-import { BlockContainerRenderObject, BlockContentRenderObject, BorderType, BranchRenderObject, CursorType, InlineGroupRenderObject, LeafRenderObject, RenderObject } from "./render-define";
-declare type PAIR = {
-    x: number;
-    y: number;
-};
-export declare class ElementUtil {
-    static setCanvasProps(canvas: HTMLCanvasElement, ctx: CanvasRenderingContext2D, viewOptions: {
-        width: number;
-        height: number;
-    }, scale?: number): void;
-    static getDprNumber(val: number, scale?: number): number;
-    static readTextProps(dest: TextProps | null, props: TextProps | undefined, options: ViewOptions): TextProps;
-    static readEleBaseProps(dest: DataEleBaseProps, props: DataEleBaseProps): DataEleBaseProps;
-    /**
-     * 获取内容区域最大高度
-     * @param render
-     * @param renderHeight
-     * @returns
-     */
-    static innerRectMaxHeight(render: RenderObject, renderHeight: number): number;
-    /**
-     * 根据内框内容高度，更新外框框体高度
-     * @param render
-     * @param innerRect
-     */
-    static updateRenderHeightByInnerRect(render: RenderObject, innerRect: Rect): void;
-    /**
-     * 设置块级元素限制尺寸
-     * @param render
-     * @param parentLimitRect
-     */
-    static setBlockElementLimitSize(render: BlockContainerRenderObject | BlockContentRenderObject, parentLimitRect: Rect): void;
-    /**
-     * 克隆框体
-     * @param rect
-     * @returns
-     */
-    static cloneRect(rect: Rect): Rect;
-    /**
-     * 重新限定子元素以及当前高度值,并返回内边框内容高度
-     * @param render
-     * @param resetX 测量段落外框时，内框不需要重置x，因为内框已经存在对齐
-     * @returns
-     */
-    static remeasure(render: BlockContainerRenderObject | BlockContentRenderObject, resetX?: boolean): number;
-    static remeasureTableRow(rowRender: TableRowRenderObject, foreceColIndex?: number): number;
-    /**
-     * 获取表格行绘制元素的内容高度，用于缩放行高度时，获取最小内容高度，缩放的高度不能小于内容最小高度
-     */
-    static getTableRowRenderContentHeight(rowRender: TableRowRenderObject): number;
-    /**
-     * 获取单元格内容高度
-     * 单元格暂不处理上下margin、padding
-     * @param cellRender
-     * @returns
-     */
-    static getTableCellRenderContentHeight(cellRender: TableCellRenderObject): number;
-    /**
-     * 处理单元格内容纵向对齐
-     * @param render
-     */
-    private static measureCellVAlign;
-    /**
-     * 重新测量合并单元格高度
-     * @param tbRender
-     * @returns
-     */
-    static remeasureTableMerge(tbRender: TableRenderObject): void;
-    /**
-     * 获取向下纵向合并的行
-     * @param render
-     * @param rowIndex
-     * @param colIndex
-     * @returns
-     */
-    private static getContinueVMergeRenderRows;
-    /**
-     * 根据横向当前被合并的单元格
-     * @param tb
-     * @param rowIndex
-     * @param colIndex
-     */
-    static getHorizontalRestartCellIndex(tb: TableElement, rowIndex: number, colIndex: number): number;
-    /**
-     * 根据横向当前被合并的单元格
-     * @param tb
-     * @param rowIndex
-     * @param colIndex
-     */
-    static getVerticalRestartCellIndex(tb: TableElement, rowIndex: number, colIndex: number): number;
-    /**
-     * 获取合并单元格主单元格
-     * @param tb
-     * @param rowIndex
-     * @param colIndex
-     * @returns
-     */
-    static getRestartCellPosition(tb: TableElement, rowIndex: number, colIndex: number): {
-        rowIndex: number;
-        colIndex: number;
-    };
-    /**
-     * 调整单元格高度填满整个行的高度
-     */
-    private static resizeCellToFillRow;
-    /**
-     * 获取元素的全局索引位置
-     * @param control
-     * @returns
-     */
-    static getControlIndex(control: Element): number;
-    /**
-     * 根据全局索引位置获取元素
-     * @param control
-     * @param counter
-     * @returns
-     */
-    static getControlByIndex(control: Element, counter: {
-        currIndex: number;
-        index: number;
-    }): Element | null;
-    /**
-     * 获取同级紧挨前方的兄弟元素
-     * @param element
-     * @returns
-     */
-    static getPrevSiblingElement(element: Element): Element | null;
-    /**
-     * 获取同级紧挨下方的元素
-     * @param element
-     * @returns
-     */
-    static getNextSiblingElement(element: Element): Element | null;
-    static getNextSiblingTrackElement(element: Element, type: TrackRunTypeEnum, userId: string): TrackRunElement | null;
-    static getPrevSiblingTrackElement(element: Element, type: TrackRunTypeEnum, userId: string): TrackRunElement | null;
-    /**
-     * 根据默认配置创建长文本
-     * @param viewOptions
-     * @returns
-     */
-    static getNewTextGroup(textProps: TextProps): TextGroupElement;
-    static createTextProps(dest: TextProps | null, viewOptions: ViewOptions): TextProps;
-    /**
-     * 获取容器内的最小渲染元素集合
-     * @param parPos
-     * @param array
-     */
-    static getAvailHitLeafRenderObjects(render: RenderObject, parPos: Position): Array<{
-        render: LeafRenderObject;
-        rect: Rect;
-    }>;
-    /**
-     * 获取容器内的最小渲染元素集合
-     * @param parPos
-     * @param array
-     */
-    static getAvailHitRenderObjects(render: RenderObject, parPos: Position): Array<{
-        render: RenderObject;
-        rect: Rect;
-    }>;
-    /**
-     * 获取绘制元素的绝对位置框
-     */
-    static getRenderObjectAbsoluteRect(render: RenderObject, parPos: Position): Rect;
-    /**
-     * 检查当前绘制元素是否属于有效点击元素
-     */
-    static checkAvailHitRender(render: RenderObject): boolean;
-    /**
-     * 验证点击可操作性
-     * 主要限制页眉页脚的编辑模式
-     */
-    static verifyHitable(sourceElement: LeafElement | null | undefined): boolean;
-    /**
-     * 获取一个点到一个矩形最短的距离
-     * @param rect
-     * @param p
-     * @returns
-     */
-    static getDistanceToRect(rect: Rect, p: Position): number;
-    static minDistance(A: PAIR, B: PAIR, E: PAIR): number;
-    /**
-     * 获取父级层级渲染对象
-     * @param render
-     * @returns
-     */
-    static getParentRenders(render: RenderObject): Array<RenderObject>;
-    static getRenderMapElements(render: RenderObject): Array<Element>;
-    static getParentRender<T extends BranchRenderObject>(child: RenderObject, parentType: {
-        new (...args: any): T;
-    }): T | null;
-    static getParentRenderByPredicate(child: RenderObject, predicate: (item: RenderObject) => boolean): RenderObject | null;
-    /**
-     * 获取父级层级元素对象
-     * @param element
-     * @returns
-     */
-    static getParentElements(element: Element | null | undefined): Array<Element>;
-    /**
-     * 获取最后一个子元素
-     * @param element
-     * @returns
-     */
-    static getLastLeafElement(element: Element, predicate?: null | ((item: Element) => boolean)): LeafElement | null;
-    /**
-     * 获取第一个子元素
-     * @param element
-     * @returns
-     */
-    static getFirstLeafElement(element: Element): LeafElement | null;
-    /**
-     * 校验两个元素是否在同一个段落中
-     * @param element1
-     * @param element2
-     */
-    static isInSameParagraph(element1: Element, element2: Element): boolean;
-    static getBorderCursor(borderType: BorderType): CursorType;
-    static getParentByType<P extends Element, T>(child: P | null, parentType: {
-        new (...args: any): T;
-    }): T | null;
-    static getParent(child: Element | null, predicate: (item: Element) => boolean): Element | null;
-    /**
-     * 修正段落内容
-     * @returns
-     */
-    static fixParagraphContent(control: ParagraphElement): void;
-    /**
-     * 修正块级容器内容
-     * @param control
-     */
-    static fixBlockContainer(control: BlockContainerElement): void;
-    /**
-     * 获取绘制元素相对于整个画布的绝对位置
-     * 整个画布绘制的时候不一定从x=0,y=0时绘制的，下拉滚动时，上面从负y坐标开始绘制
-     * 如果计算某个元素相对画布的左上角的绝对坐标位置，需要childPos的y值减去translateY
-     * @param render
-     * @param refPos 参照位置
-     * @returns
-     */
-    static getRenderAbsolutePaintPos(render: RenderObject, refPos?: Position | null): Position;
-    static getRenderAbsolutePaintRect(render: RenderObject, childPos?: Position | null): Rect;
-    /**
-     * 获取选中区域的开始区域
-     * @param range
-     * @returns
-     */
-    static getFirstSelectedRange(range: SelectionContentRange): SelectionContentRange;
-    /**
-     * 获取选中区域的开始区域
-     * @param range \
-     * @returns
-     */
-    static getLastSelectedRange(range: SelectionContentRange): SelectionContentRange;
-    /**
-     * 克隆选区内容
-     * @param range
-     * @param isDelete
-     * @returns
-     */
-    static cloneRange(range: SelectionContentRange, isDelete: boolean, cloneMode?: 'clone' | 'source' | 'copy'): Element | null;
-    /**
-     * 获取所有的子级元素
-     * @param branchEle
-     * @returns
-     */
-    static getChildrenElements(branchEle: BranchElement): Array<Element>;
-    /**
-     * 递归向前寻找最近的元素
-     * @param currElement
-     * @param inPara  是否在同一段落中寻找
-     * @param forCursor 查找结果是否用于光标定位
-     * @returns
-     */
-    static getRecursionPrevSiblingElement(currElement: Element | null, inPara?: boolean, forCursor?: boolean): LeafElement | null;
-    /**
-     * 循环向前寻找可定位的数据元
-     * @param currElement
-     */
-    static getPrevDataElement(ctx: EditorContext, currElement: DataElementInlineGroup): DataElementInlineGroup | null;
-    /**
-     * 递归向后寻找最近的元素
-     */
-    static getRecursionNextSiblingElement(currElement: Element | null, inPara?: boolean, forCursor?: boolean): LeafElement | null;
-    /**
-     * 获取行内最大渲染单元格高度，主要处理纵向合并单元格问题
-     * @param row
-     * @returns
-     */
-    static getRowMaxCellHeight(row: TableRowRenderObject): number;
-    /**
-     * 校验是否为空内容
-     * @param ele
-     */
-    static checkEmptyContent(ele: BranchRenderObject): boolean;
-    /**
-     * 测量行内编组元素
-     * @param render
-     */
-    static remeasureInlineGroupRender(render: InlineGroupRenderObject): void;
-    static getParaLinePos(childRender: RenderObject, childRenderPos: Position): Rect;
-    static getParentRenderPos(parentRender: RenderObject, childRender: RenderObject, childRenderPos: Position): Rect;
-    /**
-     * 获取绘制元素所在的区域
-     */
-    static getRenderObjectRegion(render: RenderObject): HitRegion | undefined;
-    /**
-     * 获取文档元素所在的区域
-     * @param element
-     * @returns
-     */
-    static getElementRegion(element: Element): HitRegion | undefined;
-    static getElementRegionTarget(element: Element | null): {
-        type: HitRegion;
-        target: BranchElement;
-    } | null;
-    /**
-     * 根据坐标系统偏移位获取所在的文本偏移位置
-     * @param textRender
-     * @param x
-     * @returns
-     */
-    static getTextRenderOffset(textRender: TextGroupRenderObject, x: number): number;
-    static getHitRenderOffset(render: LeafRenderObject, x: number): number;
-    static getTextRenderHorX(currRender: TextGroupRenderObject, startOffset: number, endOffset: number): {
-        startX: number;
-        endX: number;
-    };
-    /**
-     * 获取一个元素结尾偏移量
-     * 文本以字符长度进行确定
-     * @param ele
-     * @returns
-     */
-    static getElementEndOffset(ele: LeafElement): number;
-    /**
-     * 判断当前偏移量是否是最终偏移量
-     * @param ele
-     * @param offset
-     */
-    static isElementEndOffset(ele: LeafElement, offset: number): boolean;
-    /**
-     * 获取直接子节点的所有渲染元素
-     * @param ele
-     * @returns
-     */
-    static getChildRenders<T extends RenderObject>(ele: BranchRenderObject): Array<T>;
-    /**
-     * 获取当前单元格内所有的段落行
-     * @param cell
-     * @returns
-     */
-    static getCellParaLines(cell: TableCellRenderObject): Array<ParagraphLineRectRenderObject>;
-    static getRandomColor(seed: number): string;
-    static getSeedRandom(seed: number): number;
-    static findChildRender(render: BranchRenderObject, predicate: (child: RenderObject) => boolean): RenderObject | null;
-    static getDataElement(ele: Element): DataElementInlineGroup;
-}
-export {};