Package com.itextpdf.forms.form.element

Class ComboBoxField

java.lang.Object

com.itextpdf.commons.actions.sequence.AbstractIdentifiableElement

com.itextpdf.layout.ElementPropertyContainer

com.itextpdf.layout.element.AbstractElement

com.itextpdf.forms.form.element.FormField<AbstractSelectField>

com.itextpdf.forms.form.element.AbstractSelectField

com.itextpdf.forms.form.element.ComboBoxField

All Implemented Interfaces:

IFormField, IAbstractElement, IBlockElement, IElement, IPropertyContainer, IAccessibleElement

       public class ComboBoxField extends AbstractSelectField
      

A field that represents a control for selecting one of the provided options.

Field Summary

Fields inherited from class com.itextpdf.forms.form.element.AbstractSelectField

options

Fields inherited from class com.itextpdf.forms.form.element.FormField

tagProperties

Fields inherited from class com.itextpdf.layout.element.AbstractElement

childElements, nextRenderer, styles

Fields inherited from class com.itextpdf.layout.ElementPropertyContainer

properties

Constructor Summary

Constructors

Constructor	Description
ComboBoxField(String id)	Creates a new select field box.

Method Summary

Modifier and Type	Method	Description
void	addOption(SelectFieldItem option)	Add an option to the element.
AccessibilityProperties	getAccessibilityProperties()	Gets the accessibility properties.
String	getSelectedExportValue()	Gets the export value of the selected option.
SelectFieldItem	getSelectedOption()	Gets the selected option.
protected IRenderer	makeNewRenderer()	Creates a new renderer instance.
ComboBoxField	setSelected(int index)	Selects an option by its index.
ComboBoxField	setSelected(SelectFieldItem item)	Selects an option by its value.
ComboBoxField	setSelected(String value)	Selects an option by its export value.

Methods inherited from class com.itextpdf.forms.form.element.AbstractSelectField

addOption, getOption, getOptions, hasExportAndDisplayValues, hasOptions, optionsCount

Methods inherited from class com.itextpdf.forms.form.element.FormField

getDefaultProperty, getId, setAlternativeDescription, setHeight, setInteractive, setSize, setValue, setWidth

Methods inherited from class com.itextpdf.layout.element.AbstractElement

addStyle, createRendererSubTree, getChildren, getProperty, getRenderer, hasProperty, isEmpty, setAction, setNextRenderer, setPageNumber

Methods inherited from class com.itextpdf.layout.ElementPropertyContainer

deleteOwnProperty, getOwnProperty, getSplitCharacters, getStrokeColor, getStrokeWidth, getTextRenderingMode, getTransparentStrokeColor, hasOwnProperty, setBackgroundColor, setBackgroundColor, setBackgroundColor, setBackgroundColor, setBackgroundImage, setBackgroundImage, setBaseDirection, setBorder, setBorderBottom, setBorderBottomLeftRadius, setBorderBottomRightRadius, setBorderLeft, setBorderRadius, setBorderRight, setBorderTop, setBorderTopLeftRadius, setBorderTopRightRadius, setCharacterSpacing, setDashPattern, setDestination, setFixedPosition, setFixedPosition, setFixedPosition, setFixedPosition, setFont, setFontColor, setFontColor, setFontColor, setFontFamily, setFontFamily, setFontKerning, setFontScript, setFontSize, setHorizontalAlignment, setHyphenation, setLineThrough, setOpacity, setProperty, setRelativePosition, setSplitCharacters, setStrokeColor, setStrokeColor, setStrokeColor, setStrokeWidth, setTextAlignment, setTextRenderingMode, setUnderline, setUnderline, setUnderline, setUnderline, setUnderline, setWordSpacing, simulateBold, simulateItalic

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.itextpdf.layout.element.IAbstractElement

getChildren

Methods inherited from interface com.itextpdf.layout.element.IElement

createRendererSubTree, getRenderer, setNextRenderer

Methods inherited from interface com.itextpdf.layout.IPropertyContainer

deleteOwnProperty, getOwnProperty, getProperty, hasOwnProperty, hasProperty, setProperty

Constructor Details

ComboBoxField

             public ComboBoxField
             (String id)
            

Creates a new select field box.

Parameters:

id - the id

Method Details

getSelectedExportValue

             public String getSelectedExportValue()
            

Gets the export value of the selected option.

Returns:

the export value of the selected option. This may be null if no value has been selected.

setSelected

             public ComboBoxField setSelected
             (int index)
            

Selects an option by its index. The index is zero-based.

Parameters:

index - the index of the option to select.

Returns:

this ComboBoxField instance.

Throws:

IndexOutOfBoundsException - if the index is out of bounds.

setSelected

             public ComboBoxField setSelected
             (String value)
            

Selects an option by its export value.

Parameters:

value - the export value of the option to select.

Returns:

this ComboBoxField instance.

setSelected

             public ComboBoxField setSelected
             (SelectFieldItem item)
            

Selects an option by its value. This will use the export value of the option to match it to existing options.

Parameters:

item - the option to select.

Returns:

this ComboBoxField instance.

addOption

             public void addOption
             (SelectFieldItem option)
            

Add an option to the element.

Overrides:

addOption in class AbstractSelectField

Parameters:

option - a SelectFieldItem.

getSelectedOption

             public SelectFieldItem getSelectedOption()
            

Gets the selected option.

Returns:

the selected option. This may be null if no option has been selected.

getAccessibilityProperties

             public AccessibilityProperties getAccessibilityProperties()
            

Gets the accessibility properties. See also IAccessibleElement.

Returns:

an interface that allows to specify properties of a tagged element in Tagged PDF.

makeNewRenderer

             protected IRenderer makeNewRenderer()
            

Description copied from class: AbstractElement

Creates a new renderer instance.

Specified by:

makeNewRenderer in class AbstractElement<AbstractSelectField>

Returns:

new IRenderer