@syncfusion/ej2-pdf-export 25.1.38 → 26.1.35

package/dist/ts/implementation/document/pdf-document-base.d.ts

@@ -0,0 +1,132 @@
+/**
+ * PdfDocumentBase.ts class for EJ2-PDF
+ */
+import { PdfMainObjectCollection } from './../input-output/pdf-main-object-collection';
+import { PdfCrossTable } from './../input-output/pdf-cross-table';
+import { PdfCatalog } from './pdf-catalog';
+import { PdfDocument } from './pdf-document';
+import { PdfReference } from './../primitives/pdf-reference';
+import { PdfViewerPreferences } from './pdf-viewer-preferences';
+/**
+ * `PdfDocumentBase` class represent common properties of PdfDocument classes.
+ * @private
+ */
+export declare class PdfDocumentBase {
+    /**
+     * Collection of the main `objects`.
+     * @private
+     */
+    private objects;
+    /**
+     * The `cross table`.
+     * @private
+     */
+    private pdfCrossTable;
+    /**
+     * `Object` that is saving currently.
+     * @private
+     */
+    private currentSavingObject;
+    /**
+     * Document `catlog`.
+     * @private
+     */
+    private pdfCatalog;
+    /**
+     * If the stream is copied,  then it specifies true.
+     * @private
+     */
+    isStreamCopied: boolean;
+    /**
+     * Instance of parent `document`.
+     * @private
+     */
+    document: PdfDocument;
+    /**
+     * Initializes a new instance of the `PdfDocumentBase` class.
+     * @private
+     */
+    constructor();
+    /**
+     * Initializes a new instance of the `PdfDocumentBase` class with instance of PdfDocument as argument.
+     * @private
+     */
+    constructor(document: PdfDocument);
+    /**
+     * Gets the `PDF objects` collection, which stores all objects and references to it..
+     * @private
+     */
+    readonly pdfObjects: PdfMainObjectCollection;
+    /**
+     * Gets the `cross-reference` table.
+     * @private
+     */
+    readonly crossTable: PdfCrossTable;
+    /**
+     * Gets or sets the current saving `object number`.
+     * @private
+     */
+    currentSavingObj: PdfReference;
+    /**
+     * Gets the PDF document `catalog`.
+     * @private
+     */
+    catalog: PdfCatalog;
+    /**
+     * Gets viewer preferences for presenting the PDF document in a viewer.
+     * ```typescript
+     * // Create a new PDF document
+     * let document : PdfDocument = new PdfDocument();
+     * // Gets viewer preferences
+     * let viewerPreferences : PdfViewerPreferences = document.viewerPreferences;
+     * // Destroy the document
+     * document.destroy();
+     * ```
+     */
+    readonly viewerPreferences: PdfViewerPreferences;
+    /**
+     * Sets the `main object collection`.
+     * @private
+     */
+    setMainObjectCollection(mainObjectCollection: PdfMainObjectCollection): void;
+    /**
+     * Sets the `cross table`.
+     * @private
+     */
+    setCrossTable(cTable: PdfCrossTable): void;
+    /**
+     * Sets the `catalog`.
+     * @private
+     */
+    setCatalog(catalog: PdfCatalog): void;
+    /**
+     * `Saves` the document to the specified filename.
+     * @private
+     */
+    save(): Promise<{
+        blobData: Blob;
+    }>;
+    /**
+     * `Saves` the document to the specified filename.
+     * @public
+     * ```typescript
+     * // create a new PDF document
+     * let document : PdfDocument = new PdfDocument();
+     * // add a pages to the document
+     * let page1 : PdfPage = document.pages.add();
+     * //
+     * // save the document
+     * document.save('output.pdf');
+     * //
+     * // destroy the document
+     * document.destroy();
+     * ```
+     * @param filename Specifies the file name to save the output pdf document.
+     */
+    save(filename: string): void;
+    /**
+     * `Clone` of parent object - PdfDocument.
+     * @private
+     */
+    clone(): PdfDocument;
+}

package/dist/ts/implementation/document/pdf-document-base.ts

