|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.pdfbox.pdmodel.interactive.form.PDField
org.apache.pdfbox.pdmodel.interactive.form.PDChoiceButton
org.apache.pdfbox.pdmodel.interactive.form.PDRadioCollection
public class PDRadioCollection
A class for handling the PDF field as a Radio Collection. This class automatically keeps track of the child radio buttons in the collection.
PDCheckbox
Field Summary | |
---|---|
static int |
FLAG_RADIOS_IN_UNISON
A Ff flag. |
Fields inherited from class org.apache.pdfbox.pdmodel.interactive.form.PDField |
---|
FLAG_NO_EXPORT, FLAG_READ_ONLY, FLAG_REQUIRED |
Constructor Summary | |
---|---|
PDRadioCollection(PDAcroForm theAcroForm,
COSDictionary field)
|
Method Summary | |
---|---|
java.util.List |
getKids()
This will return a list of PDField objects that are part of this radio collection. |
java.lang.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(java.lang.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.apache.pdfbox.pdmodel.interactive.form.PDChoiceButton |
---|
getOptions, setOptions |
Methods inherited from class org.apache.pdfbox.pdmodel.interactive.form.PDField |
---|
findFieldType, findKid, getAcroForm, getActions, getAlternateFieldName, getCOSObject, getDictionary, getFieldFlags, getFieldType, getFullyQualifiedName, getParent, getPartialName, getWidget, importFDF, isNoExport, isReadonly, isRequired, setAcroForm, setActions, setAlternateFieldName, setFieldFlags, setKids, setNoExport, setParent, setPartialName, setReadonly, setRequired, toString |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final int FLAG_RADIOS_IN_UNISON
Constructor Detail |
---|
public PDRadioCollection(PDAcroForm theAcroForm, COSDictionary field)
theAcroForm
- The acroForm for this field.field
- The field that makes up the radio collection.
Method Detail |
---|
public void setRadiosInUnison(boolean radiosInUnison)
radiosInUnison
- The new flag for radiosInUnison.public boolean isRadiosInUnison()
public void setValue(java.lang.String value) throws java.io.IOException
setValue
in class PDField
value
- the string value
java.io.IOException
- If there is an error creating the appearance stream.public java.lang.String getValue() throws java.io.IOException
getValue
in class PDField
java.io.IOException
- If there is an error getting the value.public java.util.List getKids() throws java.io.IOException
getKids
in class PDField
java.io.IOException
- if there is an error while creating the children objects.PDField.getWidget()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |