@syncfusion/ej2-pdf-export 19.4.52 → 20.2.36

package/dist/ts/implementation/structured-elements/grid/styles/pdf-borders.ts

@@ -0,0 +1,240 @@
+/**
+ * PdfBorders.ts class for EJ2-PDF
+ */
+import { PdfPen } from './../../../graphics/pdf-pen';
+import { PdfDashStyle } from './../../../graphics/enum';
+import { PdfColor } from './../../../graphics/pdf-color';
+/**
+ * `PdfBorders` class used represents the cell border of the PDF grid.
+ */
+export class PdfBorders {
+    // Fields
+    /**
+     * The `left` border.
+     * @private
+     */
+    private leftPen : PdfPen;
+    /**
+     * The `right` border.
+     * @private
+     */
+    private rightPen : PdfPen;
+    /**
+     * The `top` border.
+     * @private
+     */
+    private topPen : PdfPen;
+    /**
+     * The `bottom` border.
+     * @private
+     */
+    private bottomPen : PdfPen;
+    // Properties
+    /**
+     * Gets or sets the `Left`.
+     * @private
+     */
+    public get left() : PdfPen {
+        return this.leftPen;
+    }
+    public set left(value : PdfPen) {
+        this.leftPen = value;
+    }
+    /**
+     * Gets or sets the `Right`.
+     * @private
+     */
+    public get right() : PdfPen {
+        return this.rightPen;
+    }
+    public set right(value : PdfPen) {
+        this.rightPen = value;
+    }
+    /**
+     * Gets or sets the `Top`.
+     * @private
+     */
+    public get top() : PdfPen {
+        return this.topPen;
+    }
+    public set top(value : PdfPen) {
+        this.topPen = value;
+    }
+    /**
+     * Gets or sets the `Bottom`.
+     * @private
+     */
+    public get bottom() : PdfPen {
+        return this.bottomPen;
+    }
+    public set bottom(value : PdfPen) {
+        this.bottomPen = value;
+    }
+    /**
+     * sets the `All`.
+     * @private
+     */
+    public set all(value : PdfPen) {
+        this.leftPen = this.rightPen = this.topPen = this.bottomPen = value;
+    }
+    /**
+     * Gets a value indicating whether this instance `is all`.
+     * @private
+     */
+    public get isAll() : boolean {
+        return ((this.leftPen === this.rightPen) && (this.leftPen === this.topPen) && (this.leftPen === this.bottomPen));
+    }
+    /**
+     * Gets the `default`.
+     * @private
+     */
+    public static get default() : PdfBorders {
+        return new PdfBorders();
+    }
+
+    // Constructor
+    /**
+     * Create a new instance for `PdfBorders` class.
+     * @private
+     */
+    public constructor() {
+        let defaultBorderPenLeft : PdfPen = new PdfPen(new PdfColor(0, 0, 0));
+        defaultBorderPenLeft.dashStyle = PdfDashStyle.Solid;
+        let defaultBorderPenRight : PdfPen = new PdfPen(new PdfColor(0, 0, 0));
+        defaultBorderPenRight.dashStyle = PdfDashStyle.Solid;
+        let defaultBorderPenTop : PdfPen = new PdfPen(new PdfColor(0, 0, 0));
+        defaultBorderPenTop.dashStyle = PdfDashStyle.Solid;
+        let defaultBorderPenBottom : PdfPen = new PdfPen(new PdfColor(0, 0, 0));
+        defaultBorderPenBottom.dashStyle = PdfDashStyle.Solid;
+        this.leftPen = defaultBorderPenLeft;
+        this.rightPen = defaultBorderPenRight;
+        this.topPen = defaultBorderPenTop;
+        this.bottomPen = defaultBorderPenBottom;
+    }
+}
+export class PdfPaddings {
+    //Fields
+    /**
+     * The `left` padding.
+     * @private
+     */
+    private leftPad : number;
+    /**
+     * The `right` padding.
+     * @private
+     */
+    private rightPad : number;
+    /**
+     * The `top` padding.
+     * @private
+     */
+    private topPad : number;
+    /**
+     * The `bottom` padding.
+     * @private
+     */
+    private bottomPad : number;
+    /**
+     * The 'left' border padding set.
+     * @private
+     */
+    public hasLeftPad : boolean = false;
+    /**
+     * The 'right' border padding set.
+     * @private
+     */
+    public hasRightPad : boolean = false;
+    /**
+     * The 'top' border padding set.
+     * @private
+     */
+    public hasTopPad : boolean = false;
+    /**
+     * The 'bottom' border padding set.
+     * @private
+     */
+    public hasBottomPad : boolean = false;
+    // Properties
+    /**
+     * Gets or sets the `left` value of the edge
+     * @private
+     */
+    public get left() : number {
+        return this.leftPad;
+    }
+    public set left(value : number) {
+        this.leftPad = value;
+        this.hasLeftPad = true;
+    }
+    /**
+     * Gets or sets the `right` value of the edge.
+     * @private
+     */
+    public get right() : number {
+        return this.rightPad;
+    }
+    public set right(value : number) {
+        this.rightPad = value;
+        this.hasRightPad = true;
+    }
+    /**
+     * Gets or sets the `top` value of the edge
+     * @private
+     */
+    public get top() : number {
+        return this.topPad;
+    }
+    public set top(value : number) {
+        this.topPad = value;
+        this.hasTopPad = true;
+    }
+    /**
+     * Gets or sets the `bottom` value of the edge.
+     * @private
+     */
+    public get bottom() : number {
+        return this.bottomPad;
+    }
+    public set bottom(value : number) {
+        this.bottomPad = value;
+        this.hasBottomPad = true;
+    }
+    /**
+     * Sets value to all sides `left,right,top and bottom`.s
+     * @private
+     */
+    public set all(value : number) {
+        this.leftPad = this.rightPad = this.topPad = this.bottomPad = value;
+        this.hasLeftPad = true;
+        this.hasRightPad = true;
+        this.hasTopPad = true;
+        this.hasBottomPad = true;
+    }
+    /**
+     * Initializes a new instance of the `PdfPaddings` class.
+     * @private
+     */
+    public constructor()
+    /**
+     * Initializes a new instance of the `PdfPaddings` class.
+     * @private
+     */
+    public constructor(left : number, right : number, top : number, bottom : number)
+    public constructor(left ?: number, right ?: number, top ?: number, bottom ?: number) {
+        if (typeof left === 'undefined') {
+            //5.76 and 0 are taken from ms-word default table margins.
+            this.leftPad = this.rightPad = 5.76;
+            //0.5 is set for top and bottom by default.
+            this.bottomPad = this.topPad = 0.5;
+        } else {
+            this.leftPad = left;
+            this.rightPad = right;
+            this.topPad = top;
+            this.bottomPad = bottom;
+            this.hasLeftPad = true;
+            this.hasRightPad = true;
+            this.hasTopPad = true;
+            this.hasBottomPad = true;
+        }
+    }
+}