@@ -0,0 +1,180 @@
+/**
+ * PdfDocumentBase.ts class for EJ2-PDF
+ */
+import { PdfMainObjectCollection } from './../input-output/pdf-main-object-collection';
+import { PdfCrossTable } from './../input-output/pdf-cross-table';
+import { PdfCatalog } from './pdf-catalog';
+import { Encoding, StreamWriter } from '@syncfusion/ej2-file-utils';
+import { PdfDocument } from './pdf-document';
+import { PdfReference } from './../primitives/pdf-reference';
+import { PdfViewerPreferences } from './pdf-viewer-preferences';
+/**
+ * `PdfDocumentBase` class represent common properties of PdfDocument classes.
+ * @private
+ */
+export class PdfDocumentBase {
+    //Fields
+    /**
+     * Collection of the main `objects`.
+     * @private
+     */
+    private objects : PdfMainObjectCollection;
+    /**
+     * The `cross table`.
+     * @private
+     */
+    private pdfCrossTable : PdfCrossTable;
+    /**
+     * `Object` that is saving currently.
+     * @private
+     */
+    private currentSavingObject : PdfReference;
+    /**
+     * Document `catlog`.
+     * @private
+     */
+    private pdfCatalog : PdfCatalog;
+    /**
+     * If the stream is copied,  then it specifies true.
+     * @private
+     */
+    public isStreamCopied : boolean = false;
+    /**
+     * Instance of parent `document`.
+     * @private
+     */
+    public document : PdfDocument;
+    //constructor
+    /**
+     * Initializes a new instance of the `PdfDocumentBase` class.
+     * @private
+     */
+    public constructor()
+    /**
+     * Initializes a new instance of the `PdfDocumentBase` class with instance of PdfDocument as argument.
+     * @private
+     */
+    public constructor(document : PdfDocument)
+    public constructor(document? : PdfDocument) {
+        if (document instanceof PdfDocument) {
+            this.document = document;
+        }
+    }
+    //Prpperties
+    /**
+     * Gets the `PDF objects` collection, which stores all objects and references to it..
+     * @private
+     */
+    public get pdfObjects() : PdfMainObjectCollection {
+        return this.objects;
+    }
+    /**
+     * Gets the `cross-reference` table.
+     * @private
+     */
+    public get crossTable() : PdfCrossTable {
+        return this.pdfCrossTable;
+    }
+    /**
+     * Gets or sets the current saving `object number`.
+     * @private
+     */
+    public get currentSavingObj() : PdfReference {
+        return this.currentSavingObject;
+    }
+    public set currentSavingObj(value : PdfReference) {
+        this.currentSavingObject = value;
+    }
+    /**
+     * Gets the PDF document `catalog`.
+     * @private
+     */
+    public get catalog() : PdfCatalog {
+        return this.pdfCatalog;
+    }
+    public set catalog(value : PdfCatalog) {
+        this.pdfCatalog = value;
+    }
+    /**
+     * Gets viewer preferences for presenting the PDF document in a viewer.
+     * ```typescript
+     * // Create a new PDF document
+     * let document : PdfDocument = new PdfDocument();
+     * // Gets viewer preferences
+     * let viewerPreferences : PdfViewerPreferences = document.viewerPreferences;
+     * // Destroy the document
+     * document.destroy();
+     * ```
+     */
+    public get viewerPreferences() : PdfViewerPreferences {
+        return this.pdfCatalog.viewerPreferences;
+    }
+    //Public methods
+    /**
+     * Sets the `main object collection`.
+     * @private
+     */
+    public setMainObjectCollection(mainObjectCollection : PdfMainObjectCollection) : void {
+        this.objects = mainObjectCollection;
+    }
+    /**
+     * Sets the `cross table`.
+     * @private
+     */
+    public setCrossTable(cTable : PdfCrossTable) : void {
+        this.pdfCrossTable = cTable;
+    }
+    /**
+     * Sets the `catalog`.
+     * @private
+     */
+    public setCatalog(catalog : PdfCatalog) : void {
+        this.pdfCatalog = catalog;
+    }
+    /**
+     * `Saves` the document to the specified filename.
+     * @private
+     */
+    public save(): Promise<{blobData: Blob}>
+    /**
+     * `Saves` the document to the specified filename.
+     * @public
+     * ```typescript
+     * // create a new PDF document
+     * let document : PdfDocument = new PdfDocument();
+     * // add a pages to the document
+     * let page1 : PdfPage = document.pages.add();
+     * //
+     * // save the document
+     * document.save('output.pdf');
+     * //
+     * // destroy the document
+     * document.destroy();
+     * ```
+     * @param filename Specifies the file name to save the output pdf document.
+     */
+    public save(filename : string) : void
+    public save(filename ?: string) : Promise<{blobData: Blob}> | void {
+        let encoding: Encoding = new Encoding(true);
+        let SW : StreamWriter = new StreamWriter(encoding);
+        if (typeof filename === 'undefined') {
+            let encoding: Encoding = new Encoding(true);
+            let SW: StreamWriter = new StreamWriter(encoding);
+            return new Promise((resolve: Function, reject: Function) => {
+                /* tslint:disable-next-line:no-any */
+                let obj: any = {};
+                obj.blobData = new Blob([this.document.docSave(SW, true)], {type : 'application/pdf'});
+                resolve(obj);
+            });
+        } else {
+            this.document.docSave(SW, filename, true);
+        }
+    }
+    /**
+     * `Clone` of parent object - PdfDocument.
+     * @private
+     */
+    public clone() : PdfDocument {
+        return this.document;
+    }
+}

