Package com.pdf_tools.fourheights.pdftoolbox.pdf.forms

Class ComboBox

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

com.pdf_tools.fourheights.pdftoolbox.pdf.forms.ComboBox

public class ComboBox
extends ChoiceField

A combo box field

Method Summary

Modifier and Type	Method	Description
static ComboBox	create(Document targetDocument)	Create a combo box form field
boolean	getCanEdit()	Has an editable item (Getter)
ChoiceItem	getChosenItem()	The selected combo box item (Getter)
java.lang.String	getEditableItemName()	The name of the editable item (Getter)
void	setCanEdit(boolean value)	Has an editable item (Setter)
void	setChosenItem(ChoiceItem value)	The selected combo box item (Setter)
void	setEditableItemName(java.lang.String value)	The name of the editable item (Setter)

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

addNewItem, getItems

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

create

public static ComboBox create(Document targetDocument)

Create a combo 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 combo 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 pdftoolbox.pdf.Page.copy with an argument options in which pdftoolbox.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 pdftoolbox.pdf.Page.copy with an argument options in which pdftoolbox.pdf.PageCopyOptions.setUnsignedSignatures was set to pdftoolbox.pdf.CopyStrategy.COPY.

java.lang.IllegalArgumentException - if targetDocument is null

getCanEdit

public boolean getCanEdit()

Has an editable item (Getter)

Throws:

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

setCanEdit

public void setCanEdit(boolean value)

Has an editable item (Setter)

Throws:

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

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

getChosenItem

public ChoiceItem getChosenItem()

The selected combo box item (Getter)

If this property is null then the getEditableItemName() is the selected value. Setting this property automatically sets getEditableItemName() to null.

Throws:

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

setChosenItem

public void setChosenItem(ChoiceItem value)

The selected combo box item (Setter)

If this property is null then the getEditableItemName() is the selected value. Setting this property automatically sets getEditableItemName() to null.

Throws:

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

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

java.lang.IllegalArgumentException - if the provided choice item object does not belong to the combo box field

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

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

getEditableItemName

public java.lang.String getEditableItemName()

The name of the editable item (Getter)

This property is null if any of the combo box items is selected, i.e., if getChosenItem() is not null. Setting this property automatically sets getChosenItem() to null.

Throws:

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

setEditableItemName

public void setEditableItemName(java.lang.String value)

The name of the editable item (Setter)

This property is null if any of the combo box items is selected, i.e., if getChosenItem() is not null. Setting this property automatically sets getChosenItem() to null.

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 has no editable item (getCanEdit() property is false)

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

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