Module itextpdf
Package com.itextpdf.text.pdf

Class TextField

  • public class TextField
extends BaseField
    Supports text, combo and list fields generating the correct appearances. All the option in the Acrobat GUI are supported in an easy to use API.
    Author:
    Paulo Soares (psoares@consiste.pt)

    • Constructor Detail

      • TextField

        public TextField​(PdfWriter writer,
                 Rectangle box,
                 java.lang.String fieldName)
        Creates a new TextField.
        Parameters:
        writer - the document PdfWriter
        box - the field location and dimensions
        fieldName - the field name. If null only the widget keys will be included in the field allowing it to be used as a kid field.

    • Method Detail

      • removeCRLF

        public static java.lang.String removeCRLF​(java.lang.String text)
        Removes CRLF from a String.
        Parameters:
        text -
        Returns:
        String
        Since:
        2.1.5

      • obfuscatePassword

        public static java.lang.String obfuscatePassword​(java.lang.String text)
        Obfuscates a password String. Every character is replaced by an asterisk (*).
        Parameters:
        text -
        Returns:
        String
        Since:
        2.1.5

      • getAppearance

        public PdfAppearance getAppearance()
                            throws java.io.IOException,
                                   DocumentException
        Get the PdfAppearance of a text or combo field
        Returns:
        A PdfAppearance
        Throws:
        java.io.IOException - on error
        DocumentException - on error

      • getDefaultText

        public java.lang.String getDefaultText()
        Gets the default text.
        Returns:
        the default text

      • setDefaultText

        public void setDefaultText​(java.lang.String defaultText)
        Sets the default text. It is only meaningful for text fields.
        Parameters:
        defaultText - the default text

      • getChoices

        public java.lang.String[] getChoices()
        Gets the choices to be presented to the user in list/combo fields.
        Returns:
        the choices to be presented to the user

      • setChoices

        public void setChoices​(java.lang.String[] choices)
        Sets the choices to be presented to the user in list/combo fields.
        Parameters:
        choices - the choices to be presented to the user

      • getChoiceExports

        public java.lang.String[] getChoiceExports()
        Gets the export values in list/combo fields.
        Returns:
        the export values in list/combo fields

      • setChoiceExports

        public void setChoiceExports​(java.lang.String[] choiceExports)
        Sets the export values in list/combo fields. If this array is null then the choice values will also be used as the export values.
        Parameters:
        choiceExports - the export values in list/combo fields

      • getChoiceSelection

        public int getChoiceSelection()
        Gets the zero based index of the selected item.
        Returns:
        the zero based index of the selected item

      • gteChoiceSelections

        public java.util.ArrayList gteChoiceSelections()

      • setChoiceSelection

        public void setChoiceSelection​(int choiceSelection)
        Sets the zero based index of the selected item.
        Parameters:
        choiceSelection - the zero based index of the selected item

      • addChoiceSelection

        public void addChoiceSelection​(int selection)
        adds another (or a first I suppose) selection to a MULTISELECT list. This doesn't do anything unless this.options & MUTLISELECT != 0
        Parameters:
        selection - new selection

      • setChoiceSelections

        public void setChoiceSelections​(java.util.ArrayList selections)
        replaces the existing selections with the param. If this field isn't a MULTISELECT list, all but the first element will be removed.
        Parameters:
        selections - new selections. If null, it clear()s the underlying ArrayList.

      • setExtraMargin

        public void setExtraMargin​(float extraMarginLeft,
                           float extraMarginTop)
        Sets extra margins in text fields to better mimic the Acrobat layout.
        Parameters:
        extraMarginLeft - the extra margin left
        extraMarginTop - the extra margin top

      • getSubstitutionFonts

        public java.util.ArrayList getSubstitutionFonts()
        Gets the list of substitution fonts. The list is composed of BaseFont and can be null. The fonts in this list will be used if the original font doesn't contain the needed glyphs.
        Returns:
        the list

      • setSubstitutionFonts

        public void setSubstitutionFonts​(java.util.ArrayList substitutionFonts)
        Sets a list of substitution fonts. The list is composed of BaseFont and can also be null. The fonts in this list will be used if the original font doesn't contain the needed glyphs.
        Parameters:
        substitutionFonts - the list

      • getExtensionFont

        public BaseFont getExtensionFont()
        Gets the extensionFont. This font will be searched before the substitution fonts. It may be null.
        Returns:
        the extensionFont

      • setExtensionFont

        public void setExtensionFont​(BaseFont extensionFont)
        Sets the extensionFont. This font will be searched before the substitution fonts. It may be null.
        Parameters:
        extensionFont - New value of property extensionFont.