package/dist/ts/implementation/document/pdf-document-template.d.ts

@@ -0,0 +1,166 @@
+/**
+ * PdfDocumentTemplate.ts class for EJ2-PDF
+ */
+import { PdfPage } from './../pages/pdf-page';
+import { PdfPageTemplateElement } from './../pages/pdf-page-template-element';
+/**
+ * `PdfDocumentTemplate` class encapsulates a page template for all the pages in the document.
+ * @private
+ */
+export declare class PdfDocumentTemplate {
+    /**
+     * `Left` page template object.
+     * @private
+     */
+    private leftTemplate;
+    /**
+     * `Top` page template object.
+     * @private
+     */
+    private topTemplate;
+    /**
+     * `Right` page template object.
+     * @private
+     */
+    private rightTemplate;
+    /**
+     * `Bottom` page template object.
+     * @private
+     */
+    private bottomTemplate;
+    /**
+     * `EvenLeft` page template object.
+     * @private
+     */
+    private evenLeft;
+    /**
+     * `EvenTop` page template object.
+     * @private
+     */
+    private evenTop;
+    /**
+     * `EvenRight` page template object.
+     * @private
+     */
+    private evenRight;
+    /**
+     * `EventBottom` page template object.
+     * @private
+     */
+    private evenBottom;
+    /**
+     * `OddLeft` page template object.
+     * @private
+     */
+    private oddLeft;
+    /**
+     * `OddTop` page template object.
+     * @private
+     */
+    private oddTop;
+    /**
+     * `OddRight` page template object.
+     * @private
+     */
+    private oddRight;
+    /**
+     * `OddBottom` page template object.
+     * @private
+     */
+    private oddBottom;
+    /**
+     * `Left` page template object.
+     * @public
+     */
+    left: PdfPageTemplateElement;
+    /**
+     * `Top` page template object.
+     * @public
+     */
+    top: PdfPageTemplateElement;
+    /**
+     * `Right` page template object.
+     * @public
+     */
+    right: PdfPageTemplateElement;
+    /**
+     * `Bottom` page template object.
+     * @public
+     */
+    bottom: PdfPageTemplateElement;
+    /**
+     * `EvenLeft` page template object.
+     * @public
+     */
+    EvenLeft: PdfPageTemplateElement;
+    /**
+     * `EvenTop` page template object.
+     * @public
+     */
+    EvenTop: PdfPageTemplateElement;
+    /**
+     * `EvenRight` page template object.
+     * @public
+     */
+    EvenRight: PdfPageTemplateElement;
+    /**
+     * `EvenBottom` page template object.
+     * @public
+     */
+    EvenBottom: PdfPageTemplateElement;
+    /**
+     * `OddLeft` page template object.
+     * @public
+     */
+    OddLeft: PdfPageTemplateElement;
+    /**
+     * `OddTop` page template object.
+     * @public
+     */
+    OddTop: PdfPageTemplateElement;
+    /**
+     * `OddRight` page template object.
+     * @public
+     */
+    OddRight: PdfPageTemplateElement;
+    /**
+     * `OddBottom` page template object.
+     * @public
+     */
+    OddBottom: PdfPageTemplateElement;
+    /**
+     * Initializes a new instance of the `PdfDocumentTemplate` class.
+     * @public
+     */
+    constructor();
+    /**
+     * Returns `left` template.
+     * @public
+     */
+    getLeft(page: PdfPage): PdfPageTemplateElement;
+    /**
+     * Returns `top` template.
+     * @public
+     */
+    getTop(page: PdfPage): PdfPageTemplateElement;
+    /**
+     * Returns `right` template.
+     * @public
+     */
+    getRight(page: PdfPage): PdfPageTemplateElement;
+    /**
+     * Returns `bottom` template.
+     * @public
+     */
+    getBottom(page: PdfPage): PdfPageTemplateElement;
+    /**
+     * Checks whether the page `is even`.
+     * @private
+     */
+    private isEven;
+    /**
+     * Checks a `template element`.
+     * @private
+     */
+    private checkElement;
+}