@syncfusion/ej2-pdf-export 25.2.3 → 26.2.4

package/dist/ts/implementation/graphics/figures/base/text-layouter.ts

@@ -0,0 +1,205 @@
+/**
+ * TextLayouter.ts class for EJ2-PDF
+ */
+import { ElementLayouter, PdfLayoutParams, PdfLayoutResult } from './element-layouter';
+import { PdfStringFormat } from './../../fonts/pdf-string-format';
+import { PdfTextElement } from './../text-element';
+import { PdfPage } from './../../../pages/pdf-page';
+import { RectangleF, SizeF } from './../../../drawing/pdf-drawing';
+import { LineInfo, PdfStringLayoutResult, PdfStringLayouter } from './../../fonts/string-layouter';
+import { PdfLayoutBreakType } from './../../figures/enum';
+import { PdfGraphics } from './../../pdf-graphics';
+import { PdfColor } from './../../pdf-color';
+import { PdfSolidBrush } from './../../brushes/pdf-solid-brush';
+import { PdfTextWebLink } from './../../../annotations/pdf-text-web-link';
+/**
+ * Class that `layouts the text`.
+ * @private
+ */
+export class TextLayouter extends ElementLayouter {
+    // Fields
+    /**
+     * String `format`.
+     * @private
+     */
+    private format : PdfStringFormat;
+    /**
+     * Gets the layout `element`.
+     * @private
+     */
+    public get element() : PdfTextElement {
+        return (super.getElement() as PdfTextElement);
+    }
+    // Constructors
+    /**
+     * Initializes a new instance of the `TextLayouter` class.
+     * @private
+     */
+    public constructor(element : PdfTextElement) {
+        super(element);
+    }
+    // Implementation
+    /**
+     * `Layouts` the element.
+     * @private
+     */
+    protected layoutInternal(param : PdfLayoutParams) : PdfLayoutResult {
+        /* tslint:disable */
+        this.format = (this.element.stringFormat !== null && typeof this.element.stringFormat !== 'undefined') ? this.element.stringFormat : null;
+        let currentPage : PdfPage = param.page;
+        let currentBounds : RectangleF = param.bounds;
+        let text : string = this.element.value;
+        let result : PdfTextLayoutResult = null;
+        let pageResult : TextPageLayoutResult = new TextPageLayoutResult();
+        pageResult.page = currentPage;
+        pageResult.remainder = text;
+        for ( ; ; ) {
+            pageResult = this.layoutOnPage(text, currentPage, currentBounds, param);
+            result = this.getLayoutResult(pageResult);
+            break;
+        }
+        /* tslint:enable */
+        return result;
+    }
+    /**
+     * Raises `PageLayout` event if needed.
+     * @private
+     */
+    private getLayoutResult(pageResult : TextPageLayoutResult) : PdfTextLayoutResult {
+        let result : PdfTextLayoutResult = new PdfTextLayoutResult(pageResult.page, pageResult.bounds, pageResult.remainder,
+                                                                   pageResult.lastLineBounds);
+        return result;
+    }
+    /* tslint:disable */
+    /**
+     * `Layouts` the text on the page.
+     * @private
+     */
+    private layoutOnPage(text : string, currentPage : PdfPage, currentBounds : RectangleF,
+                         param : PdfLayoutParams) : TextPageLayoutResult {
+        let result : TextPageLayoutResult = new TextPageLayoutResult();
+        result.remainder = text;
+        result.page = currentPage;
+        currentBounds = this.checkCorrectBounds(currentPage, currentBounds);
+        let layouter : PdfStringLayouter = new PdfStringLayouter();
+        let stringResult : PdfStringLayoutResult = layouter.layout(text, this.element.font, this.format, currentBounds, currentPage.getClientSize().height, false, new SizeF(0, 0));
+        let textFinished : boolean = (stringResult.remainder == null);
+        let doesntFit : boolean = (param.format.break === PdfLayoutBreakType.FitElement);
+        let canDraw : boolean = !(doesntFit || stringResult.empty);
+        // Draw the text.
+        let graphics : PdfGraphics = currentPage.graphics;
+        let brush : PdfSolidBrush = this.element.getBrush() as PdfSolidBrush;
+        if (this.element instanceof PdfTextWebLink) {
+            brush.color = new PdfColor(0, 0, 255);
+        }
+        graphics.drawStringLayoutResult(stringResult, this.element.font, this.element.pen, brush,
+                                        currentBounds, this.format);
+        let lineInfo : LineInfo = stringResult.lines[stringResult.lineCount - 1];
+        result.lastLineBounds = graphics.getLineBounds(stringResult.lineCount - 1, stringResult, this.element.font,
+                                                        currentBounds, this.format);
+        result.bounds = this.getTextPageBounds(currentPage, currentBounds, stringResult);
+        result.remainder = stringResult.remainder;
+        result.end = (textFinished);
+        return result;
+    }
+    /* tslint:enable */
+    /**
+     * `Corrects current bounds` on the page.
+     * @private
+     */
+    private checkCorrectBounds(currentPage : PdfPage, currentBounds : RectangleF) : RectangleF {
+        let pageSize : SizeF = currentPage.graphics.clientSize;
+        currentBounds.height = (currentBounds.height > 0) ? currentBounds.height : pageSize.height - currentBounds.y;
+        return currentBounds;
+    }
+    /**
+     * Returns a `rectangle` where the text was printed on the page.
+     * @private
+     */
+    /* tslint:disable */
+    private getTextPageBounds(currentPage : PdfPage, currentBounds : RectangleF,
+                              stringResult : PdfStringLayoutResult) : RectangleF {
+        let textSize : SizeF = stringResult.actualSize;
+        let x : number = currentBounds.x;
+        let y : number = currentBounds.y;
+        let width : number = (currentBounds.width > 0) ? currentBounds.width : textSize.width;
+        let height : number = textSize.height;
+        let shiftedRect : RectangleF = currentPage.graphics.checkCorrectLayoutRectangle(textSize,
+                                                                                             currentBounds.x,
+                                                                                             currentBounds.y,
+                                                                                             this.format);
+        // if (currentBounds.width <= 0) {
+        x = shiftedRect.x;
+        // }
+        let verticalShift : number = currentPage.graphics.getTextVerticalAlignShift(textSize.height, currentBounds.height, this.format);
+        y += verticalShift;
+        let bounds : RectangleF = new RectangleF(x, y, width, height);
+        return bounds;
+    }
+    /* tslint:enable */
+}
+export class TextPageLayoutResult {
+    /**
+     * The last `page` where the text was drawn.
+     * @private
+     */
+    public page : PdfPage;
+    /**
+     * The `bounds` of the element on the last page where it was drawn.
+     * @private
+     */
+    public bounds : RectangleF;
+    /**
+     * Indicates whether the lay outing has been finished [`end`].
+     * @private
+     */
+    public end : boolean;
+    /**
+     * The `text` that was not printed.
+     * @private
+     */
+    public remainder : string;
+    /**
+     * Gets or sets a `bounds` of the last text line that was printed.
+     * @private
+     */
+    public lastLineBounds : RectangleF;
+}
+export class PdfTextLayoutResult extends PdfLayoutResult {
+    // Fields
+    /**
+     * The `text` that was not printed.
+     * @private
+     */
+    private remainderText : string;
+    /**
+     * The `bounds` of the last line that was printed.
+     * @private
+     */
+    private lastLineTextBounds : RectangleF;
+    // Properties
+    /**
+     * Gets a value that contains the `text` that was not printed.
+     * @private
+     */
+    public get remainder() : string {
+        return this.remainderText;
+    }
+    /**
+     * Gets a value that indicates the `bounds` of the last line that was printed on the page.
+     * @private
+     */
+    public get lastLineBounds() : RectangleF {
+        return this.lastLineTextBounds;
+    }
+    // Constructors
+    /**
+     * Initializes the new instance of `PdfTextLayoutResult` class.
+     * @private
+     */
+    public constructor(page : PdfPage, bounds : RectangleF, remainder : string, lastLineBounds : RectangleF) {
+        super(page, bounds);
+        this.remainderText = remainder;
+        this.lastLineTextBounds = lastLineBounds;
+    }
+}

