org.apache.pdfbox.pdmodel.interactive.form: public class: PDPushButton

org.apache.pdfbox.pdmodel.interactive.form
public class: PDPushButton [javadoc | source]

java.lang.Object
   org.apache.pdfbox.pdmodel.interactive.form.PDField
      org.apache.pdfbox.pdmodel.interactive.form.PDPushButton

All Implemented Interfaces:
COSObjectable

A class for handling the PDF field as a PDPushButton.

author: sug -

version: $ - Revision: 1.3 $

Fields inherited from org.apache.pdfbox.pdmodel.interactive.form.PDField:
FLAG_READ_ONLY, FLAG_REQUIRED, FLAG_NO_EXPORT

Constructor:

Constructor:
public PDPushButton(PDAcroForm theAcroForm, COSDictionary field) { super(theAcroForm, field); } Parameters: `theAcroForm` - The acroForm for this field. `field` - The field for this push button. Also see: org.apache.pdfbox.pdmodel.field.PDField#COSField(org.apache.pdfbox.cos.COSDictionary)

 public PDPushButton(PDAcroForm theAcroForm,
    COSDictionary field) {
        super(theAcroForm, field);
}

Parameters:

theAcroForm - The acroForm for this field.

field - The field for this push button.

Also see:

org.apache.pdfbox.pdmodel.field.PDField#COSField(org.apache.pdfbox.cos.COSDictionary)

Method from org.apache.pdfbox.pdmodel.interactive.form.PDPushButton Summary:
getValue, setValue

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 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.PDPushButton Detail:
public String getValue() throws IOException { return getDictionary().getString( "V" ); } getValue gets the fields value to as a string.
public void setValue(String value) throws IOException { COSString fieldValue = new COSString(value); getDictionary().setItem( COSName.getPDFName( "V" ), fieldValue ); getDictionary().setItem( COSName.getPDFName( "DV" ), fieldValue ); }

Method from org.apache.pdfbox.pdmodel.interactive.form.PDPushButton Detail:

 public String getValue() throws IOException {
        return getDictionary().getString( "V" );
}

getValue gets the fields value to as a string.

 public  void setValue(String value) throws IOException {
        COSString fieldValue = new COSString(value);
        getDictionary().setItem( COSName.getPDFName( "V" ), fieldValue );
        getDictionary().setItem( COSName.getPDFName( "DV" ), fieldValue );
}