package/dist/ts/implementation/structured-elements/grid/styles/style.ts

@@ -0,0 +1,424 @@
+/**
+ * PdfGridStyleBase.ts class for EJ2-PDF
+ */
+import { PdfBrush } from './../../../graphics/brushes/pdf-brush';
+import { PdfPen } from './../../../graphics/pdf-pen';
+import { PdfFont } from './../../../graphics/fonts/pdf-font';
+import { PdfBorders, PdfPaddings } from './pdf-borders';
+import { PdfBorderOverlapStyle } from './../../tables/light-tables/enum';
+import { PdfStringFormat } from './../../../graphics/fonts/pdf-string-format';
+import { PdfGridRow } from './../pdf-grid-row';
+import { PdfImage } from  './../../../graphics/images/pdf-image';
+/**
+ * Base class for the `grid style`,
+ */
+export abstract class PdfGridStyleBase {
+    /**
+     * @hidden
+     * @private
+     */
+    private gridBackgroundBrush : PdfBrush;
+    /**
+     * @hidden
+     * @private
+     */
+    private gridTextBrush : PdfBrush;
+    /**
+     * @hidden
+     * @private
+     */
+    private gridTextPen : PdfPen;
+    /**
+     * @hidden
+     * @private
+     */
+    private gridFont : PdfFont;
+    /**
+     * @hidden
+     * @private
+     */
+    private gridBackgroundImage : PdfImage;
+    // Properties
+    /**
+     * Gets or sets the `background brush`.
+     * @private
+     */
+    public get backgroundBrush() : PdfBrush {
+        return this.gridBackgroundBrush;
+    }
+    public set backgroundBrush(value : PdfBrush) {
+        this.gridBackgroundBrush = value;
+    }
+    /**
+     * Gets or sets the `text brush`.
+     * @private
+     */
+    public get textBrush() : PdfBrush {
+        return this.gridTextBrush;
+    }
+    public set textBrush(value : PdfBrush) {
+        this.gridTextBrush = value;
+    }
+    /**
+     * Gets or sets the `text pen`.
+     * @private
+     */
+    public get textPen() : PdfPen {
+        return this.gridTextPen;
+    }
+    public set textPen(value : PdfPen) {
+        this.gridTextPen = value;
+    }
+    /**
+     * Gets or sets the `font`.
+     * @private
+     */
+    public get font() : PdfFont {
+        return this.gridFont;
+    }
+    public set font(value : PdfFont) {
+        this.gridFont = value;
+    }
+    /**
+     * Gets or sets the `background Image`.
+     * @private
+     */
+    public get backgroundImage() : PdfImage {
+        return this.gridBackgroundImage;
+    }
+    public set backgroundImage(value : PdfImage) {
+        this.gridBackgroundImage = value;
+    }
+}
+/**
+ * `PdfGridStyle` class provides customization of the appearance for the 'PdfGrid'.
+ */
+export class PdfGridStyle extends PdfGridStyleBase {
+    //Fields
+    /**
+     * @hidden
+     * @private
+     */
+    private gridBorderOverlapStyle : PdfBorderOverlapStyle;
+    /**
+     * @hidden
+     * @private
+     */
+    private gridHorizontalOverflowType : PdfHorizontalOverflowType;
+    /**
+     * @hidden
+     * @private
+     */
+    private bAllowHorizontalOverflow : boolean;
+    /**
+     * @hidden
+     * @private
+     */
+    private gridCellPadding : PdfPaddings;
+    /**
+     * @hidden
+     * @private
+     */
+    private gridCellSpacing : number;
+
+    //constructor
+    /**
+     * Initialize a new instance for `PdfGridStyle` class.
+     * @private
+     */
+    public constructor() {
+        super();
+        this.gridBorderOverlapStyle = PdfBorderOverlapStyle.Overlap;
+        this.bAllowHorizontalOverflow = false;
+        this.gridHorizontalOverflowType = PdfHorizontalOverflowType.LastPage;
+    }
+
+    //Properties
+    /**
+     * Gets or sets the `cell spacing` of the 'PdfGrid'.
+     * @private
+     */
+    public get cellSpacing() : number {
+        if (typeof this.gridCellSpacing === 'undefined') {
+            this.gridCellSpacing = 0;
+        }
+        return this.gridCellSpacing;
+    }
+    public set cellSpacing(value : number) {
+        this.gridCellSpacing = value;
+    }
+    /**
+     * Gets or sets the type of the `horizontal overflow` of the 'PdfGrid'.
+     * @private
+     */
+    public get horizontalOverflowType() : PdfHorizontalOverflowType {
+        return this.gridHorizontalOverflowType;
+    }
+    public set horizontalOverflowType(value : PdfHorizontalOverflowType) {
+        this.gridHorizontalOverflowType = value;
+    }
+    /**
+     * Gets or sets a value indicating whether to `allow horizontal overflow`.
+     * @private
+     */
+    public get allowHorizontalOverflow() : boolean {
+        return this.bAllowHorizontalOverflow;
+    }
+    public set allowHorizontalOverflow(value : boolean) {
+        this.bAllowHorizontalOverflow = value;
+    }
+    /**
+     * Gets or sets the `cell padding`.
+     * @private
+     */
+    public get cellPadding() : PdfPaddings {
+        if (typeof this.gridCellPadding === 'undefined') {
+            this.gridCellPadding = new PdfPaddings();
+        }
+        return this.gridCellPadding;
+    }
+    public set cellPadding(value : PdfPaddings) {
+        if (typeof this.gridCellPadding === 'undefined') {
+            this.gridCellPadding = new PdfPaddings();
+            this.gridCellPadding = value;
+        } else {
+            this.gridCellPadding = value;
+        }
+    }
+    /**
+     * Gets or sets the `border overlap style` of the 'PdfGrid'.
+     * @private
+     */
+    public get borderOverlapStyle() : PdfBorderOverlapStyle {
+        return this.gridBorderOverlapStyle;
+    }
+    public set borderOverlapStyle(value : PdfBorderOverlapStyle) {
+        this.gridBorderOverlapStyle = value;
+    }
+}
+/**
+ * `PdfGridCellStyle` class provides customization of the appearance for the 'PdfGridCell'.
+ */
+export class PdfGridCellStyle extends PdfGridStyleBase {
+    /**
+     * @hidden
+     * @private
+     */
+    private gridCellBorders : PdfBorders = PdfBorders.default;
+    /**
+     * @hidden
+     * @private
+     */
+    private gridCellPadding : PdfPaddings;
+    /**
+     * @hidden
+     * @private
+     */
+    private format : PdfStringFormat;
+    //Properties
+    /**
+     * Gets the `string format` of the 'PdfGridCell'.
+     * @private
+     */
+    public get stringFormat() : PdfStringFormat {
+        return this.format;
+    }
+    public set stringFormat(value : PdfStringFormat) {
+        this.format = value;
+    }
+    /**
+     * Gets or sets the `border` of the 'PdfGridCell'.
+     * @private
+     */
+    public get borders() : PdfBorders {
+        return this.gridCellBorders;
+    }
+    public set borders(value : PdfBorders) {
+        this.gridCellBorders = value;
+    }
+    /**
+     * Gets or sets the `cell padding`.
+     * @private
+     */
+    public get cellPadding() : PdfPaddings {
+        return this.gridCellPadding;
+    }
+    public set cellPadding(value : PdfPaddings) {
+        if (this.gridCellPadding == null || typeof this.gridCellPadding === 'undefined') {
+            this.gridCellPadding = new PdfPaddings();
+        }
+        this.gridCellPadding = value;
+    }
+    /**
+     * Initializes a new instance of the `PdfGridCellStyle` class.
+     * @private
+     */
+    public constructor() {
+        super();
+    }
+}
+/**
+ * `PdfGridRowStyle` class provides customization of the appearance for the `PdfGridRow`.
+ */
+export class PdfGridRowStyle {
+    //Fields
+    /**
+     * @hidden
+     * @private
+     */
+    private gridRowBackgroundBrush : PdfBrush;
+    /**
+     * @hidden
+     * @private
+     */
+    private gridRowTextBrush : PdfBrush;
+    /**
+     * @hidden
+     * @private
+     */
+    private gridRowTextPen : PdfPen;
+    /**
+     * @hidden
+     * @private
+     */
+    private gridRowFont : PdfFont;
+    /**
+     * Specifies the `border` value of the current row.
+     * @private
+     */
+    private gridRowBorder : PdfBorders;
+    /**
+     * Specifies the `parent row` of the current object.
+     * @private
+     */
+    private parent : PdfGridRow;
+    /**
+     * @hidden
+     * @private
+     */
+    private gridRowBackgroundImage : PdfImage;
+    // Properties
+    /**
+     * Gets or sets the `background brush`.
+     * @private
+     */
+    public get backgroundBrush() : PdfBrush {
+        return this.gridRowBackgroundBrush;
+    }
+    public setBackgroundBrush(value : PdfBrush) : void {
+        this.gridRowBackgroundBrush = value;
+        if (typeof this.parent !== 'undefined') {
+            for (let i : number = 0; i < this.parent.cells.count; i++) {
+                this.parent.cells.getCell(i).style.backgroundBrush = value;
+            }
+        }
+    }
+    /**
+     * Gets or sets the `text brush`.
+     * @private
+     */
+    public get textBrush() : PdfBrush {
+        return this.gridRowTextBrush;
+    }
+    public setTextBrush(value : PdfBrush) : void {
+        this.gridRowTextBrush = value;
+        if (typeof this.parent !== 'undefined') {
+            for (let i : number = 0; i < this.parent.cells.count; i++) {
+                this.parent.cells.getCell(i).style.textBrush = value;
+            }
+        }
+    }
+    /**
+     * Gets or sets the `text pen`.
+     * @private
+     */
+    public get textPen() : PdfPen {
+        return this.gridRowTextPen;
+    }
+    public setTextPen(value : PdfPen) : void {
+        this.gridRowTextPen = value;
+        if (typeof this.parent !== 'undefined') {
+            for (let i : number = 0; i < this.parent.cells.count; i++) {
+                this.parent.cells.getCell(i).style.textPen = value;
+            }
+        }
+    }
+    /**
+     * Gets or sets the `font`.
+     * @private
+     */
+    public get font() : PdfFont {
+        return this.gridRowFont;
+    }
+    public setFont(value : PdfFont) : void {
+        this.gridRowFont = value;
+        if (typeof this.parent !== 'undefined') {
+            for (let i : number = 0; i < this.parent.cells.count; i++) {
+                this.parent.cells.getCell(i).style.font = value;
+            }
+        }
+    }
+    /**
+     * Gets or sets the `border` of the current row.
+     * @private
+     */
+    public get border() : PdfBorders {
+        if (typeof this.gridRowBorder === 'undefined') {
+            this.setBorder(new PdfBorders());
+        }
+        return this.gridRowBorder;
+    }
+    public setBorder(value : PdfBorders) : void {
+        this.gridRowBorder = value;
+        if (typeof this.parent !== 'undefined') {
+            for (let i : number = 0; i < this.parent.cells.count; i++) {
+                this.parent.cells.getCell(i).style.borders = value;
+            }
+        }
+    }
+    /**
+     * sets the `parent row` of the current object.
+     * @private
+     */
+    public setParent(parent : PdfGridRow) : void {
+        this.parent = parent;
+    }
+    /**
+     * Gets or sets the `backgroundImage` of the 'PdfGridCell'.
+     * @private
+     */
+    public get backgroundImage() : PdfImage {
+        return this.gridRowBackgroundImage;
+    }
+    /**
+     * sets the `backgroundImage` of the 'PdfGridCell'.
+     * @private
+     */
+    public setBackgroundImage(value: PdfImage): void {
+        this.gridRowBackgroundImage = value;
+    }
+    // Constructor
+    /**
+     * Initializes a new instance of the `PdfGridRowStyle` class.
+     * @private
+     */
+    public constructor() {
+        //
+    }
+}
+/**
+ * public Enum for `PdfHorizontalOverflowType`.
+ * @private
+ */
+export enum PdfHorizontalOverflowType {
+    /**
+     * Specifies the type of `NextPage`.
+     * @private
+     */
+    NextPage,
+    /**
+     * Specifies the type of `LastPage`.
+     * @private
+     */
+    LastPage
+}

