@syncfusion/ej2-pdf-export 25.2.3 → 26.1.35

package/dist/ts/implementation/document/automatic-fields/automatic-field.d.ts

@@ -0,0 +1,41 @@
+/**
+ * PdfAutomaticField.ts class for EJ2-PDF
+ */
+import { RectangleF, SizeF, PointF } from './../../drawing/pdf-drawing';
+import { PdfFont } from './../../graphics/fonts/pdf-font';
+import { PdfBrush } from './../../graphics/brushes/pdf-brush';
+import { PdfStringFormat } from './../../graphics/fonts/pdf-string-format';
+import { PdfPen } from './../../graphics/pdf-pen';
+import { PdfGraphics } from './../../graphics/pdf-graphics';
+import { PdfGraphicsElement } from './../../graphics/figures/base/graphics-element';
+import { PdfPage } from './../../pages/pdf-page';
+/**
+ * Represents a fields which is calculated before the document saves.
+ */
+export declare abstract class PdfAutomaticField extends PdfGraphicsElement {
+    private internalBounds;
+    private internalFont;
+    private internalBrush;
+    private internalPen;
+    private internalStringFormat;
+    private internalTemplateSize;
+    protected constructor();
+    bounds: RectangleF;
+    size: SizeF;
+    location: PointF;
+    font: PdfFont;
+    brush: PdfBrush;
+    pen: PdfPen;
+    stringFormat: PdfStringFormat;
+    abstract getValue(graphics: PdfGraphics): string;
+    abstract performDraw(graphics: PdfGraphics, location: PointF, scalingX: number, scalingY: number): void;
+    performDrawHelper(graphics: PdfGraphics, location: PointF, scalingX: number, scalingY: number): void;
+    draw(graphics: PdfGraphics): void;
+    draw(graphics: PdfGraphics, location: PointF): void;
+    draw(graphics: PdfGraphics, x: number, y: number): void;
+    protected getSize(): SizeF;
+    protected drawInternal(graphics: PdfGraphics): void;
+    protected getBrush(): PdfBrush;
+    protected getFont(): PdfFont;
+    getPageFromGraphics(graphics: PdfGraphics): PdfPage;
+}

package/dist/ts/implementation/document/automatic-fields/automatic-field.ts

