Class PDVariableText

java.lang.Object
org.apache.pdfbox.pdmodel.interactive.form.PDField
org.apache.pdfbox.pdmodel.interactive.form.PDVariableText
All Implemented Interfaces:
COSObjectable
Direct Known Subclasses:
PDChoiceField, PDTextbox

public abstract class PDVariableText extends PDField
A class for handling PDF fields that display text.
Version:
$Revision: 1.7 $
Author:
Ben Litchfield
  • Field Details

  • Constructor Details

  • Method Details

    • setValue

      public void setValue(String value) throws IOException
      Description copied from class: PDField
      setValue sets the fields value to a given string.
      Specified by:
      setValue in class PDField
      Parameters:
      value - The new value for this text field.
      Throws:
      IOException - If there is an error calculating the appearance stream.
      See Also:
    • getValue

      public String getValue() throws IOException
      getValue gets the fields value to as a string.
      Specified by:
      getValue in class PDField
      Returns:
      The string value of this field.
      Throws:
      IOException - If there is an error getting the value.
    • 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.
    • shouldComb

      public boolean shouldComb()
      Returns:
      true if the field is supposed 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.
    • getDefaultAppearance

      protected COSString getDefaultAppearance()
      Returns:
      the DA element of the dictionary object
    • getQ

      public int getQ()
      This will get the 'quadding' or justification of the text to be displayed. 0 - Left(default)
      1 - Centered
      2 - Right
      Please see the QUADDING_CONSTANTS.
      Returns:
      The justification of the text strings.
    • setQ

      public void setQ(int q)
      This will set the quadding/justification of the text. See QUADDING constants.
      Parameters:
      q - The new text justification.