@hailin-zheng/editor-core 1.0.9 → 1.0.13

package/lib/framework/element-define.d.ts

@@ -0,0 +1,319 @@
+import { Subject, Subscription } from "rxjs";
+import { ElementEvent, EventTypes } from "./element-event-define";
+import { RenderContenxtType } from "./render-context";
+import { CursorType, LeafRenderObject, RenderObject } from "./render-define";
+export declare class Rect {
+    x: number;
+    y: number;
+    width: number;
+    height: number;
+    maxHeight: number;
+    maxWidth: number;
+}
+export interface SerializeProps {
+    type: string;
+    props?: any;
+    children?: Array<SerializeProps>;
+    complete?: boolean;
+}
+/**
+ * 刷新类型
+ * 刷新外观，不需要进行测量，直接进入绘制
+ * 刷新内容，需要重新测量，再绘制
+ */
+export declare type RefreshType = 'appearance' | 'content';
+/**
+ * 修改标志
+ */
+export declare enum ModifyFlag {
+    Modify = 0,
+    None = 1,
+    Track = 2
+}
+export interface OnChangeEventProps {
+    data: any;
+}
+/**
+ * 定义组件的数据，配置
+ */
+export declare abstract class Element<P extends object = any> {
+    type: string;
+    modifyFlag: ModifyFlag;
+    isMouseenter: boolean;
+    private _eventMap;
+    private _refreshEvent;
+    protected _onChangeEvent: Subject<void>;
+    private observers;
+    paintRenders: Array<RenderObject>;
+    measureRender: RenderObject | null;
+    focusable: boolean;
+    isFocused: boolean;
+    /**
+     * 修饰元素不能复制、序列化、删除(需要手动删除)
+     */
+    isDecorate: boolean;
+    /**
+     * 可点击性，例如：null-text 占位符元素不具备可点击能力
+     * 2.编辑页眉页脚的能力
+     */
+    disableClick: boolean;
+    private _parent;
+    get parent(): BranchElement;
+    set parent(val: BranchElement);
+    private _props;
+    get props(): P;
+    set props(value: P);
+    private notifyChanged;
+    constructor(type: string);
+    abstract createRenderObject(options: ViewOptions, renderCtx: RenderContenxtType): RenderObject | null;
+    abstract serialize(viewOptions: ViewOptions): SerializeProps | null;
+    abstract clone(data: boolean): Element;
+    abstract getChildLength(): number;
+    abstract getSelfLength(): number;
+    destroy(): void;
+    addEvent<T extends ElementEvent>(event: EventTypes, handle: (evt: T) => void, useCapture?: boolean): string;
+    removeEvent(eventId: string): void;
+    removeEventByType(eventType: EventTypes): void;
+    invokeEvent(event: EventTypes, evt: ElementEvent, userCapture?: boolean): void;
+    beginMeasure(): void;
+    getIndex(): number;
+    get refreshSubject(): Subject<void>;
+    get onChangeSubject(): Subject<void>;
+    refreshView(): void;
+    abstract pubOnChange(selfChange: pubChangeType): void;
+    unsubscribe(element: Element): void;
+    addsubscribe(element: Element, ...sub: Array<Subscription>): void;
+    /**
+     * 移除当前节点
+     */
+    remove(): void;
+}
+/**
+ * 最小节点元素
+ */
+export declare abstract class LeafElement<P extends object = any> extends Element<P> {
+    cursorType: CursorType;
+    getChildLength(): number;
+    destroy(): void;
+    getSelfLength(): number;
+    pubOnChange(selfChange: pubChangeType): void;
+}
+/**
+ * 枝干节点，包含若干个枝干或者叶子节点
+ */
+export declare abstract class BranchElement<P extends object = any> extends Element<P> {
+    private chilren;
+    constructor(type: string);
+    addChild(child: Element, index?: number): void;
+    removeChild(child: Element): void;
+    removeChildByIndex(index: number): void;
+    disposeChild(child: Element): void;
+    clearItems(): void;
+    destroy(): void;
+    get length(): number;
+    find(predicate: (item: Element, index: number) => boolean): Element | undefined;
+    getChild<T extends Element = Element>(index: number): T;
+    getChildIndex(child: Element): number;
+    getChildLength(): number;
+    getSelfLength(): number;
+    treeFilter(predicate: (item: Element, index: number) => boolean): Array<Element>;
+    treeFind(predicate: (item: Element, index: number) => boolean): Element | null;
+    pubOnChange(selfChange: pubChangeType): void;
+}
+export declare type pubChangeType = 'self' | 'tracker' | 'to-child';
+/**
+ * 行内编组元素
+ */
+export declare abstract class InlineGroupElement<P extends object = any> extends BranchElement<P> {
+}
+/**
+ * 块级元素，目前只有P元素
+ */
+export declare abstract class BlockContentElement<P extends object = any> extends BranchElement<P> {
+}
+/**
+ * 包含块级渲染元素的容器元素,例如body、table-cell、table等
+ */
+export declare abstract class BlockContainerElement<P extends object = any> extends BranchElement<P> {
+    noFillEmpty: boolean;
+}
+export interface readElementProps<T> {
+    type: string;
+    props: T | undefined;
+    children: any | undefined;
+}
+export declare abstract class ElementFactory<T = null> {
+    options: ViewOptions;
+    abstract match(type: string): boolean;
+    abstract createElement(data: readElementProps<T>, renderCtx: RenderContenxtType): Element;
+}
+export interface SelectionContentRange {
+    target: Element;
+    isFullSelected: boolean;
+    startOffset: number;
+    endOffset: number;
+    selectedChildren: Array<SelectionContentRange>;
+}
+/**
+ * 编辑模式
+ */
+export declare enum EditMode {
+    /**
+     * 自由模式，设计模板时使用
+     */
+    Free = 0,
+    /**
+     * 严格模式，医生书写模式时使用,只可更改数据元值
+     */
+    Strict = 1,
+    /**
+     * 查看模式,任何修改文档的操作都不允许，但是可选中，有拖蓝
+     */
+    View = 2,
+    /**
+     * 禁用模式，当前区域不可点击，不可选中，页脚、页眉编辑时的控制
+     */
+    Disabled = 3
+}
+/**
+ * 文档模式
+ */
+export declare enum DocMode {
+    Design = 0,
+    /**
+     * 完全编辑模式
+     */
+    Edit = 1,
+    /**
+     * 表单编辑模式
+     */
+    FormEdit = 2,
+    /**
+     * 视图模式，只能查看
+     */
+    View = 3
+}
+export declare enum BooleanEnum {
+    Null = 0,
+    True = 1,
+    False = 2
+}
+export interface DocUser {
+    id: string;
+    name: string;
+}
+export declare class PageOptions {
+    private _width;
+    private _height;
+    orient: OrientType;
+    constructor(width: number, height: number, orient?: OrientType);
+    get width(): number;
+    set width(value: number);
+    get height(): number;
+    set height(value: number);
+}
+export declare type OrientType = 'landscape' | 'portrait';
+export declare class ViewOptions {
+    copyRightInfo: string;
+    watermark?: string;
+    drawLineRectColor: string;
+    drawCharRectColor: string;
+    drawSymbolsColor: string;
+    defaultFontName: string;
+    defaultFontSize: number;
+    defaultColor: string;
+    selectionOverlaysColor: string;
+    dataEleOverlaysColor: string;
+    dataEleReadOnlyOverlayColor: string;
+    dataEleOutlineColor: string;
+    viewBackcolor: string;
+    paraSymbolColor: string;
+    dataGroupColor: string;
+    showLineRect: boolean;
+    showCharRect: boolean;
+    showParaMark: boolean;
+    showTabChar: boolean;
+    showSpaceChar: boolean;
+    showLineBreak: boolean;
+    bodyMarginTop: number;
+    devMode: boolean;
+    showDebug: boolean;
+    resourceMode: 'lazy' | 'immediate';
+    serverMode: boolean;
+    secretBrowse: boolean;
+    chineseLayout: boolean;
+    private _fullPageView;
+    get fullPageView(): boolean;
+    set fullPageView(value: boolean);
+    mmToPixelsRatio: number;
+    cursor: CursorType;
+    translateY: number;
+    docPageSettings: PageOptions;
+    viewSettings: {
+        width: number;
+        height: number;
+    };
+    pageNumFormat: string;
+    get viewPaintHeight(): number;
+    /**
+     * 内容区域的高度
+     * 同时限定canvas的最小宽度
+     */
+    get ContentWidth(): number;
+    docSpace: number;
+    private _showReviewWindow;
+    get showReviewWindow(): boolean;
+    set showReviewWindow(value: boolean);
+    reviewWindowWidth: number;
+    private _scale;
+    get scale(): number;
+    set scale(val: number);
+    docMode: DocMode;
+    enableUndo: boolean;
+    private _showTrackChanges;
+    get showTrackChanges(): boolean;
+    set showTrackChanges(value: boolean);
+    textRowLineMode: boolean;
+    editUser: DocUser;
+    trackChangePeriod: number;
+    onChange: Subject<'demand' | 'force'>;
+    constructor();
+}
+export declare class MarginProps {
+    top: number;
+    bottom: number;
+    left: number;
+    right: number;
+    constructor(top?: number, bottom?: number, left?: number, right?: number);
+    clone(): MarginProps;
+}
+export declare class PaddingProps extends MarginProps {
+}
+export declare class BorderProps {
+    width: number;
+    color: string;
+    style: string;
+    constructor(width?: number, color?: string, style?: string);
+    clone(): BorderProps;
+}
+export declare abstract class IDispose {
+    abstract destroy(): void;
+}
+export declare type TextAlign = 'center' | 'left' | 'right' | 'justify';
+export interface Position {
+    x: number;
+    y: number;
+}
+export declare abstract class ResizeLeafRenderObject extends LeafRenderObject {
+}
+export declare type NullableType<T> = {
+    [PropName in keyof T]?: T[PropName];
+};
+export declare type RequiredType<T> = {
+    [PropName in keyof T]: T[PropName];
+};
+export declare type ImgLoadStatus = 'no' | 'loading' | 'completed' | 'error';
+export interface ICancelTokenFn {
+    cancel?: () => void;
+    onFinish?: () => void;
+}