com.snowtide.pdf.forms

Class AcroCheckboxField

java.lang.Object

com.snowtide.pdf.forms.AcroButtonField

com.snowtide.pdf.forms.AcroCheckboxField

All Implemented Interfaces:

DocumentLocation, AcroFormField, FormField, Bounded

public class AcroCheckboxField
extends AcroButtonField

Instances of this class represent individual checkboxes in an interactive forms. Refer to AcroButtonField and AcroFormField for overview documentation.

In addition to the standard AcroFormField.setValue(String) function, AcroCheckboxField instances provide a AcroCheckboxField.setValue(boolean) function, making it easy to set the state of a checkbox form field without the extra indirection of having to determine what String value needs to be used to set it to the "checked" state.

Since:

v2.1

Version:

©2004-2024 Snowtide

Field Summary

Fields inherited from class com.snowtide.pdf.forms.AcroButtonField

BUTTON_TYPE_CHECKBOX, BUTTON_TYPE_PUSHBUTTON, BUTTON_TYPE_RADIO_GROUP, DEFAULT_UNSELECTED_VALUE

Fields inherited from interface com.snowtide.pdf.forms.AcroFormField

FIELD_TYPE_BUTTON, FIELD_TYPE_CHOICE, FIELD_TYPE_OTHER, FIELD_TYPE_SIGNATURE, FIELD_TYPE_TEXT

Method Summary

Modifier and Type	Method and Description
boolean	canChangeValue() This function always returns true.
java.lang.String	getCheckedValue() Returns the value that represents the checked state for this checkbox.
boolean	isChecked() Returns true only if this checkbox is checked (i.e.
boolean	setValue(boolean checked) Sets the value of this checkbox field to be checked (true) or unchecked (false).
boolean	setValue(java.lang.String value) Sets the value of this checkbox directly.

Methods inherited from class com.snowtide.pdf.forms.AcroButtonField

getButtonType, getExportValue, getExportValues, getValue

Methods inherited from interface com.snowtide.pdf.forms.AcroFormField

getDefaultValue, getFullName, getLocalName, getMappingName, getType, getUIName, hasValueChanged, isReadOnly

Methods inherited from interface com.snowtide.pdf.forms.FormField

getName

Methods inherited from interface com.snowtide.pdf.DocumentLocation

pageNumber

Methods inherited from interface com.snowtide.pdf.layout.Bounded

bounds

Method Detail

getCheckedValue

public java.lang.String getCheckedValue()

Returns the value that represents the checked state for this checkbox. (The string "/Off" represents the unchecked state for all checkboxes.) If this is null, then the name of the checked state for this checkbox could not be determined.

setValue

public boolean setValue(boolean checked)

Sets the value of this checkbox field to be checked (true) or unchecked (false). If this function call results in the actual value of the checkbox changing, then true will be returned. False will be returned only if:

• The checkbox field is already in the specified state.
• The name of the checked state for this checkbox could not be determined. This is rare, and can be checked for using AcroCheckboxField.getCheckedValue().

isChecked

public boolean isChecked()

Returns true only if this checkbox is checked (i.e. AcroButtonField.getValue().equals(AcroCheckboxField.getCheckedValue())).

setValue

public boolean setValue(java.lang.String value)

Sets the value of this checkbox directly. The provided value must be one of: null (unchecks the checkbox), AcroButtonField.DEFAULT_UNSELECTED_VALUE (unchecks the checkbox), or the checked value for this checkbox (which will check the checkbox). Using the AcroCheckboxField.setValue(boolean) function instead of this one is recommended.

If this function call results in the actual value of the checkbox changing, then true will be returned. False will be returned only if the checkbox field already has the specified value.

Specified by:

setValue in interface AcroFormField

Throws:

java.lang.IllegalArgumentException - if an invalid value is provided as described above.

canChangeValue

public boolean canChangeValue()

This function always returns true.

Specified by:

canChangeValue in interface AcroFormField