com.qoppa.pdf.form

Interface RadioButtonGroupField

All Superinterfaces:

FormField

public interface RadioButtonGroupField
extends FormField

RadioButtonGroupField holds a radio button group field. This is a group of radio buttons that all have the same name.

Author:

Qoppa Software

Field Summary

Fields

Modifier and Type	Field and Description
static int	FF_NOTOGGLETOOFF The field flag indicating exactly one radio button must be selected at all times.
static int	FF_RADIO The field flag indicating the field is a radio button.

Fields inherited from interface com.qoppa.pdf.form.FormField

FF_NOEXPORT, FF_READONLY, FF_REQUIRED, TYPE_BUTTON, TYPE_CHECKBOX, TYPE_COMBOBOX, TYPE_LISTBOX, TYPE_RADIOBUTTON, TYPE_SIGNATURE, TYPE_TEXT

Method Summary

Modifier and Type	Method and Description
String	getDefaultValue() Returns the default value for this radio button group field.
Vector<String>	getOnValues() Returns a Vector of values containing the on state for each of the radio buttons in this radio button group field.
Vector<String>	getOptions() Returns a Vector of values representing the export value of each annotation in this radio button group field.
String	getValue() Returns the value for this radio button group field.
String	getValueFromOptions() Returns the value for this radio button group field from the options if they exist.
void	setDefaultValue(String defaultValue) Sets the default value for this radio button group field.
void	setValue(String value) Sets the value for this radio button group field.
void	setValueFromOptions(String value) Sets the value from the options for this radio button group field if the options exist.

Methods inherited from interface com.qoppa.pdf.form.FormField

addFieldListener, addKeyListener, addMouseListener, flattenField, getAltFieldName, getFieldFlags, getFieldName, getFieldTypeDesc, getFullFieldName, getKids, getMapFieldName, getTriggerActions, getUserName, getWidgets, isEmpty, isNoExport, isReadOnly, isRequired, removeFieldListener, reset, setAltFieldName, setComponentVisible, setFieldFlags, setFieldName, setHidden, setMapFieldName, setNoExport, setPrintable, setReadOnly, setRequired, setTriggerActions, setUserName

Field Detail

FF_NOTOGGLETOOFF

static final int FF_NOTOGGLETOOFF

The field flag indicating exactly one radio button must be selected at all times.

See Also:

Constant Field Values

FF_RADIO

static final int FF_RADIO

The field flag indicating the field is a radio button.

See Also:

Constant Field Values

Method Detail

getDefaultValue

String getDefaultValue()

Returns the default value for this radio button group field. The default value is the export value if the radio button in the group that is to be selected by default Returns null if all radio buttons in the group are not selected by default.

Returns:

The default value for this radio button group field.

getValue

String getValue()

Returns the value for this radio button group field. The value is the export value if the radio button in the group that is currently selected. Returns null if all radio buttons in the group are currently not selected.

Returns:

The current value for this radio button group field.

setDefaultValue

void setDefaultValue(String defaultValue)

Sets the default value for this radio button group field. To make one of the radio button in the group selected by default, set the default value to the export value of this radio button. To make all the radio buttons in this group unselected by default, set the default value to null.

setValue

void setValue(String value)
       throws PDFException

Sets the value for this radio button group field. To make one of the radio button in the group selected, set the value to the export value of this radio button. To make all the radio buttons in this group unselected, set the value to null.

Throws:

PDFException

getValueFromOptions

String getValueFromOptions()

Returns the value for this radio button group field from the options if they exist. Otherwise returns the on value. Returns null if all radio buttons in the group are currently not selected.

setValueFromOptions

void setValueFromOptions(String value)
                  throws PDFException

Sets the value from the options for this radio button group field if the options exist. Otherwise sets the value as normal. To make all the radio buttons in this group unselected, set the value to null.

Parameters:

value -

Throws:

PDFException

getOnValues

Vector<String> getOnValues()

Returns a Vector of values containing the on state for each of the radio buttons in this radio button group field.

getOptions

Vector<String> getOptions()

Returns a Vector of values representing the export value of each annotation in this radio button group field. If the options do not exist, the Vector of on values is returned.