@syncfusion/ej2-pdf-export 25.2.3 → 26.1.35

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

@@ -0,0 +1,310 @@
+/**
+ * PdfDocumentTemplate.ts class for EJ2-PDF
+ */
+import { PdfPage } from './../pages/pdf-page';
+import { TemplateType } from './../pages/enum';
+import { PdfDocumentPageCollection } from './../pages/pdf-document-page-collection';
+import { PdfPageTemplateElement } from './../pages/pdf-page-template-element';
+// import { PdfStampCollection } from `./../Pages/PdfStampCollection`;
+/**
+ * `PdfDocumentTemplate` class encapsulates a page template for all the pages in the document.
+ * @private
+ */
+export class PdfDocumentTemplate {
+    // Fields
+    /**
+     * `Left` page template object.
+     * @private
+     */
+    private leftTemplate : PdfPageTemplateElement;
+    /**
+     * `Top` page template object.
+     * @private
+     */
+    private topTemplate : PdfPageTemplateElement;
+    /**
+     * `Right` page template object.
+     * @private
+     */
+    private rightTemplate : PdfPageTemplateElement;
+    /**
+     * `Bottom` page template object.
+     * @private
+     */
+    private bottomTemplate : PdfPageTemplateElement;
+    /**
+     * `EvenLeft` page template object.
+     * @private
+     */
+    private evenLeft : PdfPageTemplateElement;
+    /**
+     * `EvenTop` page template object.
+     * @private
+     */
+    private evenTop : PdfPageTemplateElement;
+    /**
+     * `EvenRight` page template object.
+     * @private
+     */
+    private evenRight : PdfPageTemplateElement;
+    /**
+     * `EventBottom` page template object.
+     * @private
+     */
+    private evenBottom : PdfPageTemplateElement;
+    /**
+     * `OddLeft` page template object.
+     * @private
+     */
+    private oddLeft : PdfPageTemplateElement;
+    /**
+     * `OddTop` page template object.
+     * @private
+     */
+    private oddTop : PdfPageTemplateElement;
+    /**
+     * `OddRight` page template object.
+     * @private
+     */
+    private oddRight : PdfPageTemplateElement;
+    /**
+     * `OddBottom` page template object.
+     * @private
+     */
+    private oddBottom : PdfPageTemplateElement;
+    // private m_stamps : PdfStampCollection;
+    // Properties
+    /**
+     * `Left` page template object.
+     * @public
+     */
+    public get left() : PdfPageTemplateElement {
+        return this.leftTemplate;
+    }
+    public set left(value : PdfPageTemplateElement) {
+        this.leftTemplate = this.checkElement(value, TemplateType.Left);
+    }
+    /**
+     * `Top` page template object.
+     * @public
+     */
+    public get top() : PdfPageTemplateElement {
+        return this.topTemplate;
+    }
+    public set top(value : PdfPageTemplateElement) {
+        this.topTemplate = this.checkElement(value, TemplateType.Top);
+    }
+    /**
+     * `Right` page template object.
+     * @public
+     */
+    public get right() : PdfPageTemplateElement {
+        return this.rightTemplate;
+    }
+    public set right(value : PdfPageTemplateElement) {
+        this.rightTemplate = this.checkElement(value, TemplateType.Right);
+    }
+    /**
+     * `Bottom` page template object.
+     * @public
+     */
+    public get bottom() : PdfPageTemplateElement {
+        return this.bottomTemplate;
+    }
+    public set bottom(value : PdfPageTemplateElement) {
+        this.bottomTemplate = this.checkElement(value, TemplateType.Bottom);
+    }
+    /**
+     * `EvenLeft` page template object.
+     * @public
+     */
+    public get EvenLeft() : PdfPageTemplateElement {
+        return this.evenLeft;
+    }
+    public set EvenLeft(value : PdfPageTemplateElement) {
+        this.evenLeft = this.checkElement(value, TemplateType.Left);
+    }
+    /**
+     * `EvenTop` page template object.
+     * @public
+     */
+    public get EvenTop() : PdfPageTemplateElement {
+        return this.evenTop;
+    }
+    public set EvenTop(value : PdfPageTemplateElement) {
+        this.evenTop = this.checkElement(value, TemplateType.Top);
+    }
+    /**
+     * `EvenRight` page template object.
+     * @public
+     */
+    public get EvenRight() : PdfPageTemplateElement {
+        return this.evenRight;
+    }
+    public set EvenRight(value : PdfPageTemplateElement) {
+        this.evenRight = this.checkElement(value, TemplateType.Right);
+    }
+    /**
+     * `EvenBottom` page template object.
+     * @public
+     */
+    public get EvenBottom() : PdfPageTemplateElement {
+        return this.evenBottom;
+    }
+    public set EvenBottom(value : PdfPageTemplateElement) {
+        this.evenBottom = this.checkElement(value, TemplateType.Bottom);
+    }
+    /**
+     * `OddLeft` page template object.
+     * @public
+     */
+    public get OddLeft() : PdfPageTemplateElement {
+        return this.oddLeft;
+    }
+    public set OddLeft(value : PdfPageTemplateElement) {
+        this.oddLeft = this.checkElement(value, TemplateType.Left);
+    }
+    /**
+     * `OddTop` page template object.
+     * @public
+     */
+    public get OddTop() : PdfPageTemplateElement {
+        return this.oddTop;
+    }
+    public set OddTop(value : PdfPageTemplateElement) {
+        this.oddTop = this.checkElement(value, TemplateType.Top);
+    }
+    /**
+     * `OddRight` page template object.
+     * @public
+     */
+    public get OddRight() : PdfPageTemplateElement {
+        return this.oddRight;
+    }
+    public set OddRight(value : PdfPageTemplateElement) {
+        this.oddRight = this.checkElement(value, TemplateType.Right);
+    }
+    /**
+     * `OddBottom` page template object.
+     * @public
+     */
+    public get OddBottom() : PdfPageTemplateElement {
+        return this.oddBottom;
+    }
+    public set OddBottom(value : PdfPageTemplateElement) {
+        this.oddBottom = this.checkElement(value, TemplateType.Bottom);
+    }
+    // Constructors
+    /**
+     * Initializes a new instance of the `PdfDocumentTemplate` class.
+     * @public
+     */
+    public constructor() {
+        //
+    }
+    // Implementation
+    /**
+     * Returns `left` template.
+     * @public
+     */
+    public getLeft(page : PdfPage) : PdfPageTemplateElement {
+        if (page == null) {
+            throw new Error('ArgumentNullException:page');
+        }
+        let template : PdfPageTemplateElement = null;
+        // if (page.Document.Pages != null) {
+        let even : boolean = this.isEven(page);
+        if (even) {
+            template = (this.EvenLeft != null) ? this.EvenLeft : this.left;
+        } else {
+            template = (this.OddLeft != null) ? this.OddLeft : this.left;
+        }
+        // }
+        return template;
+    }
+    /**
+     * Returns `top` template.
+     * @public
+     */
+    public getTop(page : PdfPage) : PdfPageTemplateElement {
+        if (page == null) {
+            throw new Error('ArgumentNullException:page');
+        }
+        let template : PdfPageTemplateElement = null;
+        // if (page.Document.Pages != null) {
+        let even : boolean = this.isEven(page);
+        if (even) {
+            template = (this.EvenTop != null) ? this.EvenTop : this.top;
+        } else {
+            template = (this.OddTop != null) ? this.OddTop : this.top;
+        }
+        // }
+        return template;
+    }
+    /**
+     * Returns `right` template.
+     * @public
+     */
+    public getRight(page : PdfPage) : PdfPageTemplateElement {
+        if (page == null) {
+            throw new Error('ArgumentNullException:page');
+        }
+        let template : PdfPageTemplateElement = null;
+        // if (page.Document.Pages != null) {
+        let even : boolean = this.isEven(page);
+        if (even) {
+            template = (this.EvenRight != null) ? this.EvenRight : this.right;
+        } else {
+            template = (this.OddRight != null) ? this.OddRight : this.right;
+        }
+        // }
+        return template;
+    }
+    /**
+     * Returns `bottom` template.
+     * @public
+     */
+    public getBottom(page : PdfPage) : PdfPageTemplateElement {
+        if (page == null) {
+            throw new Error('ArgumentNullException:page');
+        }
+        let template : PdfPageTemplateElement = null;
+        // if (page.Document.Pages != null) {
+        let even : boolean = this.isEven(page);
+        if (even) {
+            template = (this.EvenBottom != null) ? this.EvenBottom : this.bottom;
+        } else {
+            template = (this.OddBottom != null) ? this.OddBottom : this.bottom;
+        }
+        // }
+        return template;
+    }
+    /**
+     * Checks whether the page `is even`.
+     * @private
+     */
+    private isEven(page : PdfPage) : boolean {
+        let pages : PdfDocumentPageCollection = page.section.document.pages;
+        let index : number = 0;
+        if (pages.pageCollectionIndex.containsKey(page)) {
+            index = pages.pageCollectionIndex.getValue(page) + 1;
+        } else {
+            index = pages.indexOf(page) + 1;
+        }
+        let even : boolean = ((index % 2) === 0);
+        return even;
+    }
+    /**
+     * Checks a `template element`.
+     * @private
+     */
+    private checkElement(templateElement : PdfPageTemplateElement, type : TemplateType) : PdfPageTemplateElement {
+        if (templateElement != null) {
+            if ((typeof templateElement.type !== 'undefined') && (templateElement.type !== TemplateType.None)) {
+                throw new Error('NotSupportedException:Can not reassign the template element. Please, create new one.');
+            }
+            templateElement.type = type;
+        }
+        return templateElement;
+    }
+}

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

