org.apache.pdfbox.pdmodel.interactive.form

Class PDRadioButton

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.PDRadioButton

All Implemented Interfaces:

COSObjectable

public final class PDRadioButton
extends PDButton

Radio button fields contain a set of related buttons that can each be on or off.

Author:

sug

Field Summary

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

acroForm, dictionary, parent

Constructor Summary

Constructors

Constructor and Description
PDRadioButton(PDAcroForm acroForm)

Method Summary

Modifier and Type	Method and Description
String	getDefaultValue() Returns the default value, if any.
String	getExportValue() This will get the export value.
String	getValue() Returns the selected value.
String	getValueAsString() Returns a string representation of the "V" entry, or an empty string.
boolean	isRadiosInUnison()
void	setDefaultValue(String value) Sets the default value.
void	setRadiosInUnison(boolean radiosInUnison) From the PDF Spec If set, a group of radio buttons within a radio button field that use the same value for the on state will turn on and off in unison; that is if one is checked, they are all checked.
void	setValue(String value) Sets the selected radio button, given its name.

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

getExportValues, getOptions, isPushButton, isRadioButton, setExportValues, setOptions, 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

PDRadioButton

public PDRadioButton(PDAcroForm acroForm)

Parameters:

acroForm - The acroform.

See Also:

PDField.PDField(PDAcroForm)

Method Detail

setRadiosInUnison

public void setRadiosInUnison(boolean radiosInUnison)

From the PDF Spec
If set, a group of radio buttons within a radio button field that use the same value for the on state will turn on and off in unison; that is if one is checked, they are all checked. If clear, the buttons are mutually exclusive (the same behavior as HTML radio buttons).

Parameters:

radiosInUnison - The new flag for radiosInUnison.

isRadiosInUnison

public boolean isRadiosInUnison()

Returns:

true If the flag is set for radios in unison.

getExportValue

public String getExportValue()
                      throws IOException

This will get the export value.

A RadioButton might have an export value to allow field values which can not be encoded as PDFDocEncoding or for the same export value being assigned to multiple RadioButtons in a group.
To define an export value the RadioButton must define options PDButton.setOptions(List) which correspond to the individual items within the RadioButton.

The method will either return the value from the options entry or in case there is no such entry the fields value

Returns:

the export value of the field.

Throws:

IOException - in case the fields value can not be retrieved

getValue

public String getValue()

Returns the selected value. May be empty if NoToggleToOff is set but there is no value selected.

Returns:

A non-null string.

getDefaultValue

public String getDefaultValue()

Returns the default value, if any.

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.

Specified by:

getValueAsString in class PDField

Returns:

A non-null string.

setValue

public void setValue(String value)
              throws IOException

Sets the selected radio button, given its name.

Parameters:

value - Name of radio button to select

Throws:

IOException - if the value could not be set

setDefaultValue

public void setDefaultValue(String value)
                     throws IOException

Sets the default value.

Parameters:

value - Name of radio button to select

Throws:

IOException - if the value could not be set