Class PDCheckBox
java.lang.Object
org.apache.pdfbox.pdmodel.interactive.form.PDField
org.apache.pdfbox.pdmodel.interactive.form.PDTerminalField
org.apache.pdfbox.pdmodel.interactive.form.PDButton
org.apache.pdfbox.pdmodel.interactive.form.PDCheckBox
- All Implemented Interfaces:
COSObjectable
A check box toggles between two states, on and off.
-
Field Summary
Fields inherited from class org.apache.pdfbox.pdmodel.interactive.form.PDButton
FLAG_PUSHBUTTON, FLAG_RADIO, FLAG_RADIOS_IN_UNISON
-
Constructor Summary
ConstructorsConstructorDescriptionPDCheckBox
(PDAcroForm acroForm) PDCheckBox
(PDAcroForm acroForm, COSDictionary field, PDNonTerminalField parent) Constructor. -
Method Summary
Methods inherited from class org.apache.pdfbox.pdmodel.interactive.form.PDButton
checkValue, constructAppearances, getDefaultValue, getExportValues, getOnValues, getValue, getValueAsString, isPushButton, isRadioButton, setDefaultValue, setExportValues, setPushButton, setRadioButton, setValue, setValue
Methods inherited from class org.apache.pdfbox.pdmodel.interactive.form.PDTerminalField
applyChange, exportFDF, getFieldFlags, getFieldType, getWidget, getWidgets, importFDF, setActions, setWidgets
Methods inherited from class org.apache.pdfbox.pdmodel.interactive.form.PDField
findKid, fromDictionary, getAcroForm, getActions, getAlternateFieldName, getCOSObject, getFullyQualifiedName, getInheritableAttribute, getMappingName, getParent, getPartialName, isNoExport, isReadOnly, isRequired, setAlternateFieldName, setFieldFlags, setMappingName, setNoExport, setPartialName, setReadOnly, setRequired, toString
-
Constructor Details
-
PDCheckBox
- Parameters:
acroForm
- The acroform.- See Also:
-
PDCheckBox
PDCheckBox(PDAcroForm acroForm, COSDictionary field, PDNonTerminalField parent) Constructor.- Parameters:
acroForm
- The form that this field is part of.field
- the PDF object to represent as a field.parent
- the parent node of the node
-
-
Method Details
-
isChecked
public boolean isChecked()This will tell if this radio button is currently checked or not. This is equivalent to callingPDButton.getValue()
.- Returns:
- true If this field is checked.
-
check
Checks the check box.- Throws:
IOException
- if the appearance couldn't be generated.
-
unCheck
Unchecks the check box.- Throws:
IOException
- if the appearance couldn't be generated.
-
getOnValue
Get the value which sets the check box to the On state.The On value should be 'Yes' but other values are possible so we need to look for that. On the other hand the Off value shall always be 'Off'. If not set or not part of the normal appearance keys 'Off' is the default
- Returns:
- the value setting the check box to the On state. If an empty string is returned there is no appearance definition.
-