org.pdfbox.pdmodel.interactive.form

Class PDRadioCollection

Implemented Interfaces:
COSObjectable

public class PDRadioCollection
extends PDChoiceButton

A class for handling the PDF field as a Radio Collection. This class automatically keeps track of the child radio buttons in the collection.
Version:
$Revision: 1.13 $
Author:
sug
See Also:
PDCheckbox

Field Summary

static int
FLAG_RADIOS_IN_UNISON
A Ff flag.

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

FLAG_NO_EXPORT, FLAG_READ_ONLY, FLAG_REQUIRED

Constructor Summary

PDRadioCollection(PDAcroForm theAcroForm, COSDictionary field)

Method Summary

List
getKids()
This will return a list of PDField objects that are part of this radio collection.
String
getValue()
getValue gets the fields value to as a string.
boolean
isRadiosInUnison()
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)
This setValue method iterates the collection of radiobuttons and checks or unchecks each radiobutton according to the given value.

Methods inherited from class org.pdfbox.pdmodel.interactive.form.PDChoiceButton

getOptions, setOptions

Methods inherited from class org.pdfbox.pdmodel.interactive.form.PDField

findFieldType, findKid, getAcroForm, getActions, getCOSObject, getDictionary, getFieldFlags, getFieldType, getFullyQualifiedName, getKids, getParent, getPartialName, getValue, getWidget, importFDF, isNoExport, isReadonly, isRequired, setAcroForm, setActions, setFieldFlags, setKids, setNoExport, setParent, setPartialName, setReadonly, setRequired, setValue, toString

Field Details

FLAG_RADIOS_IN_UNISON

public static final int FLAG_RADIOS_IN_UNISON
A Ff flag.
Field Value:
33554432

Constructor Details

PDRadioCollection

public PDRadioCollection(PDAcroForm theAcroForm,
                         COSDictionary field)
Parameters:
theAcroForm - The acroForm for this field.
field - The field that makes up the radio collection.

Method Details

getKids

public List getKids()
            throws IOException
This will return a list of PDField objects that are part of this radio collection.
Overrides:
getKids in interface PDField
Returns:
A list of PDWidget objects.

getValue

public String getValue()
            throws IOException
getValue gets the fields value to as a string.
Overrides:
getValue in interface PDField
Returns:
The string value of this field.

isRadiosInUnison

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

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.

setValue

public void setValue(String value)
            throws IOException
This setValue method iterates the collection of radiobuttons and checks or unchecks each radiobutton according to the given value. If the value is not represented by any of the radiobuttons, then none will be checked.
Overrides:
setValue in interface PDField