com.pdf_tools.fourheights.pdftoolbox.pdf.forms

Class ChoiceField

java.lang.Object

com.pdf_tools.fourheights.pdftoolbox.internal.NativeBase

com.pdf_tools.fourheights.pdftoolbox.internal.NativeObject

com.pdf_tools.fourheights.pdftoolbox.pdf.forms.FieldNode

com.pdf_tools.fourheights.pdftoolbox.pdf.forms.Field

com.pdf_tools.fourheights.pdftoolbox.pdf.forms.ChoiceField

Direct Known Subclasses:

ComboBox, ListBox

public class ChoiceField
extends Field

A choice field

Method Summary

Modifier and Type	Method and Description
ChoiceItem	addNewItem(java.lang.String displayName) Creates a new choice item.
static ChoiceField	createDynamicObject(long handle)
ChoiceItemList	getItems() The list of choice items (Getter)

Methods inherited from class com.pdf_tools.fourheights.pdftoolbox.pdf.forms.Field

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

Methods inherited from class com.pdf_tools.fourheights.pdftoolbox.pdf.forms.FieldNode

copy, getDisplayName, getExportName, setDisplayName, setExportName

Methods inherited from class com.pdf_tools.fourheights.pdftoolbox.internal.NativeObject

equals, hashCode

Methods inherited from class java.lang.Object

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

Method Detail

createDynamicObject

public static ChoiceField createDynamicObject(long handle)

addNewItem

public ChoiceItem addNewItem(java.lang.String displayName)

Creates a new choice item. The item is automatically added to the choice field's getItems().

Parameters:

displayName - this item's display name

Returns:

the newly created choice item

Throws:

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

java.lang.IllegalStateException - if the form field has widgets

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

getItems

public ChoiceItemList getItems()

The list of choice items (Getter)

Adding or removing items or clearing the list is not supported.

Throws:

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