com.snowtide.pdf.forms

Class AcroRadioButtonGroupField

java.lang.Object

com.snowtide.pdf.forms.AcroButtonField

com.snowtide.pdf.forms.AcroRadioButtonGroupField

All Implemented Interfaces:

DocumentLocation, AcroFormField, FormField, Bounded

public class AcroRadioButtonGroupField
extends AcroButtonField

Instances of this class represent a group of radio buttons in an interactive forms. Refer to AcroButtonField and AcroFormField for overview documentation.

Since:

v2.1

Version:

©2004-2024 Snowtide

Field Summary

Fields inherited from class com.snowtide.pdf.forms.AcroButtonField

BUTTON_TYPE_CHECKBOX, BUTTON_TYPE_PUSHBUTTON, BUTTON_TYPE_RADIO_GROUP, DEFAULT_UNSELECTED_VALUE

Fields inherited from interface com.snowtide.pdf.forms.AcroFormField

FIELD_TYPE_BUTTON, FIELD_TYPE_CHOICE, FIELD_TYPE_OTHER, FIELD_TYPE_SIGNATURE, FIELD_TYPE_TEXT

Method Summary

Modifier and Type	Method and Description
Region	bounds() Returns the region on the page where this radio button group is positioned.
boolean	canChangeValue() This function always returns true.
java.util.Set	getPossibleValues() Returns a set of the possible values that may be set on this button.
boolean	setValue(java.lang.String val) Sets the value of this button field.

Methods inherited from class com.snowtide.pdf.forms.AcroButtonField

getButtonType, getExportValue, getExportValues, getValue

Methods inherited from interface com.snowtide.pdf.forms.AcroFormField

getDefaultValue, getFullName, getLocalName, getMappingName, getType, getUIName, hasValueChanged, isReadOnly

Methods inherited from interface com.snowtide.pdf.forms.FormField

getName

Methods inherited from interface com.snowtide.pdf.DocumentLocation

pageNumber

Method Detail

getPossibleValues

public java.util.Set getPossibleValues()

Returns a set of the possible values that may be set on this button. These values are derived from the set of names of possible appearances that are available for this button. All possible values must be Strings.

setValue

public boolean setValue(java.lang.String val)

Sets the value of this button field. The provided String must be in the set of possible values for this field (see AcroRadioButtonGroupField.getPossibleValues() or null (i.e. no buttons in the radio button group should be selected).

Specified by:

setValue in interface AcroFormField

Returns:

true if the value of this field has been changed; false is returned if the provided value is the same as the current value, and no change has been made

Throws:

java.lang.IllegalArgumentException - if a String is provided that is not in the set returned by AcroRadioButtonGroupField.getPossibleValues().

canChangeValue

public boolean canChangeValue()

This function always returns true.

Specified by:

canChangeValue in interface AcroFormField

bounds

public Region bounds()

Returns the region on the page where this radio button group is positioned.

Since radio groups are an abstract construct — they are not rendered in any way, they only modify the behaviour and semantics of their constituent radio buttons — radio groups have no declared bounds of their own. Therefore, this method returns the union of the bounds of all the radio group's buttons.

Specified by:

bounds in interface Bounded