Package com.pdftools.toolbox.pdf.forms

Class CheckBox

java.lang.Object

com.pdftools.toolbox.internal.NativeBase

com.pdftools.toolbox.internal.NativeObject

com.pdftools.toolbox.pdf.forms.FieldNode

com.pdftools.toolbox.pdf.forms.Field

com.pdftools.toolbox.pdf.forms.CheckBox

public class CheckBox
extends Field

A check box field

Method Summary

Modifier and Type	Method	Description
static CheckBox	create(Document targetDocument)	Create a check box form field
boolean	getChecked()	The state of the check box (Getter)
java.lang.String	getCheckedExportName()	The name of the checked ('on') state used when exporting (Getter)
void	setChecked(boolean value)	The state of the check box (Setter)

Methods inherited from class com.pdftools.toolbox.pdf.forms.Field

addNewWidget, getDoNotExport, getReadOnly, getRequired, getWidgets, setDoNotExport, setReadOnly, setRequired

Methods inherited from class com.pdftools.toolbox.pdf.forms.FieldNode

copy, getDisplayName, getExportName, setDisplayName, setExportName

Methods inherited from class com.pdftools.toolbox.internal.NativeObject

equals, hashCode

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, toString, wait, wait, wait

Method Detail

create

public static CheckBox create(Document targetDocument)

Create a check box form field

The returned form field object is not yet used, but it is associated with the given target document.

Parameters:

targetDocument - the output document with which the returned object is associated

Returns:

the newly created check box field

Throws:

java.lang.IllegalArgumentException - if the targetDocument argument has already been closed

java.lang.IllegalArgumentException - if the targetDocument argument is read-only

java.lang.IllegalArgumentException - the target document contains form fields that have been implicitly copied by a call to toolbox.pdf.Page.copy with an argument options in which toolbox.pdf.PageCopyOptions.setFormFields was set to FormFieldCopyStrategy.COPY

java.lang.IllegalArgumentException - the target document contains unsigned signatures that have been implicitly copied by a call to toolbox.pdf.Page.copy with an argument options in which toolbox.pdf.PageCopyOptions.setUnsignedSignatures was set to toolbox.pdf.CopyStrategy.COPY.

java.lang.IllegalArgumentException - if targetDocument is null

getCheckedExportName

public java.lang.String getCheckedExportName()

The name of the checked ('on') state used when exporting (Getter)

Throws:

java.lang.IllegalStateException - if the object has already been closed

getChecked

public boolean getChecked()

The state of the check box (Getter)

Throws:

java.lang.IllegalStateException - if the object has already been closed

setChecked

public void setChecked(boolean value)

The state of the check box (Setter)

Throws:

java.lang.IllegalStateException - if the object has already been closed

java.lang.UnsupportedOperationException - if the document is read-only

java.lang.IllegalStateException - if the form field is marked as read-only