org.apache.pdfbox.pdmodel.interactive.form

Class PDPushButton

java.lang.Object

org.apache.pdfbox.pdmodel.interactive.form.PDField

org.apache.pdfbox.pdmodel.interactive.form.PDTerminalField

org.apache.pdfbox.pdmodel.interactive.form.PDButton

org.apache.pdfbox.pdmodel.interactive.form.PDPushButton

All Implemented Interfaces:

COSObjectable

public class PDPushButton
extends PDButton

A pushbutton is a purely interactive control that responds immediately to user input without retaining a permanent value.

Author:

sug

Field Summary

Fields inherited from class org.apache.pdfbox.pdmodel.interactive.form.PDField

acroForm, dictionary, parent

Constructor Summary

Constructors

Constructor and Description
PDPushButton(PDAcroForm acroForm)

Method Summary

Modifier and Type	Method and Description
List<String>	getExportValues() This will get the export values.
List<String>	getOptions() This will get the option values - the "Opt" entry.
String	getValueAsString() Returns a string representation of the "V" entry, or an empty string.
void	setExportValues(List<String> values) This will set the export values.
void	setOptions(List<String> values) This will set the options.

Methods inherited from class org.apache.pdfbox.pdmodel.interactive.form.PDButton

isPushButton, isRadioButton, setPushButton, setRadioButton

Methods inherited from class org.apache.pdfbox.pdmodel.interactive.form.PDTerminalField

applyChange, getFieldFlags, getFieldType, getWidget, getWidgets, importFDF, setActions, setWidgets

Methods inherited from class org.apache.pdfbox.pdmodel.interactive.form.PDField

getAcroForm, getActions, getAlternateFieldName, getCOSObject, getFullyQualifiedName, getInheritableAttribute, getMappingName, getParent, getPartialName, getV, isNoExport, isReadonly, isRequired, setAlternateFieldName, setFieldFlags, setMappingName, setNoExport, 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 acroForm)

Parameters:

acroForm - The acroform.

See Also:

PDField.PDField(PDAcroForm)

Method Detail

getOptions

public List<String> getOptions()

Description copied from class: PDButton

This will get the option values - the "Opt" entry.

The option values are used to define the export values for the field to

• hold values in non-Latin writing systems as name objects, which represent the field value, are limited to PDFDocEncoding
• allow radio buttons having the same export value to be handled independently

Overrides:

getOptions in class PDButton

Returns:

List containing all possible options. If there is no Opt entry an empty list will be returned.

setOptions

public void setOptions(List<String> values)

Description copied from class: PDButton

This will set the options.

Overrides:

setOptions in class PDButton

Parameters:

values - List containing all possible options. Supplying null list will remove the Opt entry.

See Also:

PDButton.getOptions()

getExportValues

public List<String> getExportValues()

Description copied from class: PDButton

This will get the export values.

The export values are defined in the field dictionaries /Opt key.

The option values are used to define the export values for the field to

• hold values in non-Latin writing systems as name objects, which represent the field value, are limited to PDFDocEncoding
• allow radio buttons having the same export value to be handled independently

Overrides:

getExportValues in class PDButton

Returns:

List containing all possible export values. If there is no Opt entry an empty list will be returned.

setExportValues

public void setExportValues(List<String> values)

Description copied from class: PDButton

This will set the export values.

Overrides:

setExportValues in class PDButton

Parameters:

values - List containing all possible export values. Supplying null or an empty list will remove the Opt entry.

See Also:

PDButton.getExportValues()

getValueAsString

public String getValueAsString()

Description copied from class: PDField

Returns a string representation of the "V" entry, or an empty string.

Specified by:

getValueAsString in class PDField

Returns:

A non-null string.