@@ -0,0 +1,127 @@
+/**
+ * PdfAutomaticField.ts class for EJ2-PDF
+ */
+import { RectangleF, SizeF, PointF } from './../../drawing/pdf-drawing';
+import { PdfFont } from './../../graphics/fonts/pdf-font';
+import { PdfBrush } from './../../graphics/brushes/pdf-brush';
+import { PdfSolidBrush } from './../../graphics/brushes/pdf-solid-brush';
+import { PdfStringFormat } from './../../graphics/fonts/pdf-string-format';
+import { PdfPen } from './../../graphics/pdf-pen';
+import { PdfGraphics } from './../../graphics/pdf-graphics';
+import { PdfColor } from './../../graphics/pdf-color';
+import { PdfDocument } from './../pdf-document';
+import { PdfGraphicsElement } from './../../graphics/figures/base/graphics-element';
+import { PdfAutomaticFieldInfo } from './automatic-field-info';
+import { PdfPage } from './../../pages/pdf-page';
+/**
+ * Represents a fields which is calculated before the document saves.
+ */
+export abstract class PdfAutomaticField extends PdfGraphicsElement {
+    // Fields
+    private internalBounds : RectangleF = new RectangleF(0, 0, 0, 0);
+    private internalFont : PdfFont;
+    private internalBrush : PdfBrush;
+    private internalPen : PdfPen;
+    private internalStringFormat : PdfStringFormat;
+    private internalTemplateSize : SizeF = new SizeF(0, 0);
+    // Constructors
+    protected constructor() {
+        super();
+    }
+    // Properties
+    public get bounds() : RectangleF {
+        return this.internalBounds;
+    }
+    public set bounds(value : RectangleF) {
+        this.internalBounds = value;
+    }
+    public get size() : SizeF {
+        return new SizeF(this.bounds.width, this.bounds.height);
+    }
+    public set size(value : SizeF) {
+        this.bounds.width = value.width;
+        this.bounds.height = value.height;
+    }
+    public get location() : PointF {
+        return new PointF(this.bounds.x, this.bounds.y);
+    }
+    public set location(value : PointF) {
+        this.bounds.x = value.x;
+        this.bounds.y = value.y;
+    }
+    public get font() : PdfFont {
+        return this.internalFont;
+    }
+    public set font(value : PdfFont) {
+        this.internalFont = value;
+    }
+    public get brush() : PdfBrush {
+        return this.internalBrush;
+    }
+    public set brush(value : PdfBrush) {
+        this.internalBrush = value;
+    }
+    public get pen() : PdfPen {
+        return this.internalPen;
+    }
+    public set pen(value : PdfPen) {
+        this.internalPen = value;
+    }
+    public get stringFormat() : PdfStringFormat {
+        return this.internalStringFormat;
+    }
+    public set stringFormat(value : PdfStringFormat) {
+        this.internalStringFormat = value;
+    }
+    // Implementation
+    public abstract getValue(graphics : PdfGraphics) : string;
+    public abstract performDraw(graphics : PdfGraphics, location : PointF, scalingX : number, scalingY : number) : void;
+    public performDrawHelper(graphics : PdfGraphics, location : PointF, scalingX : number, scalingY : number) : void {
+        if (this.bounds.height === 0 || this.bounds.width === 0) {
+            let text : string = this.getValue(graphics);
+            this.internalTemplateSize = this.getFont().measureString(text, this.size, this.stringFormat);
+        }
+    }
+    public draw(graphics : PdfGraphics) : void
+    public draw(graphics : PdfGraphics, location : PointF) : void
+    public draw(graphics : PdfGraphics, x : number, y : number) : void
+    public draw(arg1 ?: PdfGraphics, arg2 ?: number | PointF, arg3 ?: number) : void {
+        if (typeof arg2 === 'undefined') {
+            let location : PointF = new PointF(0, 0);
+            this.draw(arg1, location);
+        } else if (arg2 instanceof PointF) {
+            this.draw(arg1, arg2.x, arg2.y);
+        } else {
+            this.drawHelper(arg1, arg2, arg3);
+            let info : PdfAutomaticFieldInfo = new PdfAutomaticFieldInfo(this, new PointF(arg2, arg3));
+            arg1.automaticFields.add(info);
+        }
+    }
+    protected getSize() : SizeF {
+        if (this.bounds.height === 0 || this.bounds.width === 0) {
+            return this.internalTemplateSize;
+        } else {
+            return this.size;
+        }
+    }
+    protected drawInternal(graphics : PdfGraphics) : void {
+        //
+    }
+    /* tslint:disable */
+    protected getBrush() : PdfBrush {
+        return (typeof this.internalBrush === 'undefined' || this.internalBrush == null) ? new PdfSolidBrush(new PdfColor(0, 0, 0)) : this.internalBrush;
+    }
+    protected getFont() : PdfFont {
+        return (typeof this.internalFont === 'undefined' || this.internalFont == null) ? PdfDocument.defaultFont : this.internalFont;
+    }
+    /* tslint:enable */
+    public getPageFromGraphics(graphics : PdfGraphics) : PdfPage {
+        if (typeof graphics.page !== 'undefined' && graphics.page !== null) {
+            let page : PdfPage = graphics.page as PdfPage;
+            return page;
+        } else {
+            let page : PdfPage = graphics.currentPage as PdfPage;
+            return page;
+        }
+    }
+}

package/dist/ts/implementation/document/automatic-fields/composite-field.d.ts

@@ -0,0 +1,46 @@
+/**
+ * PdfCompositeField.ts class for EJ2-PDF
+ */
+import { PdfMultipleValueField } from './multiple-value-field';
+import { PdfAutomaticField } from './automatic-field';
+import { PdfFont } from './../../graphics/fonts/pdf-font';
+import { PdfBrush } from './../../graphics/brushes/pdf-brush';
+import { PdfGraphics } from './../../graphics/pdf-graphics';
+/**
+ * Represents class which can concatenate multiple automatic fields into single string.
+ */
+export declare class PdfCompositeField extends PdfMultipleValueField {
+    /**
+     * Stores the array of automatic fields.
+     * @private
+     */
+    private internalAutomaticFields;
+    /**
+     * Stores the text value of the field.
+     * @private
+     */
+    private internalText;
+    /**
+     * Initialize a new instance of `PdfCompositeField` class.
+     * @param font Font of the field.
+     * @param brush Color of the field.
+     * @param text Content of the field.
+     * @param list List of the automatic fields in specific order based on the text content.
+     */
+    constructor(font: PdfFont, brush: PdfBrush, text: string, ...list: PdfAutomaticField[]);
+    /**
+     * Gets and sets the content of the field.
+     * @public
+     */
+    text: string;
+    /**
+     * Gets and sets the list of the field to drawn.
+     * @public
+     */
+    automaticFields: PdfAutomaticField[];
+    /**
+     * Return the actual value generated from the list of automatic fields.
+     * @public
+     */
+    getValue(graphics: PdfGraphics): string;
+}

