@syncfusion/ej2-docx 0.0.0-stage → 35.1.40

package/src/features/document/sections.d.ts

@@ -0,0 +1,103 @@
+import { Section } from './section';
+import { SectionPropertiesModel } from './section-properties-model';
+import { WordDocument } from './document';
+/**
+ * @private
+ * Optional clone hook installed by the sections feature for {@link Sections.add}.
+ */
+export declare type SectionPageSetupClone = (source: SectionPropertiesModel) => SectionPropertiesModel;
+/**
+ * @private
+ * Optional default page-setup factory (sections feature) so new sections always
+ * receive a live {@link SectionPropertiesModel} while the feature is on.
+ */
+export declare type SectionPageSetupSeed = () => SectionPropertiesModel;
+/**
+ * @private
+ */
+export declare function registerSectionPageSetupClone(clone: SectionPageSetupClone): void;
+/**
+ * @private
+ */
+export declare function resetSectionPageSetupCloneForTests(): void;
+/**
+ * @private
+ */
+export declare function registerSectionPageSetupSeed(seed: SectionPageSetupSeed): void;
+/**
+ * @private
+ */
+export declare function resetSectionPageSetupSeedForTests(): void;
+/**
+ * @private
+ */
+export declare function currentSectionPageSetupSeed(): SectionPageSetupSeed | undefined;
+/**
+ * Ordered collection of document {@link Section} objects.
+ *
+ * A document always has at least one section. Removing the last section throws.
+ * {@link Sections.add} clones page setup from the previous last section when a
+ * clone hook is registered (sections feature); otherwise seeds a default when
+ * a seed hook is registered.
+ *
+ * @public
+ */
+export declare class Sections implements Iterable<Section> {
+    private readonly document;
+    private list;
+    private cachedLength;
+    /**
+     * @private
+     */
+    constructor(document: WordDocument, sections: ReadonlyArray<Section>);
+    /** Number of sections in the document. */
+    readonly count: number;
+    /**
+     * Append a new section after the current last section.
+     *
+     * Clones `pageSetup` from the previous last section when the sections
+     * feature has registered a clone hook; otherwise seeds a default letter
+     * page setup when a seed hook is registered.
+     *
+     * @returns The new {@link Section}.
+     */
+    add(): Section;
+    /**
+     * Insert a new section at `index` (`0…count` inclusive).
+     *
+     * @throws RangeError when `index` is outside `0…count`.
+     */
+    insert(index: number): Section;
+    /**
+     * Remove `section` from the document.
+     *
+     * @throws DetachedObjectError when `section` is not in this collection.
+     * @throws DetachedObjectError when removing would leave zero sections.
+     */
+    remove(section: Section): void;
+    /**
+     * Remove the section at `index`.
+     *
+     * @throws RangeError when `index` is out of range.
+     * @throws DetachedObjectError when removing would leave zero sections.
+     */
+    removeAt(index: number): void;
+    /**
+     * Index of `section`, or `-1`.
+     */
+    indexOf(section: Section): number;
+    [Symbol.iterator](): Iterator<Section>;
+    /**
+     * @private
+     * Replace section list after load partition (single-section bridge today).
+     */
+    replaceAll(sections: ReadonlyArray<Section>): void;
+    /**
+     * @private
+     */
+    asArray(): ReadonlyArray<Section>;
+    private rebuildIndexProperties;
+}
+export interface Sections {
+    readonly [index: number]: Section;
+}

package/src/features/document/sections.js

