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

Constructor Summary

Constructors

Constructor and Description
PDPushButton(PDAcroForm acroForm)

Method Summary

Modifier and Type	Method and Description
String	getDefaultValue() Returns the default value, if any.
List<String>	getExportValues() This will get the (optional) export values.
String	getValue() Returns the selected value.
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.

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

getOnValues, isPushButton, isRadioButton, setDefaultValue, setPushButton, setRadioButton, setValue

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, 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

getExportValues

public List<String> getExportValues()

Description copied from class: PDButton

This will get the (optional) 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.

See Also:

PDButton.getOnValues()

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()

getValue

public String getValue()

Description copied from class: PDButton

Returns the selected value.

Off is the default value which will also be returned if the value hasn't been set at all.

Overrides:

getValue in class PDButton

Returns:

A non-null string.

getDefaultValue

public String getDefaultValue()

Description copied from class: PDButton

Returns the default value, if any.

Overrides:

getDefaultValue in class PDButton

Returns:

A non-null string.

getValueAsString

public String getValueAsString()

Description copied from class: PDField

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

Overrides:

getValueAsString in class PDButton

Returns:

The list of widget annotations.