|
| |
|
| java.lang.Object
 org.pdfbox.pdmodel.interactive.form.PDField
org.pdfbox.pdmodel.interactive.form.PDChoiceButton
org.pdfbox.pdmodel.interactive.form.PDRadioCollection
| PDRadioCollection | | public class PDRadioCollection extends PDChoiceButton (Code) | | A class for handling the PDF field as a Radio Collection.
This class automatically keeps track of the child radio buttons
in the collection.
See Also: PDCheckbox
author:
sug
version:
$Revision: 1.13 $ |
| Method Summary | |
| public List | getKids()
This will return a list of PDField objects that are part of this radio collection. | | public String | getValue()
getValue gets the fields value to as a string. | | public boolean | isRadiosInUnison()
| | 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. | | public void | setValue(String value)
This setValue method iterates the collection of radiobuttons
and checks or unchecks each radiobutton according to the
given value. |
| FLAG_RADIOS_IN_UNISON | | final public static int FLAG_RADIOS_IN_UNISON(Code) | | A Ff flag.
|
| PDRadioCollection | | public PDRadioCollection(PDAcroForm theAcroForm, COSDictionary field)(Code) | |
Parameters:
theAcroForm - The acroForm for this field.
Parameters:
field - The field that makes up the radio collection. |
| getKids | | public List getKids() throws IOException(Code) | | This will return a list of PDField objects that are part of this radio collection.
See Also: PDField.getWidget A list of PDWidget objects.
throws:
IOException - if there is an error while creating the children objects. |
| getValue | | public String getValue() throws IOException(Code) | | getValue gets the fields value to as a string.
The string value of this field.
throws:
IOException - If there is an error getting the value. |
| isRadiosInUnison | | public boolean isRadiosInUnison()(Code) | | true If the flag is set for radios in unison. |
| setRadiosInUnison | | public void setRadiosInUnison(boolean radiosInUnison)(Code) | | 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(Code) | | 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.
|
|
|
|