Home » pdfbox-1.1.0-src » org.apache.pdfbox.pdmodel.interactive.form » [javadoc | source]
org.apache.pdfbox.pdmodel.interactive.form
abstract public class: PDVariableText [javadoc | source]
java.lang.Object
   org.apache.pdfbox.pdmodel.interactive.form.PDField
      org.apache.pdfbox.pdmodel.interactive.form.PDVariableText

All Implemented Interfaces:
    COSObjectable

Direct Known Subclasses:
    PDTextbox, PDChoiceField

A class for handling PDF fields that display text.
Field Summary
public static final  int FLAG_MULTILINE    A Ff flag. 
public static final  int FLAG_PASSWORD    A Ff flag. 
public static final  int FLAG_FILE_SELECT    A Ff flag. 
public static final  int FLAG_DO_NOT_SPELL_CHECK    A Ff flag. 
public static final  int FLAG_DO_NOT_SCROLL    A Ff flag. 
public static final  int FLAG_COMB    A Ff flag. 
public static final  int FLAG_RICH_TEXT    A Ff flag. 
public static final  int QUADDING_LEFT    A Q value. 
public static final  int QUADDING_CENTERED    A Q value. 
public static final  int QUADDING_RIGHT    A Q value. 
Fields inherited from org.apache.pdfbox.pdmodel.interactive.form.PDField:
FLAG_READ_ONLY,  FLAG_REQUIRED,  FLAG_NO_EXPORT
Constructor:
 public PDVariableText(PDAcroForm theAcroForm) 
    Parameters:
    theAcroForm - The acroform.
    Also see:
    PDField#PDField(PDAcroForm,COSDictionary)
 public PDVariableText(PDAcroForm theAcroForm,
    COSDictionary field) 
    Parameters:
    theAcroForm - The acroForm for this field.
    field - The field's dictionary.
    Also see:
    org.apache.pdfbox.pdmodel.interactive.form.PDField#PDField(PDAcroForm,COSDictionary)
Method from org.apache.pdfbox.pdmodel.interactive.form.PDVariableText Summary:
doNotScroll,   doNotSpellCheck,   getDefaultAppearance,   getQ,   getValue,   isFileSelect,   isMultiline,   isPassword,   isRichText,   setComb,   setDoNotScroll,   setDoNotSpellCheck,   setFileSelect,   setMultiline,   setPassword,   setQ,   setRichText,   setValue,   shouldComb
Methods from org.apache.pdfbox.pdmodel.interactive.form.PDField:
findFieldType,   findKid,   getAcroForm,   getActions,   getAlternateFieldName,   getCOSObject,   getDictionary,   getFieldFlags,   getFieldType,   getFullyQualifiedName,   getKids,   getParent,   getPartialName,   getValue,   getWidget,   importFDF,   isNoExport,   isReadonly,   isRequired,   setAcroForm,   setActions,   setAlternateFieldName,   setFieldFlags,   setKids,   setNoExport,   setParent,   setPartialName,   setReadonly,   setRequired,   setValue,   toString
Methods from java.lang.Object:
clone,   equals,   finalize,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait
Method from org.apache.pdfbox.pdmodel.interactive.form.PDVariableText Detail:
 public boolean doNotScroll() 
 public boolean doNotSpellCheck() 
 protected COSString getDefaultAppearance() 
 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.
 public String getValue() throws IOException 
    getValue gets the fields value to as a string.
 public boolean isFileSelect() 
 public boolean isMultiline() 
 public boolean isPassword() 
 public boolean isRichText() 
 public  void setComb(boolean comb) 
    Set the comb bit.
 public  void setDoNotScroll(boolean doNotScroll) 
    Set the doNotScroll bit.
 public  void setDoNotSpellCheck(boolean doNotSpellCheck) 
    Set the doNotSpellCheck bit.
 public  void setFileSelect(boolean fileSelect) 
    Set the file select bit.
 public  void setMultiline(boolean multiline) 
    Set the multiline bit.
 public  void setPassword(boolean password) 
    Set the password bit.
 public  void setQ(int q) 
    This will set the quadding/justification of the text. See QUADDING constants.
 public  void setRichText(boolean richText) 
    Set the richText bit.
 public  void setValue(String value) throws IOException 
 public boolean shouldComb()