@pdfme/pdf-lib 1.18.4 → 5.4.0-dev.21

package/dist/esm/src/api/form/PDFCheckBox.js

@@ -0,0 +1,236 @@
+import PDFPage from '../PDFPage';
+import { normalizeAppearance, defaultCheckBoxAppearanceProvider, } from './appearances';
+import { rgb } from '../colors';
+import { degrees } from '../rotations';
+import PDFField, { assertFieldAppearanceOptions, } from './PDFField';
+import { PDFName, PDFDict, PDFAcroCheckBox, } from '../../core';
+import { assertIs, assertOrUndefined } from '../../utils';
+/**
+ * Represents a check box field of a [[PDFForm]].
+ *
+ * [[PDFCheckBox]] fields are interactive boxes that users can click with their
+ * mouse. This type of [[PDFField]] has two states: `on` and `off`. The purpose
+ * of a check box is to enable users to select from one or more options, where
+ * each option is represented by a single check box. Check boxes are typically
+ * square in shape and display a check mark when they are in the `on` state.
+ */
+class PDFCheckBox extends PDFField {
+    constructor(acroCheckBox, ref, doc) {
+        super(acroCheckBox, ref, doc);
+        /** The low-level PDFAcroCheckBox wrapped by this check box. */
+        Object.defineProperty(this, "acroField", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        assertIs(acroCheckBox, 'acroCheckBox', [
+            [PDFAcroCheckBox, 'PDFAcroCheckBox'],
+        ]);
+        this.acroField = acroCheckBox;
+    }
+    /**
+     * Mark this check box. This operation is analogous to a human user clicking
+     * a check box to fill it in a PDF reader. This method will update the
+     * underlying state of the check box field to indicate it has been selected.
+     * PDF libraries and readers will be able to extract this value from the
+     * saved document and determine that it was selected.
+     *
+     * For example:
+     * ```js
+     * const checkBox = form.getCheckBox('some.checkBox.field')
+     * checkBox.check()
+     * ```
+     *
+     * This method will mark this check box as dirty, causing its appearance
+     * streams to be updated when either [[PDFDocument.save]] or
+     * [[PDFForm.updateFieldAppearances]] is called. The updated appearance
+     * streams will display a check mark inside the widgets of this check box
+     * field.
+     */
+    check() {
+        const onValue = this.acroField.getOnValue() ?? PDFName.of('Yes');
+        this.markAsDirty();
+        this.acroField.setValue(onValue);
+    }
+    /**
+     * Clears this check box. This operation is analogous to a human user clicking
+     * a check box to unmark it in a PDF reader. This method will update the
+     * underlying state of the check box field to indicate it has been deselected.
+     * PDF libraries and readers will be able to extract this value from the
+     * saved document and determine that it was not selected.
+     *
+     * For example:
+     * ```js
+     * const checkBox = form.getCheckBox('some.checkBox.field')
+     * checkBox.uncheck()
+     * ```
+     *
+     * This method will mark this check box as dirty. See [[PDFCheckBox.check]]
+     * for more details about what this means.
+     */
+    uncheck() {
+        this.markAsDirty();
+        this.acroField.setValue(PDFName.of('Off'));
+    }
+    /**
+     * Returns `true` if this check box is selected (either by a human user via
+     * a PDF reader, or else programmatically via software). For example:
+     * ```js
+     * const checkBox = form.getCheckBox('some.checkBox.field')
+     * if (checkBox.isChecked()) console.log('check box is selected')
+     * ```
+     * @returns Whether or not this check box is selected.
+     */
+    isChecked() {
+        const onValue = this.acroField.getOnValue();
+        return !!onValue && onValue === this.acroField.getValue();
+    }
+    /**
+     * Show this check box on the specified page. For example:
+     * ```js
+     * const helvetica = await pdfDoc.embedFont(StandardFonts.Helvetica)
+     * const page = pdfDoc.addPage()
+     *
+     * const form = pdfDoc.getForm()
+     * const checkBox = form.createCheckBox('some.checkBox.field')
+     *
+     * checkBox.addToPage(page, {
+     *   x: 50,
+     *   y: 75,
+     *   width: 25,
+     *   height: 25,
+     *   textColor: rgb(1, 0, 0),
+     *   backgroundColor: rgb(0, 1, 0),
+     *   borderColor: rgb(0, 0, 1),
+     *   borderWidth: 2,
+     *   rotate: degrees(90),
+     * })
+     * ```
+     * This will create a new widget for this check box field.
+     * @param page The page to which this check box widget should be added.
+     * @param options The options to be used when adding this check box widget.
+     */
+    addToPage(page, options) {
+        assertIs(page, 'page', [[PDFPage, 'PDFPage']]);
+        assertFieldAppearanceOptions(options);
+        if (!options)
+            options = {};
+        if (!('textColor' in options))
+            options.textColor = rgb(0, 0, 0);
+        if (!('backgroundColor' in options))
+            options.backgroundColor = rgb(1, 1, 1);
+        if (!('borderColor' in options))
+            options.borderColor = rgb(0, 0, 0);
+        if (!('borderWidth' in options))
+            options.borderWidth = 1;
+        // Create a widget for this check box
+        const widget = this.createWidget({
+            x: options.x ?? 0,
+            y: options.y ?? 0,
+            width: options.width ?? 50,
+            height: options.height ?? 50,
+            textColor: options.textColor,
+            backgroundColor: options.backgroundColor,
+            borderColor: options.borderColor,
+            borderWidth: options.borderWidth ?? 0,
+            rotate: options.rotate ?? degrees(0),
+            hidden: options.hidden,
+            page: page.ref,
+        });
+        const widgetRef = this.doc.context.register(widget.dict);
+        // Add widget to this field
+        this.acroField.addWidget(widgetRef);
+        // Set appearance streams for widget
+        widget.setAppearanceState(PDFName.of('Off'));
+        this.updateWidgetAppearance(widget, PDFName.of('Yes'));
+        // Add widget to the given page
+        page.node.addAnnot(widgetRef);
+    }
+    /**
+     * Returns `true` if any of this check box's widgets do not have an
+     * appearance stream for its current state. For example:
+     * ```js
+     * const checkBox = form.getCheckBox('some.checkBox.field')
+     * if (checkBox.needsAppearancesUpdate()) console.log('Needs update')
+     * ```
+     * @returns Whether or not this check box needs an appearance update.
+     */
+    needsAppearancesUpdate() {
+        const widgets = this.acroField.getWidgets();
+        for (let idx = 0, len = widgets.length; idx < len; idx++) {
+            const widget = widgets[idx];
+            const state = widget.getAppearanceState();
+            const normal = widget.getAppearances()?.normal;
+            if (!(normal instanceof PDFDict))
+                return true;
+            if (state && !normal.has(state))
+                return true;
+        }
+        return false;
+    }
+    /**
+     * Update the appearance streams for each of this check box's widgets using
+     * the default appearance provider for check boxes. For example:
+     * ```js
+     * const checkBox = form.getCheckBox('some.checkBox.field')
+     * checkBox.defaultUpdateAppearances()
+     * ```
+     */
+    defaultUpdateAppearances() {
+        this.updateAppearances();
+    }
+    /**
+     * Update the appearance streams for each of this check box's widgets using
+     * the given appearance provider. If no `provider` is passed, the default
+     * appearance provider for check boxs will be used. For example:
+     * ```js
+     * const checkBox = form.getCheckBox('some.checkBox.field')
+     * checkBox.updateAppearances((field, widget) => {
+     *   ...
+     *   return {
+     *     normal: { on: drawCheckBox(...), off: drawCheckBox(...) },
+     *     down: { on: drawCheckBox(...), off: drawCheckBox(...) },
+     *   }
+     * })
+     * ```
+     * @param provider Optionally, the appearance provider to be used for
+     *                 generating the contents of the appearance streams.
+     */
+    updateAppearances(provider) {
+        assertOrUndefined(provider, 'provider', [Function]);
+        const widgets = this.acroField.getWidgets();
+        for (let idx = 0, len = widgets.length; idx < len; idx++) {
+            const widget = widgets[idx];
+            const onValue = widget.getOnValue() ?? PDFName.of('Yes');
+            if (!onValue)
+                continue;
+            this.updateWidgetAppearance(widget, onValue, provider);
+        }
+        this.markAsClean();
+    }
+    updateWidgetAppearance(widget, onValue, provider) {
+        const apProvider = provider ?? defaultCheckBoxAppearanceProvider;
+        const appearances = normalizeAppearance(apProvider(this, widget));
+        this.updateOnOffWidgetAppearance(widget, onValue, appearances);
+    }
+}
+/**
+ * > **NOTE:** You probably don't want to call this method directly. Instead,
+ * > consider using the [[PDFForm.getCheckBox]] method, which will create an
+ * > instance of [[PDFCheckBox]] for you.
+ *
+ * Create an instance of [[PDFCheckBox]] from an existing acroCheckBox and ref
+ *
+ * @param acroCheckBox The underlying `PDFAcroCheckBox` for this check box.
+ * @param ref The unique reference for this check box.
+ * @param doc The document to which this check box will belong.
+ */
+Object.defineProperty(PDFCheckBox, "of", {
+    enumerable: true,
+    configurable: true,
+    writable: true,
+    value: (acroCheckBox, ref, doc) => new PDFCheckBox(acroCheckBox, ref, doc)
+});
+export default PDFCheckBox;
+//# sourceMappingURL=PDFCheckBox.js.map

package/dist/esm/src/api/form/PDFCheckBox.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"PDFCheckBox.js","sourceRoot":"","sources":["../../../../../src/api/form/PDFCheckBox.ts"],"names":[],"mappings":"AACA,OAAO,OAAO,MAAM,YAAY,CAAC;AACjC,OAAO,EAEL,mBAAmB,EACnB,iCAAiC,GAClC,MAAM,eAAe,CAAC;AACvB,OAAO,EAAE,GAAG,EAAE,MAAM,WAAW,CAAC;AAChC,OAAO,EAAE,OAAO,EAAE,MAAM,cAAc,CAAC;AACvC,OAAO,QAAQ,EAAE,EAEf,4BAA4B,GAC7B,MAAM,YAAY,CAAC;AAEpB,OAAO,EACL,OAAO,EAEP,OAAO,EACP,eAAe,GAEhB,MAAM,YAAY,CAAC;AACpB,OAAO,EAAE,QAAQ,EAAE,iBAAiB,EAAE,MAAM,aAAa,CAAC;AAE1D;;;;;;;;GAQG;AACH,MAAqB,WAAY,SAAQ,QAAQ;IAkB/C,YACE,YAA6B,EAC7B,GAAW,EACX,GAAgB;QAEhB,KAAK,CAAC,YAAY,EAAE,GAAG,EAAE,GAAG,CAAC,CAAC;QARhC,+DAA+D;QACtD;;;;;WAA2B;QASlC,QAAQ,CAAC,YAAY,EAAE,cAAc,EAAE;YACrC,CAAC,eAAe,EAAE,iBAAiB,CAAC;SACrC,CAAC,CAAC;QAEH,IAAI,CAAC,SAAS,GAAG,YAAY,CAAC;IAChC,CAAC;IAED;;;;;;;;;;;;;;;;;;OAkBG;IACH,KAAK;QACH,MAAM,OAAO,GAAG,IAAI,CAAC,SAAS,CAAC,UAAU,EAAE,IAAI,OAAO,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC;QACjE,IAAI,CAAC,WAAW,EAAE,CAAC;QACnB,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;IACnC,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACH,OAAO;QACL,IAAI,CAAC,WAAW,EAAE,CAAC;QACnB,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,OAAO,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC;IAC7C,CAAC;IAED;;;;;;;;OAQG;IACH,SAAS;QACP,MAAM,OAAO,GAAG,IAAI,CAAC,SAAS,CAAC,UAAU,EAAE,CAAC;QAC5C,OAAO,CAAC,CAAC,OAAO,IAAI,OAAO,KAAK,IAAI,CAAC,SAAS,CAAC,QAAQ,EAAE,CAAC;IAC5D,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACH,SAAS,CAAC,IAAa,EAAE,OAAgC;QACvD,QAAQ,CAAC,IAAI,EAAE,MAAM,EAAE,CAAC,CAAC,OAAO,EAAE,SAAS,CAAC,CAAC,CAAC,CAAC;QAC/C,4BAA4B,CAAC,OAAO,CAAC,CAAC;QAEtC,IAAI,CAAC,OAAO;YAAE,OAAO,GAAG,EAAE,CAAC;QAE3B,IAAI,CAAC,CAAC,WAAW,IAAI,OAAO,CAAC;YAAE,OAAO,CAAC,SAAS,GAAG,GAAG,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;QAChE,IAAI,CAAC,CAAC,iBAAiB,IAAI,OAAO,CAAC;YAAE,OAAO,CAAC,eAAe,GAAG,GAAG,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;QAC5E,IAAI,CAAC,CAAC,aAAa,IAAI,OAAO,CAAC;YAAE,OAAO,CAAC,WAAW,GAAG,GAAG,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;QACpE,IAAI,CAAC,CAAC,aAAa,IAAI,OAAO,CAAC;YAAE,OAAO,CAAC,WAAW,GAAG,CAAC,CAAC;QAEzD,qCAAqC;QACrC,MAAM,MAAM,GAAG,IAAI,CAAC,YAAY,CAAC;YAC/B,CAAC,EAAE,OAAO,CAAC,CAAC,IAAI,CAAC;YACjB,CAAC,EAAE,OAAO,CAAC,CAAC,IAAI,CAAC;YACjB,KAAK,EAAE,OAAO,CAAC,KAAK,IAAI,EAAE;YAC1B,MAAM,EAAE,OAAO,CAAC,MAAM,IAAI,EAAE;YAC5B,SAAS,EAAE,OAAO,CAAC,SAAS;YAC5B,eAAe,EAAE,OAAO,CAAC,eAAe;YACxC,WAAW,EAAE,OAAO,CAAC,WAAW;YAChC,WAAW,EAAE,OAAO,CAAC,WAAW,IAAI,CAAC;YACrC,MAAM,EAAE,OAAO,CAAC,MAAM,IAAI,OAAO,CAAC,CAAC,CAAC;YACpC,MAAM,EAAE,OAAO,CAAC,MAAM;YACtB,IAAI,EAAE,IAAI,CAAC,GAAG;SACf,CAAC,CAAC;QACH,MAAM,SAAS,GAAG,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;QAEzD,2BAA2B;QAC3B,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC;QAEpC,oCAAoC;QACpC,MAAM,CAAC,kBAAkB,CAAC,OAAO,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC;QAC7C,IAAI,CAAC,sBAAsB,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC;QAEvD,+BAA+B;QAC/B,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC;IAChC,CAAC;IAED;;;;;;;;OAQG;IACH,sBAAsB;QACpB,MAAM,OAAO,GAAG,IAAI,CAAC,SAAS,CAAC,UAAU,EAAE,CAAC;QAC5C,KAAK,IAAI,GAAG,GAAG,CAAC,EAAE,GAAG,GAAG,OAAO,CAAC,MAAM,EAAE,GAAG,GAAG,GAAG,EAAE,GAAG,EAAE,EAAE,CAAC;YACzD,MAAM,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC;YAC5B,MAAM,KAAK,GAAG,MAAM,CAAC,kBAAkB,EAAE,CAAC;YAC1C,MAAM,MAAM,GAAG,MAAM,CAAC,cAAc,EAAE,EAAE,MAAM,CAAC;YAE/C,IAAI,CAAC,CAAC,MAAM,YAAY,OAAO,CAAC;gBAAE,OAAO,IAAI,CAAC;YAC9C,IAAI,KAAK,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC;gBAAE,OAAO,IAAI,CAAC;QAC/C,CAAC;QAED,OAAO,KAAK,CAAC;IACf,CAAC;IAED;;;;;;;OAOG;IACH,wBAAwB;QACtB,IAAI,CAAC,iBAAiB,EAAE,CAAC;IAC3B,CAAC;IAED;;;;;;;;;;;;;;;;OAgBG;IACH,iBAAiB,CAAC,QAA6C;QAC7D,iBAAiB,CAAC,QAAQ,EAAE,UAAU,EAAE,CAAC,QAAQ,CAAC,CAAC,CAAC;QAEpD,MAAM,OAAO,GAAG,IAAI,CAAC,SAAS,CAAC,UAAU,EAAE,CAAC;QAC5C,KAAK,IAAI,GAAG,GAAG,CAAC,EAAE,GAAG,GAAG,OAAO,CAAC,MAAM,EAAE,GAAG,GAAG,GAAG,EAAE,GAAG,EAAE,EAAE,CAAC;YACzD,MAAM,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC;YAC5B,MAAM,OAAO,GAAG,MAAM,CAAC,UAAU,EAAE,IAAI,OAAO,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC;YACzD,IAAI,CAAC,OAAO;gBAAE,SAAS;YACvB,IAAI,CAAC,sBAAsB,CAAC,MAAM,EAAE,OAAO,EAAE,QAAQ,CAAC,CAAC;QACzD,CAAC;QACD,IAAI,CAAC,WAAW,EAAE,CAAC;IACrB,CAAC;IAEO,sBAAsB,CAC5B,MAA2B,EAC3B,OAAgB,EAChB,QAA6C;QAE7C,MAAM,UAAU,GAAG,QAAQ,IAAI,iCAAiC,CAAC;QACjE,MAAM,WAAW,GAAG,mBAAmB,CAAC,UAAU,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC,CAAC;QAClE,IAAI,CAAC,2BAA2B,CAAC,MAAM,EAAE,OAAO,EAAE,WAAW,CAAC,CAAC;IACjE,CAAC;;AAnOD;;;;;;;;;;GAUG;AACI;;;;WAAK,CAAC,YAA6B,EAAE,GAAW,EAAE,GAAgB,EAAE,EAAE,CAC3E,IAAI,WAAW,CAAC,YAAY,EAAE,GAAG,EAAE,GAAG,CAAC;EADhC,CACiC;eAbvB,WAAW"}