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

Interface IWDDropDownByIndex

All Superinterfaces:
IWDAbstractDropDown, IWDAbstractDropDownByIndex, IWDTableCellEditor, IWDTableMarkableCellEditor, IWDUIElement, IWDViewElement

public interface IWDDropDownByIndex
extends IWDAbstractDropDownByIndex, IWDTableCellEditor, IWDTableMarkableCellEditor

Web Dynpro DropDownByIndex API. A drop-down list that uses index based context binding.

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

Type Classification Type Classification:

This interface is part of the Web Dynpro API, so applications may reference it or call any method of it, but they must not implement or extend it.

For a detailed explanation of API classification see the Web Dynpro Compatibility Guide

Nested Class Summary
 
Nested classes inherited from class com.sap.tc.webdynpro.clientserver.uielib.standard.api.IWDAbstractDropDownByIndex
IWDAbstractDropDownByIndex.IWDOnSelect
 
Field Summary
static String DEFAULT_EXPLANATION
          Default value of the explanation property is "".
static WDDropDownListBoxSize DEFAULT_SIZE
          Default value of the size property is WDDropDownListBoxSize.STANDARD.
 
Fields inherited from interface com.sap.tc.webdynpro.clientserver.uielib.standard.api.IWDAbstractDropDownByIndex
DEFAULT_SELECTION_CHANGE_BEHAVIOUR
 
Fields inherited from interface com.sap.tc.webdynpro.clientserver.uielib.standard.api.IWDAbstractDropDown
DEFAULT_LABEL_FOR, 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
 String bindingOfSize()
          Deprecated. This property may be withdrawn with the first new NetWeaver release in 2006 as it is no longer needed. Small UIElements are not supported anymore.
 void bindSize(IWDAttributeInfo attributeInfo)
          Deprecated. This property may be withdrawn with the first new NetWeaver release in 2006 as it is no longer needed. Small UIElements are not supported anymore.
 void bindSize(String path)
          Deprecated. This property may be withdrawn with the first new NetWeaver release in 2006 as it is no longer needed. Small UIElements are not supported anymore.
 String getExplanation()
          Returns the value of the explanation property.
 WDDropDownListBoxSize getSize()
          Deprecated. This property may be withdrawn with the first new NetWeaver release in 2006 as it is no longer needed. Small UIElements are not supported anymore.
 void setExplanation(String explanation)
          Sets the explanation property to the given value.
 void setSize(WDDropDownListBoxSize value)
          Deprecated. This property may be withdrawn with the first new NetWeaver release in 2006 as it is no longer needed. Small UIElements are not supported anymore.
 
Methods inherited from interface com.sap.tc.webdynpro.clientserver.uielib.standard.api.IWDAbstractDropDownByIndex
bindingOfTexts, bindTexts, bindTexts, getOnSelect, getSelectionChangeBehaviour, mappingOfOnSelect, setOnSelect, setSelectionChangeBehaviour
 
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, getLabelFor, getReadOnly, getState, getTextDirection, getWidth, setLabelFor, 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
destroy, getId, getView, requestFocus
 

Field Detail

DEFAULT_EXPLANATION

public static final String DEFAULT_EXPLANATION
Default value of the explanation property is "".

See Also:
Constant Field Values

DEFAULT_SIZE

public static final WDDropDownListBoxSize DEFAULT_SIZE
Default value of the size property is WDDropDownListBoxSize.STANDARD.

Method Detail

getExplanation

public String getExplanation()
Returns the value of the explanation property. The initial value is "". Determines the explanation text for this control. The explanation should be maintained by documentation developers in the development environment.

The explanation is visualized at the connected label of this UIElement. Without a label the explanation isn't displayed and can't be accessed.

Returns:
the value of the explanation property
See Also:
setExplanation(String)

setExplanation

public void setExplanation(String explanation)
Sets the explanation property to the given value.

Parameters:
explanation - the new value of the explanation property
See Also:
getExplanation()

bindSize

public void bindSize(String path)
Deprecated. This property may be withdrawn with the first new NetWeaver release in 2006 as it is no longer needed. Small UIElements are not supported anymore.

Binds the size property to the context attribute specified by the given path.

Parameters:
path - the context path of the attribute to which the size property will be bound

bindSize

public void bindSize(IWDAttributeInfo attributeInfo)
Deprecated. This property may be withdrawn with the first new NetWeaver release in 2006 as it is no longer needed. Small UIElements are not supported anymore.

Binds the size property to the context attribute specified by the given attribute info.

Parameters:
attributeInfo - the info of the context attribute to which the size property will be bound

bindingOfSize

public String bindingOfSize()
Deprecated. This property may be withdrawn with the first new NetWeaver release in 2006 as it is no longer needed. Small UIElements are not supported anymore.

Returns the binding path of the size property.

Returns:
the path of the context attribute to which the size property is currently bound

getSize

public WDDropDownListBoxSize getSize()
Deprecated. This property may be withdrawn with the first new NetWeaver release in 2006 as it is no longer needed. Small UIElements are not supported anymore.

Returns the value of the size property.

The initial value is WDDropDownListBoxSize.STANDARD.

The symbolic size of the drop-down list box.

Returns:
the current value of the size property
See Also:
setSize(WDDropDownListBoxSize)

setSize

public void setSize(WDDropDownListBoxSize value)
Deprecated. This property may be withdrawn with the first new NetWeaver release in 2006 as it is no longer needed. Small UIElements are not supported anymore.

Sets the size property to the given value.

Parameters:
value - the new value of the size property
See Also:
getSize()


Copyright 2006 SAP AG Complete Copyright Notice