@syncfusion/ej2-docx 0.0.0-stage → 35.1.40

package/src/features/styles/style-base.d.ts

@@ -0,0 +1,402 @@
+import { OpenXmlChild, OpenXmlElement } from '../../core/xml/index';
+import { CharacterFormat, CharacterFormatHost, CharacterFormatSnapshot } from '../document/character-format';
+import { ParagraphFormat, ParagraphFormatHost, ParagraphFormatSnapshot } from '../document/paragraph-format';
+import { DocxStyle, DocxStyleType } from './style';
+/**
+ * Document styles infrastructure that owns live Style instances.
+ *
+ * @private
+ */
+export interface StyleOwner {
+    /** Mark `styles.xml` dirty after a modeled mutation. */
+    markStylesDirty(): void;
+    /** Resolve a style id in the same collection (for base-style lookup). */
+    lookupStyle(styleId: string): Style | undefined;
+}
+/**
+ * Base live style definition (`w:style`).
+ *
+ * Paragraph and character styles are {@link ParagraphStyle} / {@link CharacterStyle}.
+ * Table and numbering styles are internal opaque instances.
+ *
+ * @public
+ */
+export declare abstract class Style implements CharacterFormatHost {
+    private readonly styleIdValue;
+    private readonly typeValue;
+    private readonly defaultValue;
+    private customStyleValue;
+    private nameValue;
+    private aliasesValue;
+    /** Raw `w:basedOn/@w:val` — preserved even when unresolved. */
+    private basedOnIdValue;
+    private nextIdValue;
+    private linkIdValue;
+    private uiPriorityValue;
+    private autoRedefineValue;
+    private hiddenValue;
+    private semiHiddenValue;
+    private unhideWhenUsedValue;
+    private qFormatValue;
+    private lockedValue;
+    private extraAttributesValue;
+    /**
+     * Non-modeled children except `w:pPr` / `w:rPr` (those live on format facades).
+     * Order preserved for serialize.
+     */
+    private opaqueChildrenValue;
+    private ownerValue;
+    private attachedValue;
+    private readonly characterFormatValue;
+    private suppressDirty;
+    /**
+     * @private
+     */
+    protected constructor(styleId: string, type: DocxStyleType | undefined, defaultFlag: boolean | undefined, customStyle: boolean | undefined);
+    /**
+     * Stable OOXML style identity (`w:style/@w:styleId`).
+     *
+     * @public
+     */
+    readonly styleId: string;
+    /**
+     * Style type (`w:style/@w:type`), when present.
+     *
+     * @public
+     */
+    readonly type: DocxStyleType | undefined;
+    /**
+     * Whether this is the default style of its type (`@w:default`).
+     *
+     * @public
+     */
+    readonly isDefault: boolean | undefined;
+    /**
+     * Customer-defined style flag (`@w:customStyle`).
+     *
+     * @public
+     */
+    readonly customStyle: boolean | undefined;
+    /**
+     * Display name (`w:name/@w:val`). Mutable; does not change {@link styleId}.
+     *
+     * @public
+     */
+    name: string | undefined;
+    /**
+     * Style-level character formatting (`w:rPr`). Stable facade identity.
+     *
+     * @public
+     */
+    readonly characterFormat: CharacterFormat;
+    /**
+     * Owning collection infrastructure, when attached.
+     *
+     * @private
+     */
+    readonly owner: StyleOwner | undefined;
+    /**
+     * Whether this style is attached to a document styles collection.
+     *
+     * @private
+     */
+    readonly isAttached: boolean;
+    /**
+     * Raw `w:basedOn/@w:val` (may be unresolved).
+     *
+     * @private
+     */
+    readonly basedOnId: string | undefined;
+    /**
+     * Resolved base style of the same public kind, when present and attached.
+     *
+     * @public
+     */
+    readonly baseStyle: Style | undefined;
+    /**
+     * Set base style by instance or style id (same-type, same-document).
+     *
+     * Pass `undefined` to clear the relationship.
+     *
+     * @public
+     */
+    applyBaseStyle(styleOrId: Style | string | undefined): void;
+    /** `w:next/@w:val`. @public */
+    nextStyleId: string | undefined;
+    /** `w:link/@w:val`. @public */
+    linkStyleId: string | undefined;
+    /** `w:uiPriority/@w:val`. @public */
+    uiPriority: number | undefined;
+    /** `w:qFormat`. @public */
+    isQuickStyle: boolean | undefined;
+    /** `w:semiHidden`. @public */
+    isSemiHidden: boolean | undefined;
+    /**
+     * @private
+     */
+    notifyCharacterFormatMutation(): void;
+    /**
+     * Attach to a document styles owner. Idempotent when already attached to the same owner.
+     *
+     * @private
+     */
+    attach(owner: StyleOwner): void;
+    /**
+     * Detach from the owning collection. Further mutations throw {@link DetachedObjectError}.
+     *
+     * @private
+     */
+    detach(): void;
+    /**
+     * Remove this style from the document styles collection: drop the `w:style`
+     * definition, detach this instance, and clear content/catalog references to
+     * its style id so save does not re-materialize a stub. After removal the
+     * instance is detached; a second call throws {@link DetachedObjectError}.
+     *
+     * @public
+     */
+    remove(): void;
+    /**
+     * Clear basedOn / next / link edges that point at `removedStyleId`.
+     * Used by StyleCollection.remove (no dirty — caller marks once).
+     *
+     * @private
+     */
+    clearReferencesToStyleId(removedStyleId: string): void;
+    /**
+     * Hydrate modeled fields and format facades from a parsed {@link DocxStyle}
+     * without marking dirty or running authoring exclusivity.
+     *
+     * @private
+     */
+    hydrateFromDocxStyle(source: DocxStyle): void;
+    /**
+     * Subclasses with paragraph format hydrate here; default no-op.
+     *
+     * @private
+     */
+    protected hydrateParagraphFormat(_snapshot: ParagraphFormatSnapshot): void;
+    /**
+     * Subclasses contribute `w:pPr` during serialize.
+     *
+     * @private
+     */
+    protected serializeParagraphProperties(_out: OpenXmlChild[]): void;
+    /**
+     * Serialize this live style to a `w:style` element.
+     *
+     * @private
+     */
+    serialize(): OpenXmlElement;
+    /**
+     * Character-format snapshot for the effective-format resolver.
+     *
+     * @private
+     */
+    characterFormatSnapshot(): CharacterFormatSnapshot;
+    /**
+     * Project this live style to a temporary DocxStyle shell (resolver / TableStyle).
+     *
+     * @private
+     */
+    toDocxStyle(): DocxStyle;
+    /**
+     * Replace live fields from a DocxStyle shell (TableStyle mutation path).
+     * Does not require attach; used while the style remains document-owned.
+     *
+     * @private
+     */
+    replaceShell(shell: DocxStyle): void;
+    /**
+     * Normalized display name for catalog lookup.
+     *
+     * @private
+     */
+    normalizedName(): string;
+    /**
+     * Opaque children retained for package fidelity (table props, conditionals, …).
+     *
+     * @private
+     */
+    protected getOpaqueChildren(): OpenXmlElement[];
+    /**
+     * Replace opaque children (TableStyle base props / tblStylePr).
+     *
+     * @private
+     */
+    protected setOpaqueChildren(children: OpenXmlElement[]): void;
+    /**
+     * @private
+     */
+    protected ensureAttached(): void;
+    /**
+     * @private
+     */
+    protected markDirty(): void;
+    /**
+     * Set metadata used when creating a minimal / seed style (no dirty).
+     *
+     * @private
+     */
+    protected seedIdentity(name: string | undefined, basedOnId: string | undefined): void;
+    /**
+     * Hydrate CF from snapshot without dirty (catalog / seed).
+     *
+     * @private
+     */
+    protected hydrateCharacterSnapshot(snapshot: CharacterFormatSnapshot): void;
+    /**
+     * Internal write of basedOn id during hydrate/seed (no dirty, no attach check).
+     *
+     * @private
+     */
+    setBasedOnIdInternal(value: string | undefined): void;
+    /**
+     * Internal next/link/ui flags during hydrate/seed.
+     *
+     * @private
+     */
+    setMetaInternal(meta: {
+        nextId?: string;
+        linkId?: string;
+        uiPriority?: number;
+        semiHidden?: boolean;
+        unhideWhenUsed?: boolean;
+        qFormat?: boolean;
+        aliases?: string;
+        autoRedefine?: boolean;
+        hidden?: boolean;
+        locked?: boolean;
+    }): void;
+    /** @private */
+    readonly nextIdInternal: string | undefined;
+    /** @private */
+    readonly linkIdInternal: string | undefined;
+}
+/**
+ * Paragraph style (`w:type="paragraph"`) with paragraph and character format facades.
+ *
+ * @public
+ */
+export declare class ParagraphStyle extends Style implements ParagraphFormatHost {
+    private readonly paragraphFormatValue;
+    /**
+     * @private
+     */
+    constructor(styleId: string, defaultFlag?: boolean | undefined, customStyle?: boolean | undefined);
+    /**
+     * Style-level paragraph formatting (`w:pPr`). Stable facade identity.
+     *
+     * @public
+     */
+    readonly paragraphFormat: ParagraphFormat;
+    /**
+     * Resolved paragraph base style, when present.
+     *
+     * @public
+     */
+    readonly baseParagraphStyle: ParagraphStyle | undefined;
+    /**
+     * @private
+     */
+    notifyParagraphFormatMutation(): void;
+    /**
+     * @private
+     */
+    protected hydrateParagraphFormat(snapshot: ParagraphFormatSnapshot): void;
+    /**
+     * @private
+     */
+    protected serializeParagraphProperties(out: OpenXmlChild[]): void;
+    /**
+     * @private
+     */
+    paragraphFormatSnapshot(): ParagraphFormatSnapshot;
+    /**
+     * Create a minimal paragraph style (ensure / authoring).
+     *
+     * @private
+     */
+    static createMinimal(styleId: string): ParagraphStyle;
+    /**
+     * Hydrate a paragraph style from a parsed DocxStyle shell.
+     *
+     * @private
+     */
+    static fromDocxStyle(source: DocxStyle): ParagraphStyle;
+}
+/**
+ * Character style (`w:type="character"`) with a character format facade only.
+ *
+ * @public
+ */
+export declare class CharacterStyle extends Style {
+    /**
+     * @private
+     */
+    constructor(styleId: string, defaultFlag?: boolean | undefined, customStyle?: boolean | undefined);
+    /**
+     * Resolved character base style, when present.
+     *
+     * @public
+     */
+    readonly baseCharacterStyle: CharacterStyle | undefined;
+    /**
+     * Create a minimal character style (ensure / authoring).
+     *
+     * @private
+     */
+    static createMinimal(styleId: string): CharacterStyle;
+    /**
+     * Hydrate a character style from a parsed DocxStyle shell.
+     *
+     * @private
+     */
+    static fromDocxStyle(source: DocxStyle): CharacterStyle;
+}
+/**
+ * Non-paragraph, non-character style retained for package fidelity.
+ * Not part of the public Styles DOM surface.
+ *
+ * @private
+ */
+export declare class OpaqueStyle extends Style {
+    private paragraphFormatValue;
+    /**
+     * @private
+     */
+    constructor(styleId: string, type: DocxStyleType | undefined, defaultFlag: boolean | undefined, customStyle: boolean | undefined);
+    /**
+     * @private
+     */
+    protected hydrateParagraphFormat(snapshot: ParagraphFormatSnapshot): void;
+    /**
+     * @private
+     */
+    protected serializeParagraphProperties(out: OpenXmlChild[]): void;
+    /**
+     * @private
+     */
+    static fromDocxStyle(source: DocxStyle): OpaqueStyle;
+}
+/**
+ * Build a live Style from a temporary {@link DocxStyle} parse/catalog shell.
+ * Does not attach; caller attaches via the collection.
+ * Table styles are created as {@link OpaqueStyle} here — the collection upgrades
+ * `type === 'table'` shells to {@link TableStyle}.
+ *
+ * @private
+ */
+export declare function createStyleFromDocxStyle(source: DocxStyle): Style;
+/**
+ * Alias for {@link createStyleFromDocxStyle} (legacy shell projection name).
+ *
+ * @private
+ */
+export declare function styleFromDocxShell(shell: DocxStyle): Style;
+/**
+ * Minimal paragraph or character style for ensure / pending materialize.
+ *
+ * @private
+ */
+export declare function createMinimalStyle(styleId: string, type: 'paragraph' | 'character'): Style;