org.apache.pdfbox.pdmodel.interactive.form

Class PDButton

java.lang.Object

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

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

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

All Implemented Interfaces:

COSObjectable

Direct Known Subclasses:

PDCheckbox, PDPushButton, PDRadioButton

public abstract class PDButton
extends PDTerminalField

A button field represents an interactive control on the screen that the user can manipulate with the mouse.

Author:

sug

Field Summary

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

acroForm, dictionary, parent

Constructor Summary

Constructors

Constructor and Description
PDButton(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.
boolean	isPushButton() Determines if push button bit is set.
boolean	isRadioButton() Determines if radio button bit is set.
void	setExportValues(List<String> values) This will set the export values.
void	setOptions(List<String> values) This will set the options.
void	setPushButton(boolean pushbutton) Set the push button bit.
void	setRadioButton(boolean radiobutton) Set the radio button bit.

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

PDButton

public PDButton(PDAcroForm acroForm)

Parameters:

acroForm - The acroform.

See Also:

PDField.PDField(PDAcroForm)

Method Detail

isPushButton

public boolean isPushButton()

Determines if push button bit is set.

Returns:

true if type of button field is a push button.

setPushButton

public void setPushButton(boolean pushbutton)

Set the push button bit.

Parameters:

pushbutton - if true the button field is treated as a push button field.

isRadioButton

public boolean isRadioButton()

Determines if radio button bit is set.

Returns:

true if type of button field is a push button.

setRadioButton

public void setRadioButton(boolean radiobutton)

Set the radio button bit.

Parameters:

radiobutton - if true the button field is treated as a radio button field.

getOptions

public List<String> getOptions()

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

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)

This will set the options.

Parameters:

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

See Also:

getOptions()

getExportValues

public List<String> getExportValues()

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

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)

This will set the export values.

Parameters:

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

See Also:

getExportValues()