package/dist/ts/implementation/structured-elements/tables/light-tables/enum.ts

@@ -0,0 +1,16 @@
+/**
+ * public Enum for `PdfBorderOverlapStyle`.
+ * @private
+ */
+export enum PdfBorderOverlapStyle {
+    /**
+     * Specifies the type of `Overlap`.
+     * @private
+     */
+    Overlap,
+    /**
+     * Specifies the type of `Inside`.
+     * @private
+     */
+    Inside,
+}

package/dist/ts/interfaces/i-pdf-cache.ts

@@ -0,0 +1,23 @@
+/**
+ * `IPdfCache.ts` interface for EJ2-PDF
+ * Interface of the objects that support caching of their internals.
+ * @private
+ */
+import { IPdfPrimitive } from './i-pdf-primitives';
+export interface IPdfCache {
+    /**
+     * Checks whether the object `is similar to another object`.
+     * @private
+     */
+    equalsTo(obj : IPdfCache) : boolean;
+    /**
+     * Returns `internals of the object`.
+     * @private
+     */
+    getInternals() : IPdfPrimitive;
+    /**
+     * Sets `internals of the object`.
+     * @private
+     */
+    setInternals(internals : IPdfPrimitive) : void;
+}

package/dist/ts/interfaces/i-pdf-changable.ts

@@ -0,0 +1,17 @@
+/**
+ * `IPdfChangable.ts` interface for EJ2-PDF
+ * Interface of the objects that support Changable of their internals.
+ * @private
+ */
+export interface IPdfChangable {
+    /**
+     * Gets a value indicating whether this 'IPdfChangable' `is changed`.
+     * @private
+     */
+    changed() : boolean;
+    /**
+     * `Freezes the changes`.
+     * @private
+     */
+    freezeChanges(freezer : Object) : void;
+}