Package com.pdftools.toolbox.pdf.forms

Class ListBox

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.ChoiceField

com.pdftools.toolbox.pdf.forms.ListBox

public class ListBox
extends ChoiceField

A list box field

Method Summary

Modifier and Type	Method	Description
static ListBox	create(Document targetDocument)	Create a list box form field
boolean	getAllowMultiSelect()	Allow multiple items to be selected (Getter)
ChoiceItemList	getChosenItems()	The selected choice items (Getter)
void	setAllowMultiSelect(boolean value)	Allow multiple items to be selected (Setter)

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

addNewItem, getItems

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

Create a list 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 list 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

getAllowMultiSelect

public boolean getAllowMultiSelect()

Allow multiple items to be selected (Getter)

Throws:

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

setAllowMultiSelect

public void setAllowMultiSelect(boolean value)

Allow multiple items to be selected (Setter)

Throws:

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

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

getChosenItems

public ChoiceItemList getChosenItems()

The selected choice items (Getter)

Adding to this list results in an error:

• IllegalState
  • if the list has already been closed
  • if the choice field is marked a read-only
  • if this list is not empty and the list box field is not marked as multi-select
  • if the choice field has widgets
• UnsupportedOperation if the document is read-only
• IllegalArgument
  • if the given choice item is null
  • if the given choice item has already been closed
  • if the given choice item is already present in this list
  • if the given choice item does not belong to the list box field's choice items

Removing items or clearing the list results in an IllegalState error if the form field is marked as read-only, or if it has widgets.

Throws:

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