package/dist/ts/implementation/document/automatic-fields/composite-field.ts

@@ -0,0 +1,76 @@
+/**
+ * PdfCompositeField.ts class for EJ2-PDF
+ */
+import { PdfMultipleValueField } from './multiple-value-field';
+import { PdfAutomaticField } from './automatic-field';
+import { PdfFont } from './../../graphics/fonts/pdf-font';
+import { PdfBrush } from './../../graphics/brushes/pdf-brush';
+import { PdfGraphics } from './../../graphics/pdf-graphics';
+/**
+ * Represents class which can concatenate multiple automatic fields into single string.
+ */
+export class PdfCompositeField extends PdfMultipleValueField {
+    // Fields
+    /**
+     * Stores the array of automatic fields.
+     * @private
+     */
+    private internalAutomaticFields : PdfAutomaticField[] = null;
+    /**
+     * Stores the text value of the field.
+     * @private
+     */
+    private internalText : string = '';
+    // Constructor
+    /**
+     * Initialize a new instance of `PdfCompositeField` class.
+     * @param font Font of the field.
+     * @param brush Color of the field.
+     * @param text Content of the field.
+     * @param list List of the automatic fields in specific order based on the text content.
+     */
+    public constructor(font : PdfFont, brush : PdfBrush, text : string, ...list : PdfAutomaticField[]) {
+        super();
+        this.font = font;
+        this.brush = brush;
+        this.text = text;
+        this.automaticFields = list;
+    }
+    // Properties
+    /**
+     * Gets and sets the content of the field.
+     * @public
+     */
+    public get text() : string {
+        return this.internalText;
+    }
+    public set text(value : string) {
+        this.internalText = value;
+    }
+    /**
+     * Gets and sets the list of the field to drawn.
+     * @public
+     */
+    public get automaticFields() : PdfAutomaticField[] {
+        return this.internalAutomaticFields;
+    }
+    public set automaticFields(value : PdfAutomaticField[]) {
+        this.internalAutomaticFields = value;
+    }
+    // Implementation
+    /**
+     * Return the actual value generated from the list of automatic fields.
+     * @public
+     */
+    public getValue(graphics : PdfGraphics) : string {
+        let values : string[] = [];
+        let text : string = this.text.toString();
+        if (typeof this.automaticFields !== 'undefined' && this.automaticFields != null && this.automaticFields.length > 0) {
+            for (let i : number = 0; i < this.automaticFields.length; i++) {
+                let automaticField : PdfAutomaticField = this.automaticFields[i];
+                text = text.replace('{' + i + '}', automaticField.getValue(graphics));
+            }
+        }
+        return text;
+    }
+}

package/dist/ts/implementation/document/automatic-fields/index.d.ts

@@ -0,0 +1,11 @@
+/**
+ * Automatic fields classes
+ * @hidden
+ */
+export * from './pdf-numbers-convertor';
+export * from './pdf-page-number-field';
+export * from './automatic-field-info';
+export * from './automatic-field-info-collection';
+export * from './automatic-field';
+export * from './multiple-value-field';
+export * from './pdf-template-value-pair';

package/dist/ts/implementation/document/automatic-fields/index.ts

@@ -0,0 +1,11 @@
+/**
+ * Automatic fields classes
+ * @hidden
+ */
+export * from './pdf-numbers-convertor';
+export * from './pdf-page-number-field';
+export * from './automatic-field-info';
+export * from './automatic-field-info-collection';
+export * from './automatic-field';
+export * from './multiple-value-field';
+export * from './pdf-template-value-pair';

