@syncfusion/ej2-pdf 25.2.3 → 25.2.6

package/dist/es6/ej2-pdf.es2015.js

@@ -14947,6 +14947,7 @@ class PdfField {
     constructor() {
         this._visible = true;
         this._isTransparentBackColor = false;
+        this._isTransparentBorderColor = false;
         this._defaultFont = new PdfStandardFont(PdfFontFamily.helvetica, 8);
         this._appearanceFont = new PdfStandardFont(PdfFontFamily.helvetica, 10, PdfFontStyle.regular);
         this._defaultItemFont = new PdfStandardFont(PdfFontFamily.timesRoman, 12);
@@ -15521,29 +15522,12 @@ class PdfField {
      * ```
      */
     get borderColor() {
-        let value;
-        const widget = this.itemAt(this._defaultIndex);
-        if (widget && widget.borderColor) {
-            value = widget.borderColor;
-        }
-        else if (this._mkDictionary) {
-            const dictionary = this._mkDictionary;
-            if (dictionary && dictionary.has('BC')) {
-                const colorArray = dictionary.getArray('BC');
-                if (colorArray) {
-                    value = _parseColor(colorArray);
-                }
-            }
-        }
-        if (typeof value === 'undefined' || value === null) {
-            value = [0, 0, 0];
-        }
-        return value;
+        return this._parseBorderColor(true);
     }
     /**
      * Sets the border color of the field.
      *
-     * @param {number[]} value R, G, B color values in between 0 to 255.
+     * @param {number[]} Value Array with R, G, B, A color values in between 0 to 255. For optional A (0-254), it signifies transparency.
      * ```typescript
      * // Load an existing PDF document
      * let document: PdfDocument = new PdfDocument(data, password);
@@ -15558,26 +15542,7 @@ class PdfField {
      * ```
      */
     set borderColor(value) {
-        const widget = this.itemAt(this._defaultIndex);
-        if (widget && widget.borderColor !== value) {
-            widget.borderColor = value;
-        }
-        else {
-            const mkDict = this._mkDictionary;
-            if (typeof mkDict === 'undefined') {
-                const dictionary = new _PdfDictionary(this._crossReference);
-                dictionary.update('BC', [Number.parseFloat((value[0] / 255).toFixed(3)),
-                    Number.parseFloat((value[1] / 255).toFixed(3)),
-                    Number.parseFloat((value[2] / 255).toFixed(3))]);
-                this._dictionary.update('MK', dictionary);
-            }
-            else if (!mkDict.has('BC') || _parseColor(mkDict.getArray('BC')) !== value) {
-                mkDict.update('BC', [Number.parseFloat((value[0] / 255).toFixed(3)),
-                    Number.parseFloat((value[1] / 255).toFixed(3)),
-                    Number.parseFloat((value[2] / 255).toFixed(3))]);
-                this._dictionary._updated = true;
-            }
-        }
+        this._updateBorderColor(value, true);
     }
     /**
      * Gets a value indicating whether read only.
@@ -16110,6 +16075,21 @@ class PdfField {
             return !this._isTransparentBackColor;
         }
     }
+    get _hasBorderColor() {
+        if (this._isLoaded) {
+            let mkDictionary = this._mkDictionary;
+            if (!mkDictionary) {
+                const item = this.itemAt(this._defaultIndex);
+                if (item && item._dictionary.has('MK')) {
+                    mkDictionary = item._dictionary.get('MK');
+                }
+            }
+            return (mkDictionary && mkDictionary.has('BC'));
+        }
+        else {
+            return !this._isTransparentBorderColor;
+        }
+    }
     _parseBackColor(hasTransparency) {
         let value;
         if ((!hasTransparency) || ((this._isLoaded && this._hasBackColor) || (!this._isLoaded && !this._isTransparentBackColor))) {
@@ -16132,6 +16112,28 @@ class PdfField {
         }
         return value;
     }
+    _parseBorderColor(hasTransparency) {
+        let value;
+        if ((!hasTransparency) || ((this._isLoaded && this._hasBorderColor) || (!this._isLoaded && !this._isTransparentBorderColor))) {
+            const widget = this.itemAt(this._defaultIndex);
+            if (widget && widget.borderColor) {
+                value = widget.borderColor;
+            }
+            else if (this._mkDictionary) {
+                const mkDict = this._mkDictionary;
+                if (mkDict && mkDict.has('BC')) {
+                    const bgArray = mkDict.getArray('BC');
+                    if (bgArray) {
+                        value = _parseColor(bgArray);
+                    }
+                }
+            }
+            if (typeof value === 'undefined' || value === null) {
+                value = [0, 0, 0];
+            }
+        }
+        return value;
+    }
     _updateBackColor(value, hasTransparency = false) {
         if (hasTransparency && value.length === 4 && value[3] !== 255) {
             this._isTransparentBackColor = true;
@@ -16172,6 +16174,52 @@ class PdfField {
             }
         }
     }
+    _updateBorderColor(value, hasTransparency = false) {
+        if (hasTransparency && value.length === 4 && value[3] !== 255) {
+            this._isTransparentBorderColor = true;
+            if (this._dictionary.has('BC')) {
+                delete this._dictionary._map.BC;
+            }
+            const mkDictionary = this._mkDictionary;
+            if (mkDictionary && mkDictionary.has('BC')) {
+                delete mkDictionary._map.BC;
+                if (this._dictionary.has('BS')) {
+                    const bsDictionary = this._dictionary.get('BS');
+                    if (bsDictionary && bsDictionary.has('W')) {
+                        delete bsDictionary._map.W;
+                    }
+                }
+                this._dictionary._updated = true;
+            }
+            const item = this.itemAt(this._defaultIndex);
+            if (item) {
+                item.borderColor = value;
+            }
+        }
+        else {
+            this._isTransparentBorderColor = false;
+            const widget = this.itemAt(this._defaultIndex);
+            if (widget && widget.borderColor !== value) {
+                widget.borderColor = value;
+            }
+            else {
+                const mkDictionary = this._mkDictionary;
+                if (typeof mkDictionary === 'undefined') {
+                    const dictionary = new _PdfDictionary(this._crossReference);
+                    dictionary.update('BC', [Number.parseFloat((value[0] / 255).toFixed(3)),
+                        Number.parseFloat((value[1] / 255).toFixed(3)),
+                        Number.parseFloat((value[2] / 255).toFixed(3))]);
+                    this._dictionary.update('MK', dictionary);
+                }
+                else if (!mkDictionary.has('BC') || _parseColor(mkDictionary.getArray('BC')) !== value) {
+                    mkDictionary.update('BC', [Number.parseFloat((value[0] / 255).toFixed(3)),
+                        Number.parseFloat((value[1] / 255).toFixed(3)),
+                        Number.parseFloat((value[2] / 255).toFixed(3))]);
+                    this._dictionary._updated = true;
+                }
+            }
+        }
+    }
     /**
      * Gets the field item as `PdfWidgetAnnotation` at the specified index.
      *
@@ -16631,19 +16679,19 @@ class PdfField {
         switch (state) {
             case _PdfCheckFieldState.unchecked:
             case _PdfCheckFieldState.checked:
-                if (parameter.borderPen) {
+                if (parameter.borderPen || parameter.backBrush) {
                     graphics.drawRectangle(parameter.bounds[0], parameter.bounds[1], parameter.bounds[2], parameter.bounds[3], parameter.backBrush);
                 }
                 break;
             case _PdfCheckFieldState.pressedChecked:
             case _PdfCheckFieldState.pressedUnchecked:
-                if ((parameter.borderStyle === PdfBorderStyle.beveled) ||
+                if ((parameter.borderStyle === PdfBorderStyle.beveled || parameter.backBrush) ||
                     (parameter.borderStyle === PdfBorderStyle.underline)) {
-                    if (parameter.borderPen) {
+                    if (parameter.borderPen || parameter.backBrush) {
                         graphics.drawRectangle(parameter.bounds[0], parameter.bounds[1], parameter.bounds[2], parameter.bounds[3], parameter.backBrush);
                     }
                 }
-                else if (parameter.borderPen) {
+                else if (parameter.borderPen || parameter.shadowBrush) {
                     graphics.drawRectangle(parameter.bounds[0], parameter.bounds[1], parameter.bounds[2], parameter.bounds[3], parameter.shadowBrush);
                 }
                 break;
@@ -17747,7 +17795,9 @@ class PdfTextBoxField extends PdfField {
         }
         parameter.foreBrush = new PdfBrush(widget.color);
         const border = widget.border;
-        parameter.borderPen = new PdfPen(widget.borderColor, border.width);
+        if (widget.borderColor) {
+            parameter.borderPen = new PdfPen(widget.borderColor, border.width);
+        }
         parameter.borderStyle = border.style;
         parameter.borderWidth = border.width;
         if (backcolor) {
@@ -17796,7 +17846,7 @@ class PdfTextBoxField extends PdfField {
         if (typeof maxLength !== 'undefined') {
             if (parameter.insertSpaces) {
                 let width = 0;
-                if (typeof maxLength !== 'undefined' && maxLength > 0) {
+                if (typeof maxLength !== 'undefined' && maxLength > 0 && this.borderColor) {
                     width = parameter.bounds[2] / maxLength;
                     g.drawRectangle(parameter.bounds[0], parameter.bounds[1], parameter.bounds[2], parameter.bounds[3], parameter.borderPen, parameter.backBrush);
                     const current = text;
@@ -18448,7 +18498,9 @@ class PdfButtonField extends PdfField {
         }
         parameter.foreBrush = new PdfBrush(widget.color);
         const border = widget.border;
-        parameter.borderPen = new PdfPen(widget.borderColor, border.width);
+        if (widget.borderColor) {
+            parameter.borderPen = new PdfPen(widget.borderColor, border.width);
+        }
         parameter.borderStyle = border.style;
         parameter.borderWidth = border.width;
         if (backcolor) {
@@ -18899,6 +18951,49 @@ class PdfCheckBoxField extends PdfField {
     set backColor(value) {
         this._updateBackColor(value, true);
     }
+    /**
+     * Gets the border color of the field.
+     *
+     * @returns {number[]} R, G, B color values in between 0 to 255.
+     * ```typescript
+     * // Load an existing PDF document
+     * let document: PdfDocument = new PdfDocument(data, password);
+     * // Access the form field at index 0
+     * let field: PdfField = document.form.fieldAt(0);
+     * // Gets the border color of the field.
+     * let borderColor: number[] = field.borderColor;
+     * // Save the document
+     * document.save('output.pdf');
+     * // Destroy the document
+     * document.destroy();
+     * ```
+     */
+    get borderColor() {
+        return this._parseBorderColor(true);
+    }
+    /**
+     * Sets the border color of the field.
+     *
+     * @param {number[]} value Array with R, G, B, A color values in between 0 to 255. For optional A (0-254), it signifies transparency.
+     * ```typescript
+     * // Load an existing PDF document
+     * let document: PdfDocument = new PdfDocument(data, password);
+     * // Access the form field at index 0
+     * let field: PdfField = document.form.fieldAt(0);
+     * // Sets the border color of the field.
+     * field.borderColor = [255, 0, 0];
+     * // Save the document
+     * document.save('output.pdf');
+     * // Destroy the document
+     * document.destroy();
+     * ```
+     */
+    set borderColor(value) {
+        this._updateBorderColor(value, true);
+        if (this._isLoaded) {
+            this._setAppearance = true;
+        }
+    }
     _initialize(page, name, bounds) {
         this._crossReference = page._crossReference;
         this._page = page;
@@ -18990,7 +19085,9 @@ class PdfCheckBoxField extends PdfField {
         }
         parameter.foreBrush = new PdfBrush(widget.color);
         const border = widget.border;
-        parameter.borderPen = new PdfPen(widget.borderColor, border.width);
+        if (widget.borderColor) {
+            parameter.borderPen = new PdfPen(widget.borderColor, border.width);
+        }
         parameter.borderStyle = border.style;
         parameter.borderWidth = border.width;
         if (backcolor) {
@@ -19215,6 +19312,46 @@ class PdfRadioButtonListField extends PdfField {
             }
         }
     }
+    /**
+     * Gets the border color of the field.
+     *
+     * @returns {number[]} R, G, B color values in between 0 to 255.
+     * ```typescript
+     * // Load an existing PDF document
+     * let document: PdfDocument = new PdfDocument(data, password);
+     * // Access the form field at index 0
+     * let field: PdfField = document.form.fieldAt(0);
+     * // Gets the border color of the field.
+     * let borderColor: number[] = field.borderColor;
+     * // Save the document
+     * document.save('output.pdf');
+     * // Destroy the document
+     * document.destroy();
+     * ```
+     */
+    get borderColor() {
+        return this._parseBorderColor(!this._isLoaded);
+    }
+    /**
+     * Sets the border color of the field.
+     *
+     * @param {number[]} value Array with R, G, B, A color values in between 0 to 255. For optional A (0-254), it signifies transparency.
+     * ```typescript
+     * // Load an existing PDF document
+     * let document: PdfDocument = new PdfDocument(data, password);
+     * // Access the form field at index 0
+     * let field: PdfField = document.form.fieldAt(0);
+     * // Sets the border color of the field.
+     * field.borderColor = [255, 0, 0];
+     * // Save the document
+     * document.save('output.pdf');
+     * // Destroy the document
+     * document.destroy();
+     * ```
+     */
+    set borderColor(value) {
+        this._updateBorderColor(value, true);
+    }
     /**
      * Gets the item at the specified index.
      *
@@ -19469,7 +19606,9 @@ class PdfRadioButtonListField extends PdfField {
         }
         parameter.foreBrush = new PdfBrush(widget.color);
         const border = widget.border;
-        parameter.borderPen = new PdfPen(widget.borderColor, border.width);
+        if (widget.borderColor) {
+            parameter.borderPen = new PdfPen(widget.borderColor, border.width);
+        }
         parameter.borderStyle = border.style;
         parameter.borderWidth = border.width;
         if (backcolor) {
@@ -20827,7 +20966,9 @@ class PdfComboBoxField extends PdfListField {
             }
             parameter.foreBrush = new PdfBrush(item.color);
             const border = item.border;
-            parameter.borderPen = new PdfPen(item.borderColor, border.width);
+            if (item.borderColor) {
+                parameter.borderPen = new PdfPen(item.borderColor, border.width);
+            }
             parameter.borderStyle = border.style;
             parameter.borderWidth = border.width;
             if (backcolor) {
@@ -20861,7 +21002,9 @@ class PdfComboBoxField extends PdfListField {
             }
             parameter.foreBrush = new PdfBrush(this.color);
             const border = this.border;
-            parameter.borderPen = new PdfPen(this.borderColor, border.width);
+            if (this.borderColor) {
+                parameter.borderPen = new PdfPen(this.borderColor, border.width);
+            }
             parameter.borderStyle = border.style;
             parameter.borderWidth = border.width;
             if (backcolor) {
@@ -21210,7 +21353,9 @@ class PdfListBoxField extends PdfListField {
             }
             parameter.foreBrush = new PdfBrush(item.color);
             const border = item.border;
-            parameter.borderPen = new PdfPen(item.borderColor, border.width);
+            if (item.borderColor) {
+                parameter.borderPen = new PdfPen(item.borderColor, border.width);
+            }
             parameter.borderStyle = border.style;
             parameter.borderWidth = border.width;
             if (backcolor) {
@@ -21242,7 +21387,9 @@ class PdfListBoxField extends PdfListField {
             }
             parameter.foreBrush = new PdfBrush(this.color);
             const border = this.border;
-            parameter.borderPen = new PdfPen(this.borderColor, border.width);
+            if (this.borderColor) {
+                parameter.borderPen = new PdfPen(this.borderColor, border.width);
+            }
             parameter.borderStyle = border.style;
             parameter.borderWidth = border.width;
             if (backcolor) {
@@ -21536,7 +21683,7 @@ class PdfSignatureField extends PdfField {
     }
     _doPostProcess(isFlatten = false) {
         const needAppearance = this._setAppearance || this._form._setAppearance;
-        if (!this._isLoaded && (isFlatten || needAppearance)) {
+        if (isFlatten || needAppearance) {
             const count = this._kidsCount;
             if (count > 0) {
                 for (let i = 0; i < count; i++) {
@@ -21584,7 +21731,9 @@ class PdfSignatureField extends PdfField {
         }
         parameter.foreBrush = new PdfBrush(widget.color);
         const border = widget.border;
-        parameter.borderPen = new PdfPen(widget.borderColor, border.width);
+        if (widget.borderColor) {
+            parameter.borderPen = new PdfPen(widget.borderColor, border.width);
+        }
         parameter.borderStyle = border.style;
         parameter.borderWidth = border.width;
         if (backcolor) {
@@ -33448,6 +33597,7 @@ class PdfWidgetAnnotation extends PdfAnnotation {
         this._visibility = PdfFormFieldVisibility.visible;
         this._isFont = false;
         this._isTransparentBackColor = false;
+        this._isTransparentBorderColor = false;
         this._isWidget = true;
         this._type = _PdfAnnotationType.widgetAnnotation;
     }
@@ -33594,6 +33744,15 @@ class PdfWidgetAnnotation extends PdfAnnotation {
             return !this._isTransparentBackColor;
         }
     }
+    get _hasBorderColor() {
+        if (this._isLoaded) {
+            const mkDictionary = this._mkDictionary;
+            return (mkDictionary && mkDictionary.has('BC'));
+        }
+        else {
+            return !this._isTransparentBorderColor;
+        }
+    }
     /**
      * Gets the border color of the annotation.
      *
@@ -33612,24 +33771,12 @@ class PdfWidgetAnnotation extends PdfAnnotation {
      * ```
      */
     get borderColor() {
-        if (typeof this._borderColor === 'undefined') {
-            const mkDict = this._mkDictionary;
-            if (mkDict && mkDict.has('BC')) {
-                const bcArray = mkDict.getArray('BC');
-                if (bcArray) {
-                    this._borderColor = _parseColor(bcArray);
-                }
-            }
-        }
-        if (typeof this._borderColor === 'undefined' || this._borderColor === null) {
-            this._borderColor = [0, 0, 0];
-        }
-        return this._borderColor;
+        return this._parseBorderColor();
     }
     /**
      * Sets the border color of the annotation.
      *
-     * @param {number[]} value Color as R, G, B color array in between 0 to 255.
+     * @param {number[]} value Array with R, G, B, A color values in between 0 to 255.. For optional A (0-254), it signifies transparency.
      * ```typescript
      * // Load an existing PDF document
      * let document: PdfDocument = new PdfDocument(data, password);
@@ -33646,15 +33793,7 @@ class PdfWidgetAnnotation extends PdfAnnotation {
      * ```
      */
     set borderColor(value) {
-        if (typeof this.borderColor === 'undefined' || this.borderColor !== value) {
-            if (typeof this._mkDictionary === 'undefined') {
-                this._dictionary.update('MK', new _PdfDictionary(this._crossReference));
-            }
-            this._mkDictionary.update('BC', [Number.parseFloat((value[0] / 255).toFixed(3)),
-                Number.parseFloat((value[1] / 255).toFixed(3)),
-                Number.parseFloat((value[2] / 255).toFixed(3))]);
-            this._borderColor = value;
-        }
+        this._updateBorderColor(value, true);
     }
     /**
      * Gets the rotation angle of the annotation.
@@ -34251,6 +34390,25 @@ class PdfWidgetAnnotation extends PdfAnnotation {
         }
         return value;
     }
+    _parseBorderColor() {
+        let value;
+        if ((this._isLoaded && this._hasBorderColor) || (!this._isLoaded && !this._isTransparentBorderColor)) {
+            if (typeof this._borderColor === 'undefined') {
+                const dictionary = this._mkDictionary;
+                if (dictionary && dictionary.has('BC')) {
+                    const colorArray = dictionary.getArray('BC');
+                    if (colorArray) {
+                        this._borderColor = _parseColor(colorArray);
+                    }
+                }
+            }
+            if (typeof this._borderColor === 'undefined' || this._borderColor === null) {
+                this._borderColor = [0, 0, 0];
+            }
+            value = this._borderColor;
+        }
+        return value;
+    }
     _updateBackColor(value, setAppearance = false) {
         let isChanged = false;
         if (value.length === 4 && value[3] !== 255) {
@@ -34284,6 +34442,38 @@ class PdfWidgetAnnotation extends PdfAnnotation {
             this._field._setAppearance = true;
         }
     }
+    _updateBorderColor(value, setAppearance = false) {
+        if (value.length === 4 && value[3] !== 255) {
+            this._isTransparentBorderColor = true;
+            if (this._dictionary.has('BC')) {
+                delete this._dictionary._map.BC;
+            }
+            const mkDictionary = this._mkDictionary;
+            if (mkDictionary && mkDictionary.has('BC')) {
+                delete mkDictionary._map.BC;
+                if (this._dictionary.has('BS')) {
+                    const bsDictionary = this._dictionary.get('BS');
+                    if (bsDictionary && bsDictionary.has('W')) {
+                        delete bsDictionary._map.W;
+                    }
+                }
+                this._dictionary._updated = true;
+            }
+        }
+        else {
+            this._isTransparentBorderColor = false;
+            if (typeof this.borderColor === 'undefined' || this.borderColor !== value) {
+                if (typeof this._mkDictionary === 'undefined') {
+                    this._dictionary.update('MK', new _PdfDictionary(this._crossReference));
+                }
+                this._mkDictionary.update('BC', [Number.parseFloat((value[0] / 255).toFixed(3)),
+                    Number.parseFloat((value[1] / 255).toFixed(3)),
+                    Number.parseFloat((value[2] / 255).toFixed(3))]);
+                this._borderColor = [value[0], value[1], value[2]];
+                this._dictionary._updated = true;
+            }
+        }
+    }
 }
 /**
  * `PdfStateItem` class represents the check box field item objects.