Package com.pdftools.toolbox.pdf.forms

Class SubForm

java.lang.Object

com.pdftools.toolbox.internal.NativeBase

com.pdftools.toolbox.internal.NativeObject

com.pdftools.toolbox.pdf.forms.FieldNode

com.pdftools.toolbox.pdf.forms.SubForm

public class SubForm
extends FieldNode

A form field that contains other fields

Method Summary

Modifier and Type	Method	Description
static SubForm	create(Document targetDocument)	Create a sub form
FieldNodeMap	getChildren()	The child form fields (Getter)

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 SubForm create(Document targetDocument)

Create a sub form

The returned sub form 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 sub form

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

getChildren

public FieldNodeMap getChildren()

The child form fields (Getter)

Adding to this list results in an error:

• IllegalState if the list has already been closed
• UnsupportedOperation if the document is read-only
• IllegalArgument
  • if the given form field node is null
  • if the given form field node has already been closed
  • if the given form field node does not belong to the same document as the list
  • if the given form field node has already been added to a form field node list
  • if the given form field node's identifier equals an identifier of one of the form field nodes in this list

This list does not support removing or setting elements or clearing.

Throws:

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