org.apache.pdfbox.pdmodel.interactive.form

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

public final class PDCheckbox
extends PDButton

A check box toggles between two states, on and off.

Author:

Ben Litchfield, sug

Field Summary

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

acroForm, dictionary, parent

Constructor Summary

Constructors

Constructor and Description
PDCheckbox(PDAcroForm acroForm)

Method Summary

Modifier and Type	Method and Description
void	check() Checks the check box.
Boolean	getDefaultValue() Returns the default value, if any.
boolean	getValue() Returns true if this field is checked.
String	getValueAsString() Returns a string representation of the "V" entry, or an empty string.
boolean	isChecked() This will tell if this radio button is currently checked or not.
void	setDefaultValue(boolean value) Sets the default value.
void	setValue(boolean value) Sets the checked value of this field.
void	unCheck() Unchecks the check box.

Methods inherited from class org.apache.pdfbox.pdmodel.interactive.form.PDButton

getExportValues, getOptions, isPushButton, isRadioButton, setExportValues, setOptions, setPushButton, setRadioButton

Methods inherited from class org.apache.pdfbox.pdmodel.interactive.form.PDTerminalField

applyChange, getFieldFlags, getFieldType, getWidget, getWidgets, importFDF, setActions, setWidgets

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

getAcroForm, getActions, getAlternateFieldName, getCOSObject, getFullyQualifiedName, getInheritableAttribute, getMappingName, getParent, getPartialName, getV, isNoExport, isReadonly, isRequired, setAlternateFieldName, setFieldFlags, setMappingName, setNoExport, setPartialName, setReadonly, setRequired, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

PDCheckbox

public PDCheckbox(PDAcroForm acroForm)

Parameters:

acroForm - The acroform.

See Also:

PDField.PDField(PDAcroForm)

Method Detail

isChecked

public boolean isChecked()

This will tell if this radio button is currently checked or not. This is equivalent to calling getValue().

Returns:

true If this field is checked.

check

public void check()
           throws IOException

Checks the check box.

Throws:

IOException

unCheck

public void unCheck()
             throws IOException

Unchecks the check box.

Throws:

IOException

getValue

public boolean getValue()

Returns true if this field is checked.

Returns:

True if checked

getDefaultValue

public Boolean getDefaultValue()

Returns the default value, if any.

Returns:

True if checked, false if not checked, null if missing.

getValueAsString

public String getValueAsString()

Description copied from class: PDField

Returns a string representation of the "V" entry, or an empty string.

Specified by:

getValueAsString in class PDField

Returns:

A non-null string.

setValue

public void setValue(boolean value)
              throws IOException

Sets the checked value of this field.

Parameters:

value - True if checked

Throws:

IOException - if the value could not be set

setDefaultValue

public void setDefaultValue(boolean value)
                     throws IOException

Sets the default value.

Parameters:

value - True if checked

Throws:

IOException - if the value could not be set