package/dist/ts/implementation/graphics/figures/ellipse-part.d.ts

@@ -0,0 +1,48 @@
+/**
+ * ellipse-part.ts class for EJ2-PDF
+ */
+import { PdfBrush } from './../brushes/pdf-brush';
+import { PdfPen } from './../pdf-pen';
+import { RectangleF } from './../../drawing/pdf-drawing';
+import { PdfRectangleArea } from './rectangle-area';
+/**
+ * `PdfEllipsePart` class Implements graphics ellipse part, which is a sequence of primitive graphics elements.
+ * @private
+ */
+export declare abstract class PdfEllipsePart extends PdfRectangleArea {
+    /**
+     * public variable to store the start angle.
+     * @public
+     */
+    startAngle: number;
+    /**
+     * public variable to store the sweep angle.
+     * @public
+     */
+    sweepAngle: number;
+    /**
+     * Initializes a new instance of the `PdfEllipsePart` class.
+     * @protected
+     */
+    protected constructor();
+    /**
+     * Initializes a new instance of the `PdfEllipsePart` class.
+     * @protected
+     */
+    protected constructor(x: number, y: number, width: number, height: number, startAngle: number, sweepAngle: number);
+    /**
+     * Initializes a new instance of the `PdfEllipsePart` class.
+     * @protected
+     */
+    protected constructor(rectangle: RectangleF, startAngle: number, sweepAngle: number);
+    /**
+     * Initializes a new instance of the `PdfEllipsePart` class.
+     * @protected
+     */
+    protected constructor(pen: PdfPen, brush: PdfBrush, x: number, y: number, width: number, height: number, startAngle: number, sweepAngle: number);
+    /**
+     * Initializes a new instance of the `PdfEllipsePart` class.
+     * @protected
+     */
+    protected constructor(pen: PdfPen, brush: PdfBrush, rectangle: RectangleF, startAngle: number, sweepAngle: number);
+}