@@ -0,0 +1,217 @@
+import { Section } from './section';
+import { DetachedObjectError } from '../../core/errors/docx-error';
+var pageSetupClone;
+var pageSetupSeed;
+/**
+ * @private
+ */
+export function registerSectionPageSetupClone(clone) {
+    pageSetupClone = clone;
+}
+/**
+ * @private
+ */
+export function resetSectionPageSetupCloneForTests() {
+    pageSetupClone = undefined;
+}
+/**
+ * @private
+ */
+export function registerSectionPageSetupSeed(seed) {
+    pageSetupSeed = seed;
+}
+/**
+ * @private
+ */
+export function resetSectionPageSetupSeedForTests() {
+    pageSetupSeed = undefined;
+}
+/**
+ * @private
+ */
+export function currentSectionPageSetupSeed() {
+    return pageSetupSeed;
+}
+/**
+ * Resolve page setup for a newly authored section: clone previous when possible,
+ * otherwise seed a default when the sections feature is registered.
+ *
+ * @private
+ */
+function resolveAuthoredPageSetup(previous) {
+    if (previous !== undefined && pageSetupClone !== undefined) {
+        var model = previous.internalPageSetupModel();
+        if (model !== undefined) {
+            return pageSetupClone(model);
+        }
+    }
+    if (pageSetupSeed !== undefined) {
+        return pageSetupSeed();
+    }
+    return undefined;
+}
+/**
+ * Ordered collection of document {@link Section} objects.
+ *
+ * A document always has at least one section. Removing the last section throws.
+ * {@link Sections.add} clones page setup from the previous last section when a
+ * clone hook is registered (sections feature); otherwise seeds a default when
+ * a seed hook is registered.
+ *
+ * @public
+ */
+var Sections = /** @class */ (function () {
+    /**
+     * @private
+     */
+    function Sections(document, sections) {
+        this.cachedLength = 0;
+        if (sections.length < 1) {
+            throw new DetachedObjectError('Document must have at least one section');
+        }
+        this.document = document;
+        this.list = sections.slice();
+        for (var i = 0; i < this.list.length; i += 1) {
+            this.list[i].bindDocument(document);
+        }
+        this.rebuildIndexProperties();
+    }
+    Object.defineProperty(Sections.prototype, "count", {
+        /** Number of sections in the document. */
+        get: function () {
+            return this.list.length;
+        },
+        enumerable: true,
+        configurable: true
+    });
+    /**
+     * Append a new section after the current last section.
+     *
+     * Clones `pageSetup` from the previous last section when the sections
+     * feature has registered a clone hook; otherwise seeds a default letter
+     * page setup when a seed hook is registered.
+     *
+     * @returns The new {@link Section}.
+     */
+    Sections.prototype.add = function () {
+        var previous = this.list[this.list.length - 1];
+        var setup = resolveAuthoredPageSetup(previous);
+        var section = new Section(this.document, [], setup);
+        this.list.push(section);
+        section.bindDocument(this.document);
+        this.rebuildIndexProperties();
+        return section;
+    };
+    /**
+     * Insert a new section at `index` (`0…count` inclusive).
+     *
+     * @throws RangeError when `index` is outside `0…count`.
+     */
+    Sections.prototype.insert = function (index) {
+        if (index < 0 || index > this.list.length) {
+            throw new RangeError("Section index " + String(index) + " is out of range");
+        }
+        if (index === this.list.length) {
+            return this.add();
+        }
+        var sibling = this.list[index === 0 ? 0 : index - 1];
+        var setup = resolveAuthoredPageSetup(sibling);
+        var section = new Section(this.document, [], setup);
+        this.list.splice(index, 0, section);
+        section.bindDocument(this.document);
+        this.rebuildIndexProperties();
+        return section;
+    };
+    /**
+     * Remove `section` from the document.
+     *
+     * @throws DetachedObjectError when `section` is not in this collection.
+     * @throws DetachedObjectError when removing would leave zero sections.
+     */
+    Sections.prototype.remove = function (section) {
+        var at = this.list.indexOf(section);
+        if (at === -1) {
+            throw new DetachedObjectError('Section is not in this document');
+        }
+        this.removeAt(at);
+    };
+    /**
+     * Remove the section at `index`.
+     *
+     * @throws RangeError when `index` is out of range.
+     * @throws DetachedObjectError when removing would leave zero sections.
+     */
+    Sections.prototype.removeAt = function (index) {
+        if (index < 0 || index >= this.list.length) {
+            throw new RangeError("Section index " + String(index) + " is out of range");
+        }
+        if (this.list.length <= 1) {
+            throw new DetachedObjectError('Cannot remove the last section');
+        }
+        this.list.splice(index, 1);
+        this.rebuildIndexProperties();
+    };
+    /**
+     * Index of `section`, or `-1`.
+     */
+    Sections.prototype.indexOf = function (section) {
+        return this.list.indexOf(section);
+    };
+    Sections.prototype[Symbol.iterator] = function () {
+        var items = this.list.slice();
+        var i = 0;
+        return {
+            next: function () {
+                if (i >= items.length) {
+                    return { done: true, value: undefined };
+                }
+                var value = items[i];
+                i += 1;
+                return { done: false, value: value };
+            },
+        };
+    };
+    /**
+     * @private
+     * Replace section list after load partition (single-section bridge today).
+     */
+    Sections.prototype.replaceAll = function (sections) {
+        if (sections.length < 1) {
+            throw new DetachedObjectError('Document must have at least one section');
+        }
+        this.list = sections.slice();
+        for (var i = 0; i < this.list.length; i += 1) {
+            this.list[i].bindDocument(this.document);
+        }
+        this.rebuildIndexProperties();
+    };
+    /**
+     * @private
+     */
+    Sections.prototype.asArray = function () {
+        return this.list;
+    };
+    Sections.prototype.rebuildIndexProperties = function () {
+        var items = this.list;
+        var nextLen = items.length;
+        var prevLen = this.cachedLength;
+        var limit = prevLen > nextLen ? prevLen : nextLen;
+        for (var i = 0; i < limit; i += 1) {
+            var key = String(i);
+            if (i < nextLen) {
+                Object.defineProperty(this, key, {
+                    value: items[i],
+                    writable: false,
+                    enumerable: true,
+                    configurable: true,
+                });
+            }
+            else {
+                delete this[key];
+            }
+        }
+        this.cachedLength = nextLen;
+    };
+    return Sections;
+}());
+export { Sections };