package/dist/ts/implementation/document/automatic-fields/multiple-value-field.d.ts

@@ -0,0 +1,18 @@
+/**
+ * PdfAutomaticField.ts class for EJ2-PDF
+ */
+import { PdfAutomaticField } from './automatic-field';
+import { PdfGraphics } from './../../graphics/pdf-graphics';
+import { PointF } from './../../drawing/pdf-drawing';
+/**
+ * Represents automatic field which has the same value within the `PdfGraphics`.
+ */
+export declare abstract class PdfMultipleValueField extends PdfAutomaticField {
+    /**
+     * Stores the instance of dictionary values of `graphics and template value pair`.
+     * @private
+     */
+    private list;
+    constructor();
+    performDraw(graphics: PdfGraphics, location: PointF, scalingX: number, scalingY: number): void;
+}

package/dist/ts/implementation/document/automatic-fields/multiple-value-field.ts

@@ -0,0 +1,37 @@
+/**
+ * PdfAutomaticField.ts class for EJ2-PDF
+ */
+import { PdfAutomaticField } from  './automatic-field';
+import { TemporaryDictionary } from './../../collections/object-object-pair/dictionary';
+import { PdfTemplateValuePair } from './pdf-template-value-pair';
+import { PdfGraphics } from './../../graphics/pdf-graphics';
+import { SizeF, PointF } from './../../drawing/pdf-drawing';
+import { PdfTemplate } from './../../graphics/figures/pdf-template';
+/**
+ * Represents automatic field which has the same value within the `PdfGraphics`.
+ */
+export abstract class PdfMultipleValueField extends PdfAutomaticField {
+    //  Fields
+    /**
+     * Stores the instance of dictionary values of `graphics and template value pair`.
+     * @private
+     */
+    private list : TemporaryDictionary<PdfGraphics, PdfTemplateValuePair> = new TemporaryDictionary<PdfGraphics, PdfTemplateValuePair>();
+    public constructor() {
+        super();
+    }
+    // Implementation
+    /* tslint:disable */
+    public performDraw(graphics : PdfGraphics, location : PointF, scalingX : number, scalingY : number) : void {
+        super.performDrawHelper(graphics, location, scalingX, scalingY);
+        let value : string = this.getValue(graphics);
+        let template : PdfTemplate = new PdfTemplate(this.getSize());
+        this.list.setValue(graphics, new PdfTemplateValuePair(template, value));
+        let g : PdfGraphics = template.graphics;
+        let size : SizeF = this.getSize();
+        template.graphics.drawString(value, this.getFont(), this.pen, this.getBrush(), 0, 0, size.width, size.height, this.stringFormat);
+        let drawLocation : PointF = new PointF(location.x + this.location.x, location.y + this.location.y);
+        graphics.drawPdfTemplate(template, drawLocation, new SizeF(template.width * scalingX, template.height * scalingY));
+    }
+    /* tslint:enable */
+}

package/dist/ts/implementation/document/automatic-fields/page-count-field.d.ts

@@ -0,0 +1,44 @@
+/**
+ * PdfPageCountField.ts class for EJ2-PDF
+ */
+import { PdfSingleValueField } from './single-value-field';
+import { PdfNumberStyle } from './../../pages/enum';
+import { PdfFont } from './../../graphics/fonts/pdf-font';
+import { PdfBrush } from './../../graphics/brushes/pdf-brush';
+import { RectangleF } from './../../drawing/pdf-drawing';
+import { PdfGraphics } from './../../graphics/pdf-graphics';
+/**
+ * Represents total PDF document page count automatic field.
+ */
+export declare class PdfPageCountField extends PdfSingleValueField {
+    /**
+     * Stores the number style of the field.
+     * @private
+     */
+    private internalNumberStyle;
+    /**
+     * Initialize a new instance for page number field.
+     * @public
+     */
+    constructor(font: PdfFont);
+    /**
+     * Initialize a new instance for page number field.
+     * @public
+     */
+    constructor(font: PdfFont, bounds: RectangleF);
+    /**
+     * Initialize a new instance for page number field.
+     * @public
+     */
+    constructor(font: PdfFont, brush: PdfBrush);
+    /**
+     * Gets and sets the number style of the field.
+     * @public
+     */
+    numberStyle: PdfNumberStyle;
+    /**
+     * Return the actual value of the content to drawn.
+     * @public
+     */
+    getValue(graphics: PdfGraphics): string;
+}