package/dist/ts/implementation/graphics/figures/ellipse-part.ts

@@ -0,0 +1,76 @@
+/**
+ * ellipse-part.ts class for EJ2-PDF
+ */
+import { PdfBrush } from './../brushes/pdf-brush';
+import { PdfPen } from './../pdf-pen';
+import { RectangleF } from './../../drawing/pdf-drawing';
+import { PdfRectangleArea } from './rectangle-area';
+/**
+ * `PdfEllipsePart` class Implements graphics ellipse part, which is a sequence of primitive graphics elements.
+ * @private
+ */
+export abstract class PdfEllipsePart extends PdfRectangleArea {
+    // Fields
+    /**
+     * public variable to store the start angle.
+     * @public
+     */
+    public startAngle: number = 0;
+    /**
+     * public variable to store the sweep angle.
+     * @public
+     */
+    public sweepAngle: number = 0;
+    // Constructor
+    /**
+     * Initializes a new instance of the `PdfEllipsePart` class.
+     * @protected
+     */
+    protected constructor ()
+    /**
+     * Initializes a new instance of the `PdfEllipsePart` class.
+     * @protected
+     */
+    protected constructor (x: number, y: number, width: number, height: number, startAngle: number, sweepAngle: number)
+    /**
+     * Initializes a new instance of the `PdfEllipsePart` class.
+     * @protected
+     */
+    protected constructor (rectangle: RectangleF, startAngle: number, sweepAngle: number)
+    /**
+     * Initializes a new instance of the `PdfEllipsePart` class.
+     * @protected
+     */
+    /* tslint:disable-next-line:max-line-length */
+    protected constructor (pen: PdfPen, brush: PdfBrush, x: number, y: number, width: number, height: number, startAngle: number, sweepAngle: number)
+    /**
+     * Initializes a new instance of the `PdfEllipsePart` class.
+     * @protected
+     */
+    protected constructor (pen: PdfPen, brush: PdfBrush, rectangle: RectangleF, startAngle: number, sweepAngle: number)
+    /* tslint:disable-next-line:max-line-length */
+    protected constructor (arg1?: PdfPen|RectangleF|number, arg2?: PdfBrush|number, arg3?: number|RectangleF, arg4?: number, arg5?: number, arg6?: number, arg7?: number, arg8?: number) {
+    super();
+    if ( typeof arg1 === 'undefined') {
+    //
+    } else if (arg1 instanceof RectangleF && typeof arg2 !== 'undefined' && typeof arg3 !== 'undefined') {
+        super(arg1);
+        this.startAngle = arg2 as number;
+        this.sweepAngle = arg3 as number;
+    } else if (arg1 instanceof PdfPen) {
+        if (arg3 instanceof RectangleF) {
+            super(arg1, arg2 as PdfBrush, arg3);
+            this.startAngle = arg4 as number;
+            this.sweepAngle = arg5 as number;
+        } else {
+            super(arg1, arg2 as PdfBrush, arg3, arg4, arg5, arg6);
+            this.startAngle = arg7 as number;
+            this.sweepAngle = arg8 as number;
+        }
+    } else {
+        super(arg1 as number, arg2 as number, arg3 as number, arg4 as number);
+        this.startAngle = arg5 as number;
+        this.sweepAngle = arg6 as number;
+    }
+}
+}

