DropDownByKey API
Definition
|
A DropDownByKey UI element provides the user with a selection list from which he or she can select no more than one entry. The UI element consists of a text field, a button, and a selection list. Any list entry already selected is displayed in the text field. When you select the pushbutton, a list with all possible values is displayed. The dropdown list box UI elements do not differ from each other when displayed on the screen. However, the data binding model for the DropDownByKey UI element has a completely different concept. See Data Binding Within Web Dynpro and Data Binding of a Dropdown List Box and Radio Button Group).
|
Visual Display
|
When using a dropdown list box, always display this UI element alongside a Label UI element (that is, an element with a label) to ensure accessibility.
Description of UI Element Properties
·
labelFor
The DropDownByKey element can
also be used as a label for other UI elements. You can use the labelFor property to reference to a
UI element.
·
selectedKey
Use this property to
determine the value from the value set, which is to be selected from the list
of the dropdown listbox.
·
size
This property is deprecated and can no longer be used.
Overview of Inherited and Additional Properties
Name |
Interface |
Type |
Initial Value |
Bindable |
Value Required |
enabled |
IWDUIElement |
boolean |
true |
bindable |
No |
labelFor |
IWDAbstractDropDown |
String |
|
not_bindable |
No |
readOnly |
IWDAbstractDropDown |
boolean |
false |
bindable |
No |
selectedKey |
IWDAbstractDropDownByKey |
String |
|
bindable_mandatory |
Yes |
size |
IWDDropDownByKey |
WDDropDownListBoxSize |
standard |
bindable |
No |
state |
IWDAbstractDropDown |
WDState |
normal |
bindable |
No |
textDirection |
IWDAbstractDropDown |
WDTextDirection |
inherit |
bindable |
No |
tooltip |
IWDUIElement |
String (TranslatableText) |
|
bindable |
No |
visible |
IWDUIElement |
WDVisibility |
visible |
bindable |
No |
width |
IWDAbstractDropDown |
String |
|
bindable |
No |
Events
·
onSelect
This property can assign the
action to be executed when the user selects a list entry from the dropdown
list box.
Event Parameter |
Type |
Description |
key |
String |
Key of the selected entry. |
Data Binding
For further information, refer to Data Binding of a Dropdown List Box and Radio Button Group. For a code example, refer to Key Binding.