com.sap.tc.webdynpro.clientserver.uielib.standard.api
Interface IWDAbstractDropDownByKey

All Superinterfaces:

IWDAbstractDropDown, IWDUIElement, IWDViewElement

All Known Subinterfaces:

IWDDropDownByKey, IWDToolBarDropDownByKey

public interface IWDAbstractDropDownByKey

extends IWDAbstractDropDown

Web Dynpro AbstractDropDownByKey API. Abstract base class of drop-down list classes with key based context binding. Represents a one-from-many selection visualized by a text field, a button and a drop-down list. The selected value is displayed in the text field, the list of all selectable values is displayed in the drop-down list which appears when the button is pressed.

Data binding:
The set of selectable keys, displayed texts and the selected key are retrieved from a context. This context must provide an attribute y of a type having a value set. The selectable keys of the drop-down list are the keys of this value set, the displayed texts are the corresponding values. The currently selected key is the current value of the attribute y.

The property selectedKey must be bound to the attribute y.

This type can be called by applications using Web Dynpro, but DO NOT EXTEND OR IMPLEMENT IT!

See Also:

ISimpleType, ISimpleValueSet

Fields inherited from interface com.sap.tc.webdynpro.clientserver.uielib.standard.api.IWDAbstractDropDown

DEFAULT_READ_ONLY, DEFAULT_STATE, DEFAULT_TEXT_DIRECTION, DEFAULT_WIDTH

Fields inherited from interface com.sap.tc.webdynpro.progmodel.api.IWDUIElement

DEFAULT_ENABLED, DEFAULT_TOOLTIP, DEFAULT_VISIBLE

Method Summary

java.lang.String	bindingOfSelectedKey() Note: This property must be bound to the context! Binding path of property selectedKey.
void	bindSelectedKey(IWDAttributeInfo attributeInfo) Note: This property must be bound to the context! Binds property selectedKey to the context attribute specified by the given attribute info.
void	bindSelectedKey(java.lang.String path) Note: This property must be bound to the context! Binds property selectedKey to the context attribute specified by path.
IWDAction	getOnSelect() Returns the action to which the event onSelect is mapped.
java.lang.String	getSelectedKey() Note: This property must be bound to the context! Returns the value of the selectedKey property.
IWDParameterMapping	mappingOfOnSelect() Returns the parameter mapping of event onSelect.
void	setOnSelect(IWDAction action) Maps the event onSelect to the given action.
void	setSelectedKey(java.lang.String value) Note: This property must be bound to the context! Sets property selectedKey to the new value.

Methods inherited from interface com.sap.tc.webdynpro.clientserver.uielib.standard.api.IWDAbstractDropDown

bindingOfReadOnly, bindingOfState, bindingOfTextDirection, bindingOfWidth, bindReadOnly, bindReadOnly, bindState, bindState, bindTextDirection, bindTextDirection, bindWidth, bindWidth, getReadOnly, getState, getTextDirection, getWidth, setReadOnly, setState, setTextDirection, setWidth

Methods inherited from interface com.sap.tc.webdynpro.progmodel.api.IWDUIElement

bindEnabled, bindEnabled, bindingOfEnabled, bindingOfTooltip, bindingOfVisible, bindTooltip, bindTooltip, bindVisible, bindVisible, createLayoutData, getContainer, getEnabled, getLayoutData, getTooltip, getVisible, setEnabled, setTooltip, setVisible

Methods inherited from interface com.sap.tc.webdynpro.progmodel.api.IWDViewElement

getId, getView, requestFocus

Method Detail

getOnSelect

public IWDAction getOnSelect()

Returns the action to which the event onSelect is mapped. The action performed when the selection of this drop-down list box is changed. Event parameter is the key of the new selected entry.

Returns:

the action to which the event is mapped

See Also:

mappingOfOnSelect()

setOnSelect

public void setOnSelect(IWDAction action)

Maps the event onSelect to the given action.

Parameters:

action - the action for the event

See Also:

getOnSelect()

mappingOfOnSelect

public IWDParameterMapping mappingOfOnSelect()

Returns the parameter mapping of event onSelect.

To be accessible in a view controller, a UI element event parameter has to be mapped to a controller event handler parameter. This is done by defining a parameter mapping.

Event parameters:

• String key - The key of the new selected entry.

Returns:

parameter mapping list.

See Also:

getOnSelect()

bindSelectedKey

public void bindSelectedKey(java.lang.String path)

Note: This property must be bound to the context! Binds property selectedKey to the context attribute specified by path.

Parameters:

path - the path of the context attribute to which the selectedKey property is bound

bindSelectedKey

public void bindSelectedKey(IWDAttributeInfo attributeInfo)

Note: This property must be bound to the context! Binds property selectedKey to the context attribute specified by the given attribute info.

Parameters:

attributeInfo - the info of the context attribute to which the selectedKey property is bound

bindingOfSelectedKey

public java.lang.String bindingOfSelectedKey()

Note: This property must be bound to the context! Binding path of property selectedKey.

Returns:

the path of the context attribute to which the selectedKey is currently bound

getSelectedKey

public java.lang.String getSelectedKey()

Note: This property must be bound to the context! Returns the value of the selectedKey property. The initial value is "". The key from the value set that defines the drop-down list's selection.

Returns:

the current value of the selectedKey property

See Also:

setSelectedKey(String)

setSelectedKey

public void setSelectedKey(java.lang.String value)

Note: This property must be bound to the context! Sets property selectedKey to the new value.

Parameters:

value - the new value of the selectedKey property

See Also:

getSelectedKey()