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

All Implemented Interfaces:
    COSObjectable

Direct Known Subclasses:
    PDVariableText, PDTextbox, PDChoiceButton, PDUnknownField, PDCheckbox, PDRadioCollection, PDSignature, PDChoiceField, PDPushButton

This is the superclass for a Field element in a PDF. Based on the COS object model from PDFBox.
Field Summary
public static final  int FLAG_READ_ONLY    A Ff flag. 
public static final  int FLAG_REQUIRED    A Ff flag. 
public static final  int FLAG_NO_EXPORT    A Ff flag. 
Constructor:
 public PDField(PDAcroForm theAcroForm) 
    Constructor.
    Parameters:
    theAcroForm - The form that this field is part of.
 public PDField(PDAcroForm theAcroForm,
    COSDictionary field) 
    Creates a COSField from a COSDictionary, expected to be a correct object definition for a field in PDF.
    Parameters:
    theAcroForm - The form that this field is part of.
    field - the PDF objet to represent as a field.
Method from org.apache.pdfbox.pdmodel.interactive.form.PDField Summary:
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.PDField Detail:
 public String findFieldType() 
    Find the field type and optionally do a recursive upward search. Sometimes the fieldtype will be specified on the parent instead of the direct object. This will look at this object for the field type, if none is specified then it will look to the parent if there is a parent. If there is no parent and no field type has been found then this will return null.
 public PDField findKid(String[] name,
    int nameIndex) throws IOException 
    This will find one of the child elements. The name array are the components of the name to search down the tree of names. The nameIndex is where to start in that array. This method is called recursively until it finds the end point based on the name array.
 public PDAcroForm getAcroForm() 
    This will get the acroform that this field is part of.
 public PDFormFieldAdditionalActions getActions() 
    Get the additional actions for this field. This will return null if there are no additional actions for this field.
 public String getAlternateFieldName() 
    Gets the alternate name of the field.
 public COSBase getCOSObject() 
    Convert this standard java object to a COS object.
 public COSDictionary getDictionary() 
    This will get the dictionary associated with this field.
 public int getFieldFlags() 
    This will get the flags for this field.
 public String getFieldType() 
    Get the FT entry of the field. This is a read only field and is set depending on the actual type. The field type is an inheritable attribute. This method will return only the direct value on this object. Use the findFieldType for an upward recursive search.
 public String getFullyQualifiedName() throws IOException 
    Returns the fully qualified name of the field, which is a concatenation of the names of all the parents fields.
 public List getKids() throws IOException 
    This will get all the kids of this field. The values in the list will either be PDWidget or PDField. Normally they will be PDWidget objects unless this is a non-terminal field and they will be child PDField objects.
 public PDField getParent() throws IOException 
    Get the parent field to this field, or null if none exists.
 public String getPartialName() 
    Returns the partial name of the field.
 abstract public String getValue() throws IOException
    getValue gets the fields value to as a string.
 public PDAnnotationWidget getWidget() throws IOException 
    This will get the single associated widget that is part of this field. This occurs when the Widget is embedded in the fields dictionary. Sometimes there are multiple sub widgets associated with this field, in which case you want to use getKids(). If the kids entry is specified, then the first entry in that list will be returned.
 public  void importFDF(FDFField fdfField) throws IOException 
    This will import a fdf field from a fdf document.
 public boolean isNoExport() 
 public boolean isReadonly() 
 public boolean isRequired() 
 public  void setAcroForm(PDAcroForm value) 
    This will set the form this field is on.
 public  void setActions(PDFormFieldAdditionalActions actions) 
    Set the actions of the field.
 public  void setAlternateFieldName(String alternateFieldName) 
    This will set the alternate name of the field.
 public  void setFieldFlags(int flags) 
    This will set the flags for this field.
 public  void setKids(List kids) 
    This will set the list of kids.
 public  void setNoExport(boolean noExport) 
    sets the field to be not exported..
 public  void setParent(PDField parent) 
    Set the parent of this field.
 public  void setPartialName(String name) 
    This will set the partial name of the field.
 public  void setReadonly(boolean readonly) 
    sets the field to be read-only.
 public  void setRequired(boolean required) 
    sets the field to be required.
 abstract public  void setValue(String value) throws IOException
    setValue sets the fields value to a given string.
 public String toString() 
    This will return a string representation of this field.