Package com.itextpdf.forms.form.element
Class SelectFieldItem
java.lang.Object
com.itextpdf.forms.form.element.SelectFieldItem
A field that represents a control for selecting one of the provided options.
It is used in the
ComboBoxField
class.-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate final String
The display value of the item.private final String
The export value of the item.private final IBlockElement
The option element of the item. -
Constructor Summary
ConstructorsConstructorDescriptionSelectFieldItem
(String value) Create a newSelectFieldItem
.SelectFieldItem
(String value, IBlockElement optionElement) Create a newSelectFieldItem
.SelectFieldItem
(String exportValue, String displayValue) Create a newSelectFieldItem
.SelectFieldItem
(String exportValue, String displayValue, IBlockElement optionElement) Create a newSelectFieldItem
. -
Method Summary
Modifier and TypeMethodDescriptionGet the display value of the item.Get the option element of the item.Get the export value of the item.boolean
Check if the item has a display value.private void
setLabel()
-
Field Details
-
exportValue
The export value of the item. this is the value of the form which will be submitted. If the display value is not set, the export value will be used as display value. -
displayValue
The display value of the item. This is the value which will be displayed in the dropdown. -
optionElement
The option element of the item. This is the element which will be displayed in the dropdown. It allows for customization
-
-
Constructor Details
-
SelectFieldItem
Create a newSelectFieldItem
.- Parameters:
exportValue
- the export value of the item.displayValue
- the display value of the item.
-
SelectFieldItem
Create a newSelectFieldItem
.- Parameters:
value
- the export value of the item.
-
SelectFieldItem
Create a newSelectFieldItem
.- Parameters:
value
- the export value of the item.optionElement
- the option element of the item.
-
SelectFieldItem
Create a newSelectFieldItem
.- Parameters:
exportValue
- the export value of the item.displayValue
- the display value of the item.optionElement
- the option element of the item.
-
-
Method Details
-
getExportValue
Get the export value of the item.- Returns:
- export value.
-
getDisplayValue
Get the display value of the item. If the display value is not set, the export value will be used as display value.- Returns:
- display value.
-
getElement
Get the option element of the item.This is the element which will be displayed in the dropdown. It allows for customization.
- Returns:
- option element.
-
hasExportAndDisplayValues
public boolean hasExportAndDisplayValues()Check if the item has a display value. and export value.- Returns:
true
if the item has both export and display values,false
otherwise.
-
setLabel
private void setLabel()
-