@syncfusion/ej2-docx 0.0.0-stage → 35.1.39

package/src/features/numbering/list-format.d.ts

@@ -0,0 +1,158 @@
+import { Paragraph } from '../document/paragraph';
+import { WordDocument } from '../document/document';
+import { AbstractNumbering, MultiLevelType } from './abstract-numbering';
+import { NumberingInstance } from './numbering-instance';
+import { NumberingLevel } from './numbering-level';
+import { ListType } from './list-style';
+import { NumberingPart } from './index';
+/**
+ * @deprecated Prefer {@link ListType}. Kept for internal ensureInstance format mapping.
+ * @private
+ */
+export declare type ListFormatType = 'bullet' | 'decimal';
+/** Minimal styles surface used by ListFormat.applyStyle. */
+export interface ListStyleLookup {
+    getStyle(id: string): {
+        styleId: string;
+        type: string | undefined;
+        name: string | undefined;
+    } | undefined;
+    findStyleByDisplayName(n: string): {
+        styleId: string;
+        type: string | undefined;
+        name: string | undefined;
+    } | undefined;
+}
+declare type StylesLookupFactory = (document: WordDocument) => ListStyleLookup;
+/**
+ * @private Registered by the styles feature so applyStyle avoids CJS require under Vitest.
+ */
+export declare function setStylesLookupFactory(factory: StylesLookupFactory): void;
+/**
+ * @private Test-only reset.
+ */
+export declare function resetStylesLookupFactoryForTests(): void;
+/**
+ * Live paragraph list formatting (`w:pPr/w:numPr` + document numbering catalog).
+ *
+ * Obtained via {@link Paragraph.listFormat}. The same logical instance is returned
+ * for repeated access on the same paragraph; mutations update the paragraph and
+ * numbering definitions immediately.
+ *
+ * @public
+ */
+export declare class ListFormat {
+    private readonly paragraph;
+    private listStyleNameValue;
+    /**
+     * @private
+     */
+    constructor(paragraph: Paragraph);
+    /** Owning paragraph. */
+    readonly ownerParagraph: Paragraph;
+    /** Numbering instance id (`w:num/@w:numId`), when the paragraph is in a list. */
+    /**
+    * Assign an existing numbering instance id, or clear with `undefined`.
+    * Prefer {@link applyDefBulletStyle} / {@link applyDefNumberedStyle} for new lists.
+    *
+    * Does not fabricate a default definition for unknown ids.
+    */
+    listId: number | undefined;
+    /** Zero-based indent level (`w:ilvl`), when present. */
+    listLevelNumber: number | undefined;
+    /** Whether the paragraph is assigned to a numbering instance. */
+    readonly isList: boolean;
+    /**
+     * Broad list category from the resolved active level's `numFmt`.
+     * {@link ListType.Bulleted} when `numFmt` is `bullet`; otherwise {@link ListType.Numbered}.
+     */
+    readonly listType: ListType | undefined;
+    /** Number format token at the active level (`w:numFmt/@w:val`). */
+    readonly numberFormat: string | undefined;
+    /** Level text pattern (`w:lvlText/@w:val`) at the active level. */
+    readonly levelText: string | undefined;
+    /** Named list style applied via {@link applyStyle}, when set. */
+    readonly listStyleName: string | undefined;
+    /** Start value at the active level (override or abstract level). */
+    /**
+    * Set a start override for the active level on the concrete numbering instance.
+    * Does not mutate the shared abstract definition.
+    */
+    startAt: number | undefined;
+    /**
+     * @private
+     * Abstract numbering definition id when the instance is resolved.
+     */
+    readonly abstractNumId: number | undefined;
+    /** Abstract multi-level type token, when available. */
+    readonly multiLevelType: MultiLevelType | undefined;
+    /** Abstract definition name, when present. */
+    readonly name: string | undefined;
+    /** Resolved numbering instance (`w:num`), when available. */
+    readonly resolvedList: NumberingInstance | undefined;
+    /** Resolved abstract numbering definition, when available. */
+    readonly resolvedAbstractList: AbstractNumbering | undefined;
+    /** Resolved active list level definition, when available. */
+    readonly resolvedListLevel: NumberingLevel | undefined;
+    /**
+     * Apply the default nine-level bullet list and set level `0`.
+     */
+    applyDefBulletStyle(): void;
+    /**
+     * Apply the default nine-level numbered (decimal hybrid) list and set level `0`.
+     */
+    applyDefNumberedStyle(): void;
+    /**
+     * Apply a named numbering style from the document styles part.
+     *
+     * Resolves `type="numbering"` styles by style id or display name, then binds a
+     * numbering instance linked through `w:styleLink` / abstract name, or creates
+     * a new instance from a matching abstract definition.
+     *
+     * @param styleName - Non-empty style id or display name.
+     * @throws InvalidArgumentError when `styleName` is empty.
+     * @throws DocxError when the style is missing or not a numbering style.
+     */
+    applyStyle(styleName: string): void;
+    /**
+     * Continue the nearest preceding list in document order.
+     * Reuses that paragraph's numbering instance; keeps this paragraph's level when set.
+     *
+     * @throws DocxError when no preceding list paragraph exists in the document.
+     */
+    continueListNumbering(): void;
+    /**
+     * Restart numbering as a new list instance that reuses the current abstract definition.
+     *
+     * @param startAt - Optional start value for the active level (`w:startOverride`).
+     */
+    restartNumbering(startAt?: number): void;
+    /**
+     * Increase the active list level by one (max 8). No-op when not in a list or already at 8.
+     */
+    increaseIndentLevel(): void;
+    /**
+     * Decrease the active list level by one (min 0). No-op when not in a list or already at 0.
+     * Does not remove list membership at level 0.
+     */
+    decreaseIndentLevel(): void;
+    /**
+     * Remove list membership (`w:numPr` / numId and ilvl) without deleting catalog definitions.
+     */
+    removeList(): void;
+    private catalog;
+    private activeLevelIndex;
+    private assertLevel;
+    private assertStartAt;
+    /**
+     * When abstract is already resolved, ensure `ilvl` exists; pending lists skip (nine levels on materialize).
+     */
+    private assertLevelExistsOnAbstract;
+    /** Map pending decimal ids to decimal ensure format; default bullet. */
+    private inferEnsureFormat;
+}
+/**
+ * @private
+ */
+export declare function resolveLevelDefinition(part: NumberingPart, numId: number, level: number): NumberingLevel | undefined;
+export {};