Web Dynpro API Documentation

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

All Superinterfaces:
IWDAbstractDropDown, IWDUIElement, IWDViewElement
All Known Subinterfaces:
IWDDropDownByIndex, IWDToolBarDropDownByIndex

public interface IWDAbstractDropDownByIndex
extends IWDAbstractDropDown

Web Dynpro AbstractDropDownByIndex API. Abstract base class of drop-down list classes with index 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 displayed texts and the selection are retrieved from a context. The context must provide a node X with X.cardinality = 0..n with an attribute y of type String. The selectable values are the values of attribute y of the node elements. The selected value is determined by the lead selection of node X.

The property texts must be bound to the attribute y.

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


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 bindingOfTexts()
          Note: This property must be bound to the context! Binding path of property texts.
 void bindTexts(IWDAttributeInfo attributeInfo)
          Note: This property must be bound to the context! Binds property texts to the context attribute specified by the given attribute info.
 void bindTexts(java.lang.String path)
          Note: This property must be bound to the context! Binds property texts to the context attribute specified by path.
 IWDAction getOnSelect()
          Returns the action to which the event onSelect is mapped.
 IWDParameterMapping mappingOfOnSelect()
          Returns the parameter mapping of event onSelect.
 void setOnSelect(IWDAction action)
          Maps the event onSelect to the given action.
 
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 the drop-down list box is changed. Event parameter is the zero based index of the new selected value.
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:
Returns:
parameter mapping list.
See Also:
getOnSelect()

bindTexts

public void bindTexts(java.lang.String path)
Note: This property must be bound to the context! Binds property texts to the context attribute specified by path.
Parameters:
path - the path of the context attribute to which the texts property is bound

bindTexts

public void bindTexts(IWDAttributeInfo attributeInfo)
Note: This property must be bound to the context! Binds property texts to the context attribute specified by the given attribute info.
Parameters:
attributeInfo - the info of the context attribute to which the texts property is bound

bindingOfTexts

public java.lang.String bindingOfTexts()
Note: This property must be bound to the context! Binding path of property texts.
Returns:
the path of the context attribute to which the texts is currently bound

Web Dynpro API Documentation

Copyright © 2004 SAP AG. Automatically generated Thu Mar 3 2005, 22:15