@@ -0,0 +1,221 @@
+import { StreamWriter } from '@syncfusion/ej2-file-utils';
+import { PdfDocumentBase } from './pdf-document-base';
+import { PdfPageSettings } from './../pages/pdf-page-settings';
+import { PdfSectionCollection } from './../pages/pdf-section-collection';
+import { PdfDocumentPageCollection } from './../pages/pdf-document-page-collection';
+import { PdfCacheCollection } from './../general/pdf-cache-collection';
+import { PdfColorSpace } from './../graphics/enum';
+import { PdfDocumentTemplate } from './pdf-document-template';
+import { PdfFont } from './../graphics/fonts/pdf-font';
+/**
+ * Represents a PDF document and can be used to create a new PDF document from the scratch.
+ * ```typescript
+ * // create a new PDF document
+ * let document : PdfDocument = new PdfDocument();
+ * // add a new page to the document
+ * let page1 : PdfPage = document.pages.add();
+ * // set the font
+ * let font : PdfStandardFont = new PdfStandardFont(PdfFontFamily.Helvetica, 20);
+ * // create black brush
+ * let blackBrush : PdfSolidBrush = new PdfSolidBrush(new PdfColor(0, 0, 0));
+ * // draw the text
+ * page1.graphics.drawString('Hello World', font, blackBrush, new PointF(0, 0));
+ * // save the document
+ * document.save('output.pdf');
+ * // destroy the document
+ * document.destroy();
+ * ```
+ */
+export declare class PdfDocument extends PdfDocumentBase {
+    /**
+     * `Cache` of the objects.
+     * @private
+     */
+    private static cacheCollection;
+    /**
+     * Default `margin` value.
+     * @default 40.0
+     * @private
+     */
+    readonly defaultMargin: number;
+    /**
+     * Default page `settings`.
+     * @private
+     */
+    private settings;
+    /**
+     * Internal variable to store document`s collection of `sections`.
+     * @private
+     */
+    private sectionCollection;
+    /**
+     * Internal variable to store document`s collection of `pages`.
+     * @private
+     */
+    private documentPageCollection;
+    /**
+     * Internal variable to store instance of `StreamWriter` classes..
+     * @default null
+     * @private
+     */
+    streamWriter: StreamWriter;
+    /**
+     * Defines the `color space` of the document
+     * @private
+     */
+    private pdfColorSpace;
+    /**
+     * Internal variable to store `template` which is applied to each page of the document.
+     * @private
+     */
+    private pageTemplate;
+    /**
+     * `Font` used in complex objects to draw strings and text when it is not defined explicitly.
+     * @default null
+     * @private
+     */
+    private static defaultStandardFont;
+    /**
+     * Indicates whether enable cache or not
+     * @default true
+     * @private
+     */
+    private static isCacheEnabled;
+    /**
+     * Initializes a new instance of the `PdfDocument` class.
+     * @public
+     */
+    constructor();
+    /**
+     * Initializes a new instance of the `PdfDocument` class.
+     * @private
+     */
+    constructor(isMerging: boolean);
+    /**
+     * Gets the `default font`. It is used for complex objects when font is not explicitly defined.
+     * @private
+     */
+    static readonly defaultFont: PdfFont;
+    /**
+     * Gets the collection of the `sections` in the document.
+     * @private
+     */
+    readonly sections: PdfSectionCollection;
+    /**
+     * Gets the document's page setting.
+     * @public
+     */
+    /**
+    * Sets the document's page setting.
+    * ```typescript
+    * // create a new PDF document
+    * let document : PdfDocument = new PdfDocument();
+    *
+    * // sets the right margin of the page
+    * document.pageSettings.margins.right = 0;
+    * // set the page size.
+    * document.pageSettings.size = new SizeF(500, 500);
+    * // change the page orientation to landscape
+    * document.pageSettings.orientation = PdfPageOrientation.Landscape;
+    * // apply 90 degree rotation on the page
+    * document.pageSettings.rotate = PdfPageRotateAngle.RotateAngle90;
+    *
+    * // add a pages to the document
+    * let page1 : PdfPage = document.pages.add();
+    * // set font
+    * let font : PdfStandardFont = new PdfStandardFont(PdfFontFamily.Helvetica, 20);
+    * // set brush
+    * let blackBrush : PdfSolidBrush = new PdfSolidBrush(new PdfColor(0, 0, 0));
+    * // set the specified Point
+    * let point : PointF = new PointF(page1.getClientSize().width - 200, page1.getClientSize().height - 200);
+    * // draw the text
+    * page1.graphics.drawString('Hello World', font, blackBrush, point);
+    * // save the document
+    * document.save('output.pdf');
+    * // destroy the document
+    * document.destroy();
+    * ```
+    */
+    pageSettings: PdfPageSettings;
+    /**
+     * Represents the collection of pages in the PDF document.
+     * ```typescript
+     * // create a new PDF document
+     * let document : PdfDocument = new PdfDocument();
+     * //
+     * // get the collection of pages in the document
+     * let pageCollection : PdfDocumentPageCollection  = document.pages;
+     * //
+     * // add pages
+     * let page1 : PdfPage = pageCollection.add();
+     * // save the document
+     * document.save('output.pdf');
+     * // destroy the document
+     * document.destroy();
+     * ```
+     */
+    readonly pages: PdfDocumentPageCollection;
+    /**
+     * Gets collection of the `cached objects`.
+     * @private
+     */
+    /**
+    * Sets collection of the `cached objects`.
+    * @private
+    */
+    static cache: PdfCacheCollection;
+    /**
+     * Gets the value of enable cache.
+     * @private
+     */
+    /**
+    * Sets thie value of enable cache.
+    * @private
+    */
+    static enableCache: boolean;
+    /**
+     * Gets or sets the `color space` of the document. This property can be used to create PDF document in RGB, Gray scale or CMYK color spaces.
+     * @private
+     */
+    colorSpace: PdfColorSpace;
+    /**
+     * Gets or sets a `template` to all pages in the document.
+     * @private
+     */
+    template: PdfDocumentTemplate;
+    /**
+     * Saves the document to the specified output stream and return the stream as Blob.
+     * @private
+     */
+    docSave(stream: StreamWriter, isBase: boolean): Blob;
+    /**
+     * Saves the document to the specified output stream.
+     * @private
+     */
+    docSave(stream: StreamWriter, filename: string, isBase: boolean): void;
+    /**
+     * Checks the pages `presence`.
+     * @private
+     */
+    private checkPagesPresence;
+    /**
+     * disposes the current instance of `PdfDocument` class.
+     * ```typescript
+     * // create a new PDF document
+     * let document : PdfDocument = new PdfDocument();
+     * // add a new page to the document
+     * let page1 : PdfPage = document.pages.add();
+     * // set the font
+     * let font : PdfStandardFont = new PdfStandardFont(PdfFontFamily.Helvetica, 20);
+     * // create black brush
+     * let blackBrush : PdfSolidBrush = new PdfSolidBrush(new PdfColor(0, 0, 0));
+     * // draw the text
+     * page1.graphics.drawString('Hello World', font, blackBrush, new PointF(0, 0));
+     * // save the document
+     * document.save('output.pdf');
+     * // destroy the document
+     * document.destroy();
+     * ```
+     */
+    destroy(): void;
+}