Web Dynpro DropDownByIndex API - IWDDropDownByIndex (SAP Library

Web Dynpro DropDownByIndex API - IWDDropDownByIndex

Definition

A DropDownByIndex UI element provides the user with a dropdown list box. You cannot select more than one entry from the selection list. The UI element consists of a text field, a button, and a selection list. An already selected list entry is displayed in the text field. When selecting the button, a list with all possible values is displayed.

Display

This graphic is explained in the accompanying text

Use

For further information about the use of the dropdown list box using index binding, refer to the description of the Web Dynpro AbstractDropDown API.

Note

When using a dropdown list box, always display this UI element alongside a label to ensure accessibility.

Description of the UI Element Properties

· size
Specifies the display size of the list. The size property can be filled with the following values and is represented by the enumeration type WDDropDownListBoxSize.

small	The UI element is displayed in a small font.
standard	A default size is displayed.

Note

Additional properties are defined in the corresponding superior classes. Refer to:
IWDAbstractDropDownByIndex, IWDAbstractDropDown, IWDUIElement, IWDViewElement.

Overview of Inherited and Additional Properties

Name	Interface	Type	Initial Value	Bindable	Value Required
enabled	IWDUIElement	boolean	true	bindable	No
readOnly	IWDAbstractDropDown	boolean	false	bindable	No
size	IWDDropDownByIndex	WDDropDownListBoxSize	standard	bindable	No
state	IWDAbstractDropDown	WDState	normal	bindable	No
texts	IWDAbstractDropDownByIndex	String		bindable_mandatory	Yes
tooltip	IWDUIElement	String (TranslatableText)		bindable	No
visible	IWDUIElement	WDVisibility	visible	bindable	No
width	IWDAbstracDropDown	String		bindable	No

Events

See Web Dynpro IWDAbstractDropDownByIndex API.

Data Binding

See Web Dynpro IWDAbstractDropDownByIndex API.

For further information, refer to Structure link Data Binding of a Dropdown List Box and Radio Button Group and Code Examples of Data Binding.

Mobile Characteristics

The UI element DropDownByIndex supports the development of mobile applications for pocket PCs and BlackBerry wireless handhelds (see Mobile Web Dynpro). For BlackBerry wireless handhelds, the dropdown list box is displayed as a WML tag <select>.

However, several properties supported in the desktop browser cannot be used. These include:

Variances of the properties

Properties	Pocket PC	BlackBerry wireless handheld
enabled	ignored	ignored
size	ignored	ignored
state	ignored	ignored
tooltip	ignored	ignored
width	ignored	ignored

Methods in the IWDDropDownByIndex API

Method Name	Parameter	Return Value	Short Description
bindingOfSize		String	Returns the path of the context element to which the size property is bound. Returns NULL if no binding exists.
bindSize	(String path)		Binds the size property to the context node specified by a path.
getSize		WDDropDownListBoxSize	Returns the value of the size property.
setSize	(WDDropDownListBoxSize value)		Sets the value of the size property.

Additional methods described in the following APIs are available using inheritance: IWDAbstractDropDownByIndex, IWDAbstractDropDown, IWDUIElement, IWDViewElement.

Note

For detailed documentation of all inherited methods, see the documentation for the relevant APIs.