package/src/features/document/sub-super-script.d.ts

@@ -0,0 +1,23 @@
+/**
+ * Vertical text position relative to the baseline (`w:vertAlign`).
+ *
+ * @public
+ */
+export declare enum SubSuperScript {
+    /** Normal baseline text (`w:vertAlign` baseline / omitted). */
+    None = 0,
+    /** Raised superscript. */
+    SuperScript = 1,
+    /** Lowered subscript. */
+    SubScript = 2
+}
+/**
+ * Map ST_VerticalAlignRun wire value to {@link SubSuperScript}.
+ * @private
+ */
+export declare function subSuperScriptFromWire(raw: string | undefined): SubSuperScript;
+/**
+ * Map {@link SubSuperScript} to ST_VerticalAlignRun wire value.
+ * @private
+ */
+export declare function subSuperScriptToWire(value: SubSuperScript): string | undefined;

package/src/features/document/sub-super-script.js

@@ -0,0 +1,43 @@
+/**
+ * Vertical text position relative to the baseline (`w:vertAlign`).
+ *
+ * @public
+ */
+export var SubSuperScript;
+(function (SubSuperScript) {
+    /** Normal baseline text (`w:vertAlign` baseline / omitted). */
+    SubSuperScript[SubSuperScript["None"] = 0] = "None";
+    /** Raised superscript. */
+    SubSuperScript[SubSuperScript["SuperScript"] = 1] = "SuperScript";
+    /** Lowered subscript. */
+    SubSuperScript[SubSuperScript["SubScript"] = 2] = "SubScript";
+})(SubSuperScript || (SubSuperScript = {}));
+/**
+ * Map ST_VerticalAlignRun wire value to {@link SubSuperScript}.
+ * @private
+ */
+export function subSuperScriptFromWire(raw) {
+    if (raw === 'superscript') {
+        return SubSuperScript.SuperScript;
+    }
+    if (raw === 'subscript') {
+        return SubSuperScript.SubScript;
+    }
+    return SubSuperScript.None;
+}
+/**
+ * Map {@link SubSuperScript} to ST_VerticalAlignRun wire value.
+ * @private
+ */
+export function subSuperScriptToWire(value) {
+    if (value === SubSuperScript.SuperScript) {
+        return 'superscript';
+    }
+    if (value === SubSuperScript.SubScript) {
+        return 'subscript';
+    }
+    if (value === SubSuperScript.None) {
+        return 'baseline';
+    }
+    return undefined;
+}