Class ListBoxField

java.lang.Object

com.itextpdf.commons.actions.sequence.AbstractIdentifiableElement

com.itextpdf.layout.ElementPropertyContainer<AbstractSelectField>

com.itextpdf.layout.element.AbstractElement<AbstractSelectField>

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

com.itextpdf.forms.form.element.AbstractSelectField

com.itextpdf.forms.form.element.ListBoxField

All Implemented Interfaces:

IFormField, IAbstractElement, IBlockElement, IElement, IPropertyContainer, IAccessibleElement

public class ListBoxField
extends AbstractSelectField

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

Field Summary

Fields inherited from class AbstractSelectField

options

Fields inherited from class FormField

tagProperties

Fields inherited from class AbstractElement

childElements, nextRenderer, styles

Fields inherited from class ElementPropertyContainer

properties

Constructor Summary

Constructors

Constructor	Description
ListBoxField(String id, int size, boolean allowMultipleSelection)	Create a new list box field.

Method Summary

Modifier and Type	Method	Description
ListBoxField	addOption(String option)	Add an option for ListBoxField.
ListBoxField	addOption(String option, boolean selected)	Add an option for ListBoxField.
AccessibilityProperties	getAccessibilityProperties()	Gets the accessibility properties.
<T1> T1	getDefaultProperty(int property)	Gets the default property from this entity.
List<String>	getSelectedStrings()	Get a list of selected options.
protected IRenderer	makeNewRenderer()	Creates a new renderer instance.
ListBoxField	setTopIndex(int topIndex)	Sets the index of the first visible option in a scrollable list.

Methods inherited from class AbstractSelectField

addOption, addOption, getOption, getOptions, hasExportAndDisplayValues, hasOptions, optionsCount

Methods inherited from class FormField

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

Methods inherited from class AbstractElement

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

Methods inherited from class 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 Object

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

Methods inherited from interface IAbstractElement

getChildren

Methods inherited from interface IElement

createRendererSubTree, getRenderer, setNextRenderer

Methods inherited from interface IPropertyContainer

deleteOwnProperty, getOwnProperty, getProperty, hasOwnProperty, hasProperty, setProperty

Constructor Details

ListBoxField

public ListBoxField(String id,
 int size,
 boolean allowMultipleSelection)

Create a new list box field.

Parameters:

id - the id

size - the size of the list box, which will define the height of visible properties, shall be greater than zero

allowMultipleSelection - a boolean flag that defines whether multiple options are allowed to be selected at once

Method Details

getDefaultProperty

public <T1> T1 getDefaultProperty(int property)

Description copied from class: FormField

Gets the default property from this entity.

Specified by:

getDefaultProperty in interface IPropertyContainer

Overrides:

getDefaultProperty in class FormField<AbstractSelectField>

Type Parameters:

T1 - the return type associated with the property

Parameters:

property - the property to be retrieved

Returns:

the default property value. If the default property is not defined, null will be returned

addOption

public ListBoxField addOption(String option)

Add an option for ListBoxField. The option is not selected.

Parameters:

option - string representation of the option.

Returns:

this ListBoxField.

addOption

public ListBoxField addOption(String option,
 boolean selected)

Add an option for ListBoxField.

Parameters:

option - string representation of the option.

selected - true is the option if selected, false otherwise.

Returns:

this ListBoxField.

getSelectedStrings

public List<String> getSelectedStrings()

Get a list of selected options.

Returns:

a list of display values of selected options.

setTopIndex

public ListBoxField setTopIndex(int topIndex)

Sets the index of the first visible option in a scrollable list.

Parameters:

topIndex - the index of the first option

Returns:

this ListBoxField instance

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