package/dist/ts/implementation/graphics/figures/enum.d.ts

@@ -0,0 +1,79 @@
+/**
+ * public Enum for `PdfLayoutType`.
+ * @private
+ */
+export declare enum PdfLayoutType {
+    /**
+     * Specifies the type of `Paginate`.
+     * @private
+     */
+    Paginate = 0,
+    /**
+     * Specifies the type of `OnePage`.
+     * @private
+     */
+    OnePage = 1
+}
+/**
+ * public Enum for `PdfLayoutBreakType`.
+ * @private
+ */
+export declare enum PdfLayoutBreakType {
+    /**
+     * Specifies the type of `FitPage`.
+     * @private
+     */
+    FitPage = 0,
+    /**
+     * Specifies the type of `FitElement`.
+     * @private
+     */
+    FitElement = 1,
+    /**
+     * Specifies the type of `FitColumnsToPage`.
+     * @private
+     */
+    FitColumnsToPage = 2
+}
+export declare enum PathPointType {
+    /**
+     * Specifies the path point type of `Start`.
+     * @private
+     */
+    Start = 0,
+    /**
+     * Specifies the path point type of `Line`.
+     * @private
+     */
+    Line = 1,
+    /**
+     * Specifies the path point type of `Bezier3`.
+     * @private
+     */
+    Bezier3 = 3,
+    /**
+     * Specifies the path point type of `Bezier`.
+     * @private
+     */
+    Bezier = 3,
+    /**
+     * Specifies the path point type of `PathTypeMask`.
+     * @private
+     */
+    PathTypeMask = 7,
+    /**
+     * Specifies the path point type of `DashMode`.
+     * @private
+     */
+    DashMode = 16,
+    /**
+     * Specifies the path point type of `PathMarker`.
+     * @private
+     */
+    PathMarker = 32,
+    /**
+     * Specifies the path point type of `CloseSubpath`.
+     * @private
+     */
+    CloseSubpath = 128
+}

package/dist/ts/implementation/graphics/figures/enum.ts

@@ -0,0 +1,80 @@
+/**
+ * public Enum for `PdfLayoutType`.
+ * @private
+ */
+export enum PdfLayoutType {
+    /**
+     * Specifies the type of `Paginate`.
+     * @private
+     */
+    Paginate,
+    /**
+     * Specifies the type of `OnePage`.
+     * @private
+     */
+    OnePage
+}
+/**
+ * public Enum for `PdfLayoutBreakType`.
+ * @private
+ */
+export enum PdfLayoutBreakType {
+    /**
+     * Specifies the type of `FitPage`.
+     * @private
+     */
+    FitPage,
+    /**
+     * Specifies the type of `FitElement`.
+     * @private
+     */
+    FitElement,
+    /**
+     * Specifies the type of `FitColumnsToPage`.
+     * @private
+     */
+    FitColumnsToPage
+}
+
+export enum PathPointType {
+    /**
+     * Specifies the path point type of `Start`.
+     * @private
+     */
+    Start = 0,
+    /**
+     * Specifies the path point type of `Line`.
+     * @private
+     */
+    Line = 1,
+    /**
+     * Specifies the path point type of `Bezier3`.
+     * @private
+     */
+    Bezier3 = 3,
+    /**
+     * Specifies the path point type of `Bezier`.
+     * @private
+     */
+    Bezier = 3,
+    /**
+     * Specifies the path point type of `PathTypeMask`.
+     * @private
+     */
+    PathTypeMask = 7,
+    /**
+     * Specifies the path point type of `DashMode`.
+     * @private
+     */
+    DashMode = 16,
+    /**
+     * Specifies the path point type of `PathMarker`.
+     * @private
+     */
+    PathMarker = 32,
+    /**
+     * Specifies the path point type of `CloseSubpath`.
+     * @private
+     */
+    CloseSubpath = 128,
+}