package/dist/ts/implementation/document/automatic-fields/page-count-field.ts

@@ -0,0 +1,75 @@
+/**
+ * PdfPageCountField.ts class for EJ2-PDF
+ */
+import { PdfSingleValueField } from './single-value-field';
+import { PdfNumberStyle } from './../../pages/enum';
+import { PdfFont } from './../../graphics/fonts/pdf-font';
+import { PdfBrush } from './../../graphics/brushes/pdf-brush';
+import { RectangleF } from './../../drawing/pdf-drawing';
+import { PdfGraphics } from './../../graphics/pdf-graphics';
+import { PdfPage } from './../../pages/pdf-page';
+import { PdfDocument } from './../pdf-document';
+import { PdfNumbersConvertor } from './pdf-numbers-convertor';
+/**
+ * Represents total PDF document page count automatic field.
+ */
+export class PdfPageCountField extends PdfSingleValueField {
+    // Fields
+    /**
+     * Stores the number style of the field.
+     * @private
+     */
+    private  internalNumberStyle : PdfNumberStyle = PdfNumberStyle.Numeric;
+    // Constructors
+    /**
+     * Initialize a new instance for page number field.
+     * @public
+     */
+    public constructor(font : PdfFont)
+    /**
+     * Initialize a new instance for page number field.
+     * @public
+     */
+    public constructor(font : PdfFont, bounds : RectangleF)
+    /**
+     * Initialize a new instance for page number field.
+     * @public
+     */
+    public constructor(font : PdfFont, brush: PdfBrush)
+    public constructor(font : PdfFont, arg2 ?: RectangleF|PdfBrush) {
+        super();
+        if (typeof arg2 === 'undefined') {
+            this.font = font;
+        } else if ( arg2 instanceof PdfBrush) {
+            this.font = font;
+            this.brush = arg2;
+        } else {
+            this.font = font;
+            this.bounds = arg2;
+        }
+    }
+    // Properties
+    /**
+     * Gets and sets the number style of the field.
+     * @public
+     */
+    public get numberStyle() : PdfNumberStyle {
+        return this.internalNumberStyle;
+    }
+    public set numberStyle(value : PdfNumberStyle) {
+        this.internalNumberStyle = value;
+    }
+    // Implementation
+    /**
+     * Return the actual value of the content to drawn.
+     * @public
+     */
+    public getValue(graphics : PdfGraphics) : string {
+        let result : string = null;
+        let page : PdfPage = this.getPageFromGraphics(graphics);
+        let document : PdfDocument = page.section.parent.document;
+        let count : number = document.pages.count;
+        result = PdfNumbersConvertor.convert(count, this.numberStyle);
+        return result;
+    }
+}

package/dist/ts/implementation/document/automatic-fields/pdf-numbers-convertor.d.ts

@@ -0,0 +1,53 @@
+/**
+ * PdfNumbersConvertor.ts class for EJ2-PDF
+ * @private
+ */
+import { PdfNumberStyle } from './../../pages/enum';
+/**
+ * `PdfNumbersConvertor` for convert page number into numbers, roman letters, etc.,
+ * @private
+ */
+export declare class PdfNumbersConvertor {
+    /**
+     * numbers of letters in english [readonly].
+     * @default = 26.0
+     * @private
+     */
+    private static readonly letterLimit;
+    /**
+     * Resturns `acsii start index` value.
+     * @default 64
+     * @private
+     */
+    private static readonly acsiiStartIndex;
+    /**
+     * Convert string value from page number with correct format.
+     * @private
+     */
+    static convert(intArabic: number, numberStyle: PdfNumberStyle): string;
+    /**
+     * Converts `arabic to roman` letters.
+     * @private
+     */
+    private static arabicToRoman;
+    /**
+     * Converts `arabic to normal letters`.
+     * @private
+     */
+    private static arabicToLetter;
+    /**
+     * Generate a string value of an input number.
+     * @private
+     */
+    private static generateNumber;
+    /**
+     * Convert a input number into letters.
+     * @private
+     */
+    private static convertToLetter;
+    /**
+     * Convert number to actual string value.
+     * @private
+     */
+    private static appendChar;
+}