@compdfkit_pdf_sdk/react_native/src/annotation/form/CPDFTextWidget.ts

ComPDFKit for React Native is a comprehensive SDK that allows you to quickly add PDF functionality to Android, iOS, and React Native applications.

/**
 * Copyright © 2014-2026 PDF Technologies, Inc. All Rights Reserved.
 *
 * THIS SOURCE CODE AND ANY ACCOMPANYING DOCUMENTATION ARE PROTECTED BY INTERNATIONAL COPYRIGHT LAW
 * AND MAY NOT BE RESOLD OR REDISTRIBUTED. USAGE IS BOUND TO THE ComPDFKit LICENSE AGREEMENT.
 * UNAUTHORIZED REPRODUCTION OR DISTRIBUTION IS SUBJECT TO CIVIL AND CRIMINAL PENALTIES.
 * This notice may not be removed from this file.
 */

import { CPDFAlignment } from "../../configuration/CPDFOptions";
import { safeParseEnumValue } from "../../util/CPDFEnumUtils";
import { CPDFWidget } from "./CPDFWidget";

/**
 * Class representing a text field form widget, storing basic information about the text field form.
 * It includes general form attributes as well as the text content of the text field.
 *
 * @class CPDFTextWidget
 * @group Forms
 * @property {string} [text] - The text content of the text field.
 * @property {boolean} [isMultiline] - Indicates if the text field is multiline (default: false).
 * @property {string} [fontColor] - The font color of the text field (default: '#000000').
 * @property {number} [fontSize] - The font size of the text field (default: 0).
 * @property {CPDFAlignment} [alignment] - The alignment of the text field (default: CPDFAlignment.LEFT).
 * @property { string } [familyName] - The font family name of the text field.
 * @property { string } [styleName] - The font style name of the text field.
 */
export class CPDFTextWidget extends CPDFWidget {

    /**
     * The text content of the text field.
     */
    text: string;

    isMultiline : boolean;

    fontColor : string;

    familyName : string;

    styleName : string;

    fontSize : number;

    alignment : CPDFAlignment;

    constructor(params: Partial<CPDFTextWidget>) {
        super(params);
        this.type = 'textField';
        this.text = params.text ?? '';
        this.isMultiline = params.isMultiline ?? false;
        this.fontColor = params.fontColor ?? '#000000';
        this.familyName = params.familyName ?? '';
        this.styleName = params.styleName ?? '';
        this.fontSize = params.fontSize ?? 14;
        this.alignment = safeParseEnumValue(params.alignment, Object.values(CPDFAlignment), CPDFAlignment.LEFT);
    }

    /**
     * Update text widget properties with type safety
     * @param updates Partial object containing properties to update
     * @returns this instance for chaining
     * 
     * @example
     * textWidget.update({
     *   title: 'Updated Title',
     *   text: 'New text',
     *   fontColor: '#FF0000',
     *   fontSize: 14,
     *   alignment: CPDFAlignment.CENTER
     * });
     * await document.updateWidget(textWidget);
     */
    update(updates: Partial<Pick<CPDFTextWidget, 'title' | 'text' | 'isMultiline' | 'fontColor' | 'fontSize' | 'alignment' | 'familyName' | 'styleName' | 'borderColor' | 'fillColor' | 'borderWidth'>>): this {
        Object.assign(this, updates);
        return this;
    }

}