com.qoppa.pdf.form

Interface CheckBoxField

All Superinterfaces:

FormField

public interface CheckBoxField
extends FormField

CheckBoxField holds a check box field.

Author:

Qoppa Software

Field Summary

Fields inherited from interface com.qoppa.pdf.form.FormField

FF_NOEXPORT, FF_READONLY, FF_REQUIRED, TYPE_BUTTON, TYPE_CHECKBOX, TYPE_COMBOBOX, TYPE_LISTBOX, TYPE_RADIOBUTTON, TYPE_SIGNATURE, TYPE_TEXT

Method Summary

Modifier and Type	Method and Description
String	getDefaultValue() Returns the default value for the check box field.
String	getValue() Returns the value for the check box field.
void	setDefaultValue(String defaultValue) Sets the default value for the check box field.
void	setValue(String value) Sets the value for the check box field.

Methods inherited from interface com.qoppa.pdf.form.FormField

addFieldListener, addKeyListener, addMouseListener, flattenField, getAltFieldName, getFieldFlags, getFieldName, getFieldTypeDesc, getFullFieldName, getKids, getMapFieldName, getTriggerActions, getUserName, getWidgets, isEmpty, isNoExport, isReadOnly, isRequired, removeFieldListener, reset, setAltFieldName, setComponentVisible, setFieldFlags, setFieldName, setHidden, setMapFieldName, setNoExport, setPrintable, setReadOnly, setRequired, setTriggerActions, setUserName

Method Detail

getValue

String getValue()

Returns the value for the check box field. If the check box is checked, the value is the export value, else the value is "off".

getDefaultValue

String getDefaultValue()

Returns the default value for the check box field. The default value is the export value if the check box is checked by default or it is "off" if the check box is not checked by default.

setDefaultValue

void setDefaultValue(String defaultValue)

Sets the default value for the check box field. To make the check box checked by default, set the default value to the export value. To make the check box unchecked by default, set the default value to "off".

setValue

void setValue(String value)
       throws PDFException

Sets the value for the check box field. To make the check box checked, set the value to the export value. To make the check box unchecked, set the value to "off".

Throws:

PDFException