@syncfusion/ej2-docx 0.0.0-stage → 35.1.40

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

@@ -0,0 +1,264 @@
+import { WordDocument } from '../document/document';
+import { StyleLookupSurface } from './builtin-resolver';
+import { CharacterStyle, ParagraphStyle, Style, StyleOwner } from './style-base';
+import { DocxStyle } from './style';
+import { TableStyle } from './table-style';
+/**
+ * Callback surface from StyleCollection into StylesPart (dirty + optional hooks).
+ *
+ * @private
+ */
+export interface StyleCollectionHost {
+    markStylesDirty(): void;
+    /**
+     * Drop a stable DocxStyle projection for a removed style id (StylesPart cache).
+     *
+     * @private
+     */
+    forgetProjectedStyle?(styleId: string): void;
+    /**
+     * Clear content references (`w:pStyle` / `w:rStyle` / table style) to a removed
+     * style id across the document. Prevents save-time materialize from re-creating
+     * a minimal stub for dangling refs.
+     *
+     * @private
+     */
+    purgeContentStyleReferences?(document: WordDocument, styleId: string): void;
+}
+/**
+ * Public styles collection on {@link WordDocument.styles}.
+ *
+ * Stable identity: `document.styles === document.styles`.
+ * Entry identity: `getStyle(id) === getStyle(id)`.
+ *
+ * @public
+ */
+export declare class StyleCollection implements StyleOwner, Iterable<Style> {
+    private readonly document;
+    private readonly host;
+    private readonly styleList;
+    private readonly styleById;
+    private readonly pendingParagraphStyles;
+    private readonly pendingCharacterStyles;
+    private readonly pendingTableStyles;
+    /** Stable DocxStyle projections keyed by styleId (identity cache). */
+    private readonly projected;
+    private cachedLength;
+    /**
+     * @private
+     */
+    constructor(document: WordDocument, host: StyleCollectionHost, initial?: ReadonlyArray<Style>);
+    /**
+     * Owning document.
+     *
+     * @private
+     */
+    readonly ownerDocument: WordDocument;
+    /**
+     * Number of styles in document order.
+     *
+     * @public
+     */
+    readonly count: number;
+    /**
+     * Style at zero-based index, or `undefined` when out of range.
+     *
+     * @public
+     */
+    itemAt(index: number): Style | undefined;
+    [Symbol.iterator](): Iterator<Style>;
+    /**
+     * Look up any style by `w:styleId`.
+     *
+     * @public
+     */
+    getStyle(styleId: string): Style | undefined;
+    /**
+     * Look up any style by `w:styleId` (alias of {@link getStyle}).
+     *
+     * @public
+     */
+    findById(styleId: string): Style | undefined;
+    /**
+     * Look up a paragraph style by id.
+     *
+     * @public
+     */
+    getParagraphStyle(styleId: string): ParagraphStyle | undefined;
+    /**
+     * Look up a character style by id.
+     *
+     * @public
+     */
+    getCharacterStyle(styleId: string): CharacterStyle | undefined;
+    /**
+     * Look up a table style by id.
+     *
+     * @public
+     */
+    getTableStyle(styleId: string): TableStyle | undefined;
+    /**
+     * Find a style whose display name matches `name` (normalized).
+     *
+     * @public
+     */
+    findByName(name: string): Style | undefined;
+    /**
+     * Whether a style id exists (including pending ensure).
+     *
+     * @public
+     */
+    hasStyle(styleId: string): boolean;
+    /**
+     * Create and add a paragraph style with the given id.
+     * Throws when the id is empty or already present.
+     *
+     * @public
+     */
+    addParagraphStyle(styleId: string): ParagraphStyle;
+    /**
+     * Create and add a character style with the given id.
+     *
+     * @public
+     */
+    addCharacterStyle(styleId: string): CharacterStyle;
+    /**
+     * Create a custom table style and add it to this collection.
+     *
+     * @public
+     */
+    addTableStyle(name: string): TableStyle;
+    /**
+     * Ensure a paragraph style exists (built-in catalog or minimal stub).
+     * Returns the live style.
+     *
+     * @public
+     */
+    ensureParagraphStyle(styleId: string): ParagraphStyle;
+    /**
+     * Ensure a character style exists (built-in catalog or minimal stub).
+     *
+     * @public
+     */
+    ensureCharacterStyle(styleId: string): CharacterStyle;
+    /**
+     * Ensure a table style exists (built-in catalog or minimal stub).
+     *
+     * @public
+     */
+    ensureTableStyle(styleId: string): TableStyle;
+    /**
+     * Remove a style by id or instance. Detaches the style, clears pending /
+     * projection caches, strips content references (`pStyle` / `rStyle` / table
+     * style) and catalog edges (`basedOn` / `next` / `link`) that point at the
+     * removed id so save-time materialize cannot re-create a minimal stub.
+     * Returns `true` when removed.
+     *
+     * Not part of the public Styles collection surface — use {@link Style.remove}.
+     *
+     * @private
+     */
+    remove(styleOrId: Style | string): boolean;
+    /**
+     * Clear `basedOn` / `next` / `link` on remaining styles that point at `styleId`.
+     *
+     * @private
+     */
+    private purgeCatalogReferencesTo;
+    /**
+     * Ordered styles for package serialization.
+     *
+     * @private
+     */
+    stylesInOrder(): ReadonlyArray<Style>;
+    /**
+     * StyleOwner: mark styles part dirty and drop projection for all styles when
+     * a live mutation may have changed modeled XML (host may call for any style).
+     *
+     * @private
+     */
+    markStylesDirty(): void;
+    /**
+     * StyleOwner: lookup by id.
+     *
+     * @private
+     */
+    lookupStyle(styleId: string): Style | undefined;
+    /**
+     * Resolver / part surface: find by display name.
+     *
+     * @private
+     */
+    findStyleByDisplayName(name: string): DocxStyle | undefined;
+    /**
+     * Add a live style (resolver / hydrate). No-op when id already present.
+     *
+     * @private
+     */
+    addStyle(style: Style | DocxStyle): void;
+    /**
+     * Hydrate from temporary DocxStyle shells (parse / create path). Does not mark dirty
+     * when `markDirty` is false (load path).
+     *
+     * @private
+     */
+    hydrateFromDocxStyles(sources: ReadonlyArray<DocxStyle>, markDirty: boolean): void;
+    /**
+     * Replace contents from DocxStyle shells (load / create). Clears existing entries.
+     *
+     * @private
+     */
+    replaceFromDocxStyles(sources: ReadonlyArray<DocxStyle>, markDirty: boolean): void;
+    /** @private */
+    registerPendingParagraphStyle(styleId: string): void;
+    /** @private */
+    registerPendingCharacterStyle(styleId: string): void;
+    /** @private */
+    registerPendingTableStyle(styleId: string): void;
+    /**
+     * Materialize pending style ids and canonicalize dangling refs (save path).
+     *
+     * @private
+     */
+    materializePendingIds(onParagraphStyle: (fromId: string, toId: string) => void, onCharacterStyle: (fromId: string, toId: string) => void, onTableStyle?: (fromId: string, toId: string) => void): void;
+    /**
+     * Adapter so the existing DocxStyle-based catalog resolver can read/add into this collection.
+     *
+     * @private
+     */
+    asDocxLookup(): StyleLookupSurface;
+    /**
+     * Project live styles to temporary DocxStyle shells (resolver / transitional StylesPart surface).
+     *
+     * @private
+     */
+    projectDocxStyles(): DocxStyle[];
+    /**
+     * Project one live style to a DocxStyle shell, or `undefined`.
+     * Caches by styleId so StylesPart can keep stable object identity until dirty.
+     *
+     * @private
+     */
+    projectDocxStyle(styleId: string): DocxStyle | undefined;
+    /**
+     * @private
+     */
+    private ensureStyle;
+    private assertNewId;
+    /**
+     * Build live Style (or TableStyle) from a DocxStyle shell and index it.
+     *
+     * @private
+     */
+    private appendFromDocxShell;
+    private attachAndIndex;
+    /**
+     * Numeric index properties (CommentCollection pattern).
+     *
+     * @private
+     */
+    rebuildIndexProperties(): void;
+}
+export interface StyleCollection {
+    readonly [index: number]: Style;
+}