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

Interface IWDAbstractDropDown

All Superinterfaces:

IWDUIElement, IWDViewElement

All Known Subinterfaces:

IWDAbstractDropDownByIndex, IWDAbstractDropDownByKey, IWDDropDownByIndex, IWDDropDownByKey, IWDToolBarDropDownByIndex, IWDToolBarDropDownByKey

public interface IWDAbstractDropDown

extends IWDUIElement

Web Dynpro AbstractDropDown API. Abstract base class of drop-down list classes.

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

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

Field Summary

static String	DEFAULT_LABEL_FOR Default value of the labelFor property is "".
static boolean	DEFAULT_READ_ONLY Default value of the readOnly property is false.
static WDState	DEFAULT_STATE Default value of the state property is WDState.NORMAL.
static WDTextDirection	DEFAULT_TEXT_DIRECTION Default value of the textDirection property is WDTextDirection.INHERIT.
static String	DEFAULT_WIDTH Default value of the width property is "".

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

DEFAULT_ENABLED, DEFAULT_TOOLTIP, DEFAULT_VISIBLE

Method Summary

String	bindingOfReadOnly() Returns the binding path of the readOnly property.
String	bindingOfState() Returns the binding path of the state property.
String	bindingOfTextDirection() Returns the binding path of the textDirection property.
String	bindingOfWidth() Returns the binding path of the width property.
void	bindReadOnly(IWDAttributeInfo attributeInfo) Binds the readOnly property to the context attribute specified by the given attribute info.
void	bindReadOnly(String path) Binds the readOnly property to the context attribute specified by the given path.
void	bindState(IWDAttributeInfo attributeInfo) Binds the state property to the context attribute specified by the given attribute info.
void	bindState(String path) Binds the state property to the context attribute specified by the given path.
void	bindTextDirection(IWDAttributeInfo attributeInfo) Binds the textDirection property to the context attribute specified by the given attribute info.
void	bindTextDirection(String path) Binds the textDirection property to the context attribute specified by the given path.
void	bindWidth(IWDAttributeInfo attributeInfo) Binds the width property to the context attribute specified by the given attribute info.
void	bindWidth(String path) Binds the width property to the context attribute specified by the given path.
String	getLabelFor() Returns the value of the labelFor property.
boolean	getReadOnly() Returns the value of the readOnly property.
WDState	getState() Returns the value of the state property.
WDTextDirection	getTextDirection() Returns the value of the textDirection property.
String	getWidth() Returns the value of the width property.
void	setLabelFor(String labelFor) Sets the labelFor property to the given value.
void	setReadOnly(boolean value) Sets the readOnly property to the given value.
void	setState(WDState value) Sets the state property to the given value.
void	setTextDirection(WDTextDirection value) Sets the textDirection property to the given value.
void	setWidth(String value) Sets the width property to the given value.

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_LABEL_FOR

public static final String DEFAULT_LABEL_FOR

Default value of the labelFor property is "".

See Also:

Constant Field Values

DEFAULT_READ_ONLY

public static final boolean DEFAULT_READ_ONLY

Default value of the readOnly property is false.

See Also:

Constant Field Values

DEFAULT_STATE

public static final WDState DEFAULT_STATE

Default value of the state property is WDState.NORMAL.

DEFAULT_TEXT_DIRECTION

public static final WDTextDirection DEFAULT_TEXT_DIRECTION

Default value of the textDirection property is WDTextDirection.INHERIT.

DEFAULT_WIDTH

public static final String DEFAULT_WIDTH

Default value of the width property is "".

See Also:

Constant Field Values

Method Detail

getLabelFor

public String getLabelFor()

Returns the value of the labelFor property. The initial value is "". Determines the ID of the labelled component.

Returns:

the value of the labelFor property

See Also:

setLabelFor(String)

setLabelFor

public void setLabelFor(String labelFor)

Sets the labelFor property to the given value.

Parameters:

labelFor - the new value of the labelFor property

See Also:

getLabelFor()

bindReadOnly

public void bindReadOnly(String path)

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

Parameters:

path - the context path of the attribute to which the readOnly property will be bound

bindReadOnly

public void bindReadOnly(IWDAttributeInfo attributeInfo)

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

Parameters:

attributeInfo - the info of the context attribute to which the readOnly property will be bound

bindingOfReadOnly

public String bindingOfReadOnly()

Returns the binding path of the readOnly property.

Returns:

the path of the context attribute to which the readOnly property is currently bound

getReadOnly

public boolean getReadOnly()

Returns the value of the readOnly property.

The initial value is false.

Controls if the user can change the selection of the drop-down list.

Returns:

the current value of the readOnly property

See Also:

setReadOnly(boolean)

setReadOnly

public void setReadOnly(boolean value)

Sets the readOnly property to the given value.

Parameters:

value - the new value of the readOnly property

See Also:

getReadOnly()

bindState

public void bindState(String path)

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

Parameters:

path - the context path of the attribute to which the state property will be bound

bindState

public void bindState(IWDAttributeInfo attributeInfo)

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

Parameters:

attributeInfo - the info of the context attribute to which the state property will be bound

bindingOfState

public String bindingOfState()

Returns the binding path of the state property.

Returns:

the path of the context attribute to which the state property is currently bound

getState

public WDState getState()

Returns the value of the state property.

The initial value is WDState.NORMAL.

The state of the drop-down list. The state required isn't visualized at the ToolBarDrop UIElement in the ToolBar.

Returns:

the current value of the state property

See Also:

setState(WDState)

setState

public void setState(WDState value)

Sets the state property to the given value.

Parameters:

value - the new value of the state property

See Also:

getState()

bindTextDirection

public void bindTextDirection(String path)

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

Parameters:

path - the context path of the attribute to which the textDirection property will be bound

bindTextDirection

public void bindTextDirection(IWDAttributeInfo attributeInfo)

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

Parameters:

attributeInfo - the info of the context attribute to which the textDirection property will be bound

bindingOfTextDirection

public String bindingOfTextDirection()

Returns the binding path of the textDirection property.

Returns:

the path of the context attribute to which the textDirection property is currently bound

getTextDirection

public WDTextDirection getTextDirection()

Returns the value of the textDirection property.

The initial value is WDTextDirection.INHERIT.

Determines the direction of displayed text.

Returns:

the current value of the textDirection property

See Also:

setTextDirection(WDTextDirection)

setTextDirection

public void setTextDirection(WDTextDirection value)

Sets the textDirection property to the given value.

Parameters:

value - the new value of the textDirection property

See Also:

getTextDirection()

bindWidth

public void bindWidth(String path)

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

Parameters:

path - the context path of the attribute to which the width property will be bound

bindWidth

public void bindWidth(IWDAttributeInfo attributeInfo)

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

Parameters:

attributeInfo - the info of the context attribute to which the width property will be bound

bindingOfWidth

public String bindingOfWidth()

Returns the binding path of the width property.

Returns:

the path of the context attribute to which the width property is currently bound

getWidth

public String getWidth()

Returns the value of the width property.

The initial value is "".

Determines the width of the drop-down list box. This must be an integer value interpreted as pixels!

Returns:

the current value of the width property

See Also:

setWidth(String)

setWidth

public void setWidth(String value)

Sets the width property to the given value.

Parameters:

value - the new value of the width property

See Also:

getWidth()