package/dist/ts/implementation/graphics/figures/index.d.ts

@@ -0,0 +1,13 @@
+/**
+ * Figures classes
+ * @hidden
+ */
+export * from './pdf-template';
+export * from './layout-element';
+export * from './text-element';
+export * from './path';
+export * from './base/element-layouter';
+export * from './base/text-layouter';
+export * from './arc';
+export * from './ellipse-part';
+export * from './rectangle-area';

package/dist/ts/implementation/graphics/figures/index.ts

@@ -0,0 +1,13 @@
+/**
+ * Figures classes
+ * @hidden
+ */
+export * from './pdf-template';
+export * from './layout-element';
+export * from './text-element';
+export * from './path';
+export * from './base/element-layouter';
+export * from './base/text-layouter';
+export * from './arc';
+export * from './ellipse-part';
+export * from './rectangle-area';

package/dist/ts/implementation/graphics/figures/layout-element.d.ts

@@ -0,0 +1,73 @@
+/**
+ * PdfLayoutElement.ts class for EJ2-PDF
+ */
+import { PdfPage } from './../../pages/pdf-page';
+import { RectangleF, PointF } from './../../drawing/pdf-drawing';
+import { PdfLayoutParams, PdfLayoutFormat, PdfLayoutResult } from './base/element-layouter';
+import { PdfGridBeginPageLayoutEventArgs, PdfGridEndPageLayoutEventArgs } from './../../structured-elements/grid/layout/grid-layouter';
+import { BeginPageLayoutEventArgs, EndPageLayoutEventArgs } from './../../structured-elements/grid/layout/grid-layouter';
+/**
+ * `PdfLayoutElement` class represents the base class for all elements that can be layout on the pages.
+ * @private
+ */
+export declare abstract class PdfLayoutElement {
+    /**
+     * Indicating whether [`embed fonts`]
+     * @private
+     */
+    private bEmbedFonts;
+    endPageLayout: Function;
+    beginPageLayout: Function;
+    /**
+     * Gets a value indicating whether the `start page layout event` should be raised.
+     * @private
+     */
+    readonly raiseBeginPageLayout: boolean;
+    /**
+     * Gets a value indicating whether the `ending page layout event` should be raised.
+     * @private
+     */
+    readonly raiseEndPageLayout: boolean;
+    onBeginPageLayout(args: PdfGridBeginPageLayoutEventArgs | BeginPageLayoutEventArgs): void;
+    onEndPageLayout(args: PdfGridEndPageLayoutEventArgs | EndPageLayoutEventArgs): void;
+    /**
+     * `Draws` the element on the page with the specified page and "PointF" class
+     * @private
+     */
+    drawHelper(page: PdfPage, location: PointF): PdfLayoutResult;
+    /**
+     * `Draws` the element on the page with the specified page and pair of coordinates
+     * @private
+     */
+    drawHelper(page: PdfPage, x: number, y: number): PdfLayoutResult;
+    /**
+     * `Draws` the element on the page with the specified page and "RectangleF" class
+     * @private
+     */
+    drawHelper(page: PdfPage, layoutRectangle: RectangleF): PdfLayoutResult;
+    /**
+     * `Draws` the element on the page with the specified page, "PointF" class and layout format
+     * @private
+     */
+    drawHelper(page: PdfPage, location: PointF, format: PdfLayoutFormat): PdfLayoutResult;
+    /**
+     * `Draws` the element on the page with the specified page, pair of coordinates and layout format
+     * @private
+     */
+    drawHelper(page: PdfPage, x: number, y: number, format: PdfLayoutFormat): PdfLayoutResult;
+    /**
+     * `Draws` the element on the page.
+     * @private
+     */
+    drawHelper(page: PdfPage, layoutRectangle: RectangleF, embedFonts: boolean): PdfLayoutResult;
+    /**
+     * `Draws` the element on the page with the specified page, "RectangleF" class and layout format
+     * @private
+     */
+    drawHelper(page: PdfPage, layoutRectangle: RectangleF, format: PdfLayoutFormat): PdfLayoutResult;
+    /**
+     * `Layouts` the specified param.
+     * @private
+     */
+    protected abstract layout(param: PdfLayoutParams): PdfLayoutResult;
+}