PDPushButton (Apache PDFBox 1.8.16 API)

java.lang.Object
- org.apache.pdfbox.pdmodel.interactive.form.PDField
- - org.apache.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.apache.pdfbox.pdmodel.interactive.form.PDField
  FLAG_NO_EXPORT, FLAG_READ_ONLY, FLAG_REQUIRED

Constructor Summary

Constructors
Constructor Description

PDPushButton(PDAcroForm theAcroForm, COSDictionary field)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`java.lang.String`	`getValue()`	getValue gets the fields value to as a string.
`void`	`setValue(java.lang.String value)`	setValue sets the fields value to a given string.

Methods inherited from class org.apache.pdfbox.pdmodel.interactive.form.PDField
findFieldType, findKid, getAcroForm, getActions, getAlternateFieldName, getCOSObject, getDictionary, getFieldFlags, getFieldType, getFullyQualifiedName, getKids, getParent, getPartialName, getWidget, getWidgets, importFDF, isNoExport, isReadonly, isRequired, setAcroForm, setActions, setAlternateFieldName, setFieldFlags, setFieldType, 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:
    
    PDField(PDAcroForm, COSDictionary)
- Method Detail
  - setValue
```
public void setValue(java.lang.String value)
              throws java.io.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:
    
    java.io.IOException - If there is an error creating the appearance stream.
    
    See Also:
    
    PDField.setValue(java.lang.String)
  - getValue
```
public java.lang.String getValue()
                          throws java.io.IOException
```
    getValue gets the fields value to as a string.
    
    Specified by:
    
    getValue in class PDField
    
    Returns:
    
    The string value of this field.
    
    Throws:
    
    java.io.IOException - If there is an error getting the value.