com.snowtide.pdf.forms
Class AcroRadioButtonGroupField

java.lang.Object
  com.snowtide.pdf.forms.BaseAcroFormField
      com.snowtide.pdf.forms.AcroButtonField
          com.snowtide.pdf.forms.AcroRadioButtonGroupField

All Implemented Interfaces:

AcroFormField, FormField

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-2008 Snowtide Informatics Systems, Inc.

Field Summary

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

BUTTON_TYPE_CHECKBOX, BUTTON_TYPE_PUSHBUTTON, BUTTON_TYPE_RADIO_GROUP, callback, 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

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, getDefaultValue, getExportValue, getExportValues, getFullName, getLocalName, getMappingName, getName, getType, getUIName, getValue, hasValueChanged, isReadOnly

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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)
                 throws java.lang.IllegalArgumentException

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

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

canChangeValue

public boolean canChangeValue()

This function always returns true.