@syncfusion/ej2-pdf 25.2.3 → 25.2.6

package/src/pdf/core/form/field.js

@@ -41,6 +41,7 @@ var PdfField = /** @class */ (function () {
     function PdfField() {
         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);
@@ -660,29 +661,12 @@ var PdfField = /** @class */ (function () {
          * ```
          */
         get: function () {
-            var value;
-            var widget = this.itemAt(this._defaultIndex);
-            if (widget && widget.borderColor) {
-                value = widget.borderColor;
-            }
-            else if (this._mkDictionary) {
-                var dictionary = this._mkDictionary;
-                if (dictionary && dictionary.has('BC')) {
-                    var 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);
@@ -697,26 +681,7 @@ var PdfField = /** @class */ (function () {
          * ```
          */
         set: function (value) {
-            var widget = this.itemAt(this._defaultIndex);
-            if (widget && widget.borderColor !== value) {
-                widget.borderColor = value;
-            }
-            else {
-                var mkDict = this._mkDictionary;
-                if (typeof mkDict === 'undefined') {
-                    var 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);
         },
         enumerable: true,
         configurable: true
@@ -1312,6 +1277,25 @@ var PdfField = /** @class */ (function () {
         enumerable: true,
         configurable: true
     });
+    Object.defineProperty(PdfField.prototype, "_hasBorderColor", {
+        get: function () {
+            if (this._isLoaded) {
+                var mkDictionary = this._mkDictionary;
+                if (!mkDictionary) {
+                    var 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;
+            }
+        },
+        enumerable: true,
+        configurable: true
+    });
     PdfField.prototype._parseBackColor = function (hasTransparency) {
         var value;
         if ((!hasTransparency) || ((this._isLoaded && this._hasBackColor) || (!this._isLoaded && !this._isTransparentBackColor))) {
@@ -1334,6 +1318,28 @@ var PdfField = /** @class */ (function () {
         }
         return value;
     };
+    PdfField.prototype._parseBorderColor = function (hasTransparency) {
+        var value;
+        if ((!hasTransparency) || ((this._isLoaded && this._hasBorderColor) || (!this._isLoaded && !this._isTransparentBorderColor))) {
+            var widget = this.itemAt(this._defaultIndex);
+            if (widget && widget.borderColor) {
+                value = widget.borderColor;
+            }
+            else if (this._mkDictionary) {
+                var mkDict = this._mkDictionary;
+                if (mkDict && mkDict.has('BC')) {
+                    var bgArray = mkDict.getArray('BC');
+                    if (bgArray) {
+                        value = _parseColor(bgArray);
+                    }
+                }
+            }
+            if (typeof value === 'undefined' || value === null) {
+                value = [0, 0, 0];
+            }
+        }
+        return value;
+    };
     PdfField.prototype._updateBackColor = function (value, hasTransparency) {
         if (hasTransparency === void 0) { hasTransparency = false; }
         if (hasTransparency && value.length === 4 && value[3] !== 255) {
@@ -1375,6 +1381,53 @@ var PdfField = /** @class */ (function () {
             }
         }
     };
+    PdfField.prototype._updateBorderColor = function (value, hasTransparency) {
+        if (hasTransparency === void 0) { hasTransparency = false; }
+        if (hasTransparency && value.length === 4 && value[3] !== 255) {
+            this._isTransparentBorderColor = true;
+            if (this._dictionary.has('BC')) {
+                delete this._dictionary._map.BC;
+            }
+            var mkDictionary = this._mkDictionary;
+            if (mkDictionary && mkDictionary.has('BC')) {
+                delete mkDictionary._map.BC;
+                if (this._dictionary.has('BS')) {
+                    var bsDictionary = this._dictionary.get('BS');
+                    if (bsDictionary && bsDictionary.has('W')) {
+                        delete bsDictionary._map.W;
+                    }
+                }
+                this._dictionary._updated = true;
+            }
+            var item = this.itemAt(this._defaultIndex);
+            if (item) {
+                item.borderColor = value;
+            }
+        }
+        else {
+            this._isTransparentBorderColor = false;
+            var widget = this.itemAt(this._defaultIndex);
+            if (widget && widget.borderColor !== value) {
+                widget.borderColor = value;
+            }
+            else {
+                var mkDictionary = this._mkDictionary;
+                if (typeof mkDictionary === 'undefined') {
+                    var 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.
      *
@@ -1846,19 +1899,19 @@ var PdfField = /** @class */ (function () {
         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;
@@ -3019,7 +3072,9 @@ var PdfTextBoxField = /** @class */ (function (_super) {
         }
         parameter.foreBrush = new PdfBrush(widget.color);
         var 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) {
@@ -3068,7 +3123,7 @@ var PdfTextBoxField = /** @class */ (function (_super) {
         if (typeof maxLength !== 'undefined') {
             if (parameter.insertSpaces) {
                 var 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);
                     var current = text;
@@ -3750,7 +3805,9 @@ var PdfButtonField = /** @class */ (function (_super) {
         }
         parameter.foreBrush = new PdfBrush(widget.color);
         var 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) {
@@ -4221,6 +4278,53 @@ var PdfCheckBoxField = /** @class */ (function (_super) {
         enumerable: true,
         configurable: true
     });
+    Object.defineProperty(PdfCheckBoxField.prototype, "borderColor", {
+        /**
+         * 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: function () {
+            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: function (value) {
+            this._updateBorderColor(value, true);
+            if (this._isLoaded) {
+                this._setAppearance = true;
+            }
+        },
+        enumerable: true,
+        configurable: true
+    });
     PdfCheckBoxField.prototype._initialize = function (page, name, bounds) {
         this._crossReference = page._crossReference;
         this._page = page;
@@ -4313,7 +4417,9 @@ var PdfCheckBoxField = /** @class */ (function (_super) {
         }
         parameter.foreBrush = new PdfBrush(widget.color);
         var 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) {
@@ -4550,6 +4656,50 @@ var PdfRadioButtonListField = /** @class */ (function (_super) {
         enumerable: true,
         configurable: true
     });
+    Object.defineProperty(PdfRadioButtonListField.prototype, "borderColor", {
+        /**
+         * 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: function () {
+            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: function (value) {
+            this._updateBorderColor(value, true);
+        },
+        enumerable: true,
+        configurable: true
+    });
     /**
      * Gets the item at the specified index.
      *
@@ -4805,7 +4955,9 @@ var PdfRadioButtonListField = /** @class */ (function (_super) {
         }
         parameter.foreBrush = new PdfBrush(widget.color);
         var 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) {
@@ -6222,7 +6374,9 @@ var PdfComboBoxField = /** @class */ (function (_super) {
             }
             parameter.foreBrush = new PdfBrush(item.color);
             var 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) {
@@ -6256,7 +6410,9 @@ var PdfComboBoxField = /** @class */ (function (_super) {
             }
             parameter.foreBrush = new PdfBrush(this.color);
             var 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) {
@@ -6609,7 +6765,9 @@ var PdfListBoxField = /** @class */ (function (_super) {
             }
             parameter.foreBrush = new PdfBrush(item.color);
             var 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) {
@@ -6641,7 +6799,9 @@ var PdfListBoxField = /** @class */ (function (_super) {
             }
             parameter.foreBrush = new PdfBrush(this.color);
             var 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) {
@@ -6952,7 +7112,7 @@ var PdfSignatureField = /** @class */ (function (_super) {
     PdfSignatureField.prototype._doPostProcess = function (isFlatten) {
         if (isFlatten === void 0) { isFlatten = false; }
         var needAppearance = this._setAppearance || this._form._setAppearance;
-        if (!this._isLoaded && (isFlatten || needAppearance)) {
+        if (isFlatten || needAppearance) {
             var count = this._kidsCount;
             if (count > 0) {
                 for (var i = 0; i < count; i++) {
@@ -7000,7 +7160,9 @@ var PdfSignatureField = /** @class */ (function (_super) {
         }
         parameter.foreBrush = new PdfBrush(widget.color);
         var 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) {