org.pdfbox.pdmodel.interactive.form
Class PDPushButton

java.lang.Object
  extended byorg.pdfbox.pdmodel.interactive.form.PDField
      extended byorg.pdfbox.pdmodel.interactive.form.PDPushButton
All Implemented Interfaces:
COSObjectable

public class PDPushButton
extends PDField

A class for handling the PDF field as a PDPushButton.

Version:
$Revision: 1.3 $
Author:
sug

Field Summary
 
Fields inherited from class org.pdfbox.pdmodel.interactive.form.PDField
FLAG_NO_EXPORT, FLAG_READ_ONLY, FLAG_REQUIRED
 
Constructor Summary
PDPushButton(PDAcroForm theAcroForm, COSDictionary field)
           
 
Method Summary
 String getValue()
          getValue gets the fields value to as a string.
 void setValue(String value)
          setValue sets the fields value to a given string.
 
Methods inherited from class org.pdfbox.pdmodel.interactive.form.PDField
findFieldType, findKid, getAcroForm, getActions, getCOSObject, getDictionary, getFieldFlags, getFieldType, getFullyQualifiedName, getKids, getParent, getPartialName, getWidget, importFDF, isNoExport, isReadonly, isRequired, setAcroForm, setActions, setFieldFlags, setKids, setNoExport, setParent, setPartialName, setReadonly, setRequired, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

PDPushButton

public PDPushButton(PDAcroForm theAcroForm,
                    COSDictionary field)
Parameters:
theAcroForm - The acroForm for this field.
field - The field for this push button.
See Also:
org.pdfbox.pdmodel.field.PDField#COSField(org.pdfbox.cos.COSDictionary)
Method Detail

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 the field.
Throws:
IOException - If there is an error creating the appearance stream.
See Also:
as.interactive.pdf.form.cos.COSField#setValue(java.lang.String)

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.