Package org.apache.pdfbox.pdmodel.interactive.form

Class PDTextField

  • All Implemented Interfaces:
    COSObjectable
    public final class PDTextField
extends PDVariableText
    A text field is a box or space for text fill-in data typically entered from a keyboard. The text may be restricted to a single line or may be permitted to span multiple lines

    • Constructor Detail

      • PDTextField

        PDTextField​(PDAcroForm acroForm,
            COSDictionary field,
            PDNonTerminalField parent)
        Constructor.
        Parameters:
        acroForm - The form that this field is part of.
        field - the PDF object to represent as a field.
        parent - the parent node of the node

    • Method Detail

      • isMultiline

        public boolean isMultiline()
        Returns:
        true if the field is multiline

      • setMultiline

        public void setMultiline​(boolean multiline)
        Set the multiline bit.
        Parameters:
        multiline - The value for the multiline.

      • isPassword

        public boolean isPassword()
        Returns:
        true if the field is a password field.

      • setPassword

        public void setPassword​(boolean password)
        Set the password bit.
        Parameters:
        password - The value for the password.

      • isFileSelect

        public boolean isFileSelect()
        Returns:
        true if the field is a file select field.

      • setFileSelect

        public void setFileSelect​(boolean fileSelect)
        Set the file select bit.
        Parameters:
        fileSelect - The value for the fileSelect.

      • doNotSpellCheck

        public boolean doNotSpellCheck()
        Returns:
        true if the field is not suppose to spell check.

      • setDoNotSpellCheck

        public void setDoNotSpellCheck​(boolean doNotSpellCheck)
        Set the doNotSpellCheck bit.
        Parameters:
        doNotSpellCheck - The value for the doNotSpellCheck.

      • doNotScroll

        public boolean doNotScroll()
        Returns:
        true if the field is not suppose to scroll.

      • setDoNotScroll

        public void setDoNotScroll​(boolean doNotScroll)
        Set the doNotScroll bit.
        Parameters:
        doNotScroll - The value for the doNotScroll.

      • isComb

        public boolean isComb()
        Returns:
        true if the field is not suppose to comb the text display.

      • setComb

        public void setComb​(boolean comb)
        Set the comb bit.
        Parameters:
        comb - The value for the comb.

      • isRichText

        public boolean isRichText()
        Returns:
        true if the field is a rich text field.

      • setRichText

        public void setRichText​(boolean richText)
        Set the richText bit.
        Parameters:
        richText - The value for the richText.

      • getMaxLen

        public int getMaxLen()
        Returns the maximum number of characters of the text field.
        Returns:
        the maximum number of characters, returns -1 if the value isn't present

      • setMaxLen

        public void setMaxLen​(int maxLen)
        Sets the maximum number of characters of the text field.
        Parameters:
        maxLen - the maximum number of characters

      • setValue

        public void setValue​(java.lang.String value)
              throws java.io.IOException
        Set the plain text value of this field, and try to update the visual appearance.
        Specified by:
        setValue in class PDField
        Parameters:
        value - Plain text
        Throws:
        java.io.IOException - if the value could not be set

      • setDefaultValue

        public void setDefaultValue​(java.lang.String value)
        Sets the default value of this field.
        Parameters:
        value - Plain text

      • getValue

        public java.lang.String getValue()
        Returns the value of this field, or an empty string.
        Returns:
        A non-null string.

      • getDefaultValue

        public java.lang.String getDefaultValue()
        Returns the default value of this field, or an empty string.
        Returns:
        A non-null string.

      • getValueAsString

        public java.lang.String getValueAsString()
        Description copied from class: PDField
        Returns a string representation of the "V" entry, or an empty string.
        Specified by:
        getValueAsString in class PDField
        Returns:
        The list of widget annotations.

      • constructAppearances

        void constructAppearances()
                   throws java.io.IOException
        Description copied from class: PDTerminalField
        Constructs appearance streams and appearance dictionaries for all widget annotations. Subclasses should not call this method directly but via PDTerminalField.applyChange().
        Specified by:
        constructAppearances in class PDTerminalField
        Throws:
        java.io.IOException - if the appearance couldn't be generated