Apache PDFBox 3.0.4 · org.apache.pdfbox.pdmodel.interactive.form.PDRadioButton

Modifier and Type	Field and Description
private static final int	FLAG_NO_TOGGLE_TO_OFF A Ff flag.

Access	Constructor and Description
public	PDRadioButton(PDAcroForm The acroform. acroForm)
pack-priv	PDRadioButton(PDAcroForm The form that this field is part of. acroForm, COSDictionary the PDF object to represent as a field. field, PDNonTerminalField the parent node of the node parent) Constructor.

Method Summary

Modifier and Type	Method and Description
public List<String>	Returns: the export value of the field. getSelectedExportValues() This will get the selected export values.
public int	Returns: the first selected index or -1. getSelectedIndex() This will get the selected index.
public boolean	Returns: true If the flag is set for radios in unison. isRadiosInUnison()
public void	setRadiosInUnison(boolean The new flag for radiosInUnison. 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.

Inherited from org.apache.pdfbox.pdmodel.interactive.form.PDButton:: checkValue constructAppearances getDefaultValue getExportValues getOnValues getValue getValueAsString isPushButton isRadioButton setDefaultValue setExportValues setValue setValue

Field Detail

FLAG_NO_TOGGLE_TO_OFF	back to summary
private static final int FLAG_NO_TOGGLE_TO_OFF A Ff flag.

Constructor Detail

PDRadioButton	back to summary
public PDRadioButton(PDAcroForm acroForm) Parameters acroForm:PDAcroForm The acroform. See Also `PDField#PDField(PDAcroForm)`

PDRadioButton	back to summary
pack-priv PDRadioButton(PDAcroForm acroForm, COSDictionary field, PDNonTerminalField parent) Constructor. Parameters acroForm:PDAcroForm The form that this field is part of. field:COSDictionary the PDF object to represent as a field. parent:PDNonTerminalField the parent node of the node

PDRadioButton

back to summary

pack-priv PDRadioButton(PDAcroForm acroForm, COSDictionary field, PDNonTerminalField parent)

Constructor.

Parameters

acroForm:PDAcroForm: The form that this field is part of.
field:COSDictionary: the PDF object to represent as a field.
parent:PDNonTerminalField: the parent node of the node

Method Detail

getSelectedExportValues back to summary

getSelectedExportValues	back to summary
public List<String> getSelectedExportValues() This will get the selected export values. 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 `setExportValues(List)` which correspond to the individual items within the RadioButton. The method will either return the corresponding values from the options entry or in case there is no such entry the fields value Returns:List<String> the export value of the field.

public List<String> getSelectedExportValues()

This will get the selected export values.

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 setExportValues(List) which correspond to the individual items within the RadioButton.

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

Returns:List<String>: the export value of the field.

getSelectedIndex back to summary

getSelectedIndex	back to summary
public int getSelectedIndex() This will get the selected index. A RadioButton might have multiple same value options which are not selected jointly if they are not set in unison `isRadiosInUnison()`. The method will return the first selected index or -1 if no option is selected. Returns:int the first selected index or -1.

public int getSelectedIndex()

This will get the selected index.

A RadioButton might have multiple same value options which are not selected jointly if they are not set in unison isRadiosInUnison().

The method will return the first selected index or -1 if no option is selected.

Returns:int: the first selected index or -1.

isRadiosInUnison	back to summary
public boolean isRadiosInUnison() Returns:boolean true If the flag is set for radios in unison.

setRadiosInUnison	back to summary
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:boolean The new flag for radiosInUnison.

setRadiosInUnison

back to summary

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:boolean: The new flag for radiosInUnison.

public final Class PDRadioButton

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail