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

Interface IWDScrollContainer

All Superinterfaces:

IWDUIElement, IWDUIElementContainer, IWDViewElement

All Known Subinterfaces:

IWDGroup, IWDTransparentContainer, IWDTray

public interface IWDScrollContainer

extends IWDUIElementContainer

Web Dynpro ScrollContainer API. ScrollContainer is a container that may scroll its content. The properties height and width must be specified for the ScrollContainer UI element - that is, you must assign values to these properties for the scrolling modes both and auto. If you do not want to have scroll bars for the UI element and assign the value none to the scrollingMode property, you should use another container UI element - for example, the TransparentContainer UI element.

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_ACCESSIBILITY_DESCRIPTION Default value of the accessibilityDescription property is "".
static String	DEFAULT_DEFAULT_BUTTON_ID Default value of the defaultButtonId property is "".
static WDScrollingMode	DEFAULT_SCROLLING_MODE Default value of the scrollingMode property is WDScrollingMode.NONE.

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

DEFAULT_HEIGHT, DEFAULT_WIDTH

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

DEFAULT_ENABLED, DEFAULT_TOOLTIP, DEFAULT_VISIBLE

Method Summary

void	bindAccessibilityDescription(IWDAttributeInfo attributeInfo) Binds the accessibilityDescription property to the context attribute specified by the given attribute info.
void	bindAccessibilityDescription(String path) Binds the accessibilityDescription property to the context attribute specified by the given path.
void	bindDefaultButtonId(IWDAttributeInfo attributeInfo) Binds the defaultButtonId property to the context attribute specified by the given attribute info.
void	bindDefaultButtonId(String path) Binds the defaultButtonId property to the context attribute specified by the given path.
String	bindingOfAccessibilityDescription() Returns the binding path of the accessibilityDescription property.
String	bindingOfDefaultButtonId() Returns the binding path of the defaultButtonId property.
String	bindingOfScrollingMode() Returns the binding path of the scrollingMode property.
void	bindScrollingMode(IWDAttributeInfo attributeInfo) Binds the scrollingMode property to the context attribute specified by the given attribute info.
void	bindScrollingMode(String path) Binds the scrollingMode property to the context attribute specified by the given path.
String	getAccessibilityDescription() Returns the value of the accessibilityDescription property.
IWDUIElement	getCustomExtensionField(IWDAttributeInfo customExtensionField) Returns the UI element for the custom extension field identified by the given attribute info.
IWDLabel	getCustomExtensionLabel(IWDAttributeInfo customExtensionField) Returns the label for the custom extension field identified by the given attribute info.
String	getDefaultButtonId() Returns the value of the defaultButtonId property.
WDScrollingMode	getScrollingMode() Returns the value of the scrollingMode property.
void	setAccessibilityDescription(String value) Sets the accessibilityDescription property to the given value.
void	setDefaultButtonId(String value) Sets the defaultButtonId property to the given value.
void	setScrollingMode(WDScrollingMode value) Sets the scrollingMode property to the given value.

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

addChild, addChild, bindHeight, bindHeight, bindingOfHeight, bindingOfWidth, bindWidth, bindWidth, createLayout, destroyAllChildren, getChild, getChildren, getHeight, getLayout, getWidth, hasChildren, indexOfChild, iterateChildren, numberOfChildren, removeAllChildren, removeChild, removeChild, setHeight, setWidth, swapChildren

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_ACCESSIBILITY_DESCRIPTION

public static final String DEFAULT_ACCESSIBILITY_DESCRIPTION

Default value of the accessibilityDescription property is "".

See Also:

Constant Field Values

DEFAULT_DEFAULT_BUTTON_ID

public static final String DEFAULT_DEFAULT_BUTTON_ID

Default value of the defaultButtonId property is "".

See Also:

Constant Field Values

DEFAULT_SCROLLING_MODE

public static final WDScrollingMode DEFAULT_SCROLLING_MODE

Default value of the scrollingMode property is WDScrollingMode.NONE.

Method Detail

bindAccessibilityDescription

public void bindAccessibilityDescription(String path)

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

Parameters:

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

bindAccessibilityDescription

public void bindAccessibilityDescription(IWDAttributeInfo attributeInfo)

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

Parameters:

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

bindingOfAccessibilityDescription

public String bindingOfAccessibilityDescription()

Returns the binding path of the accessibilityDescription property.

Returns:

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

getAccessibilityDescription

public String getAccessibilityDescription()

Returns the value of the accessibilityDescription property.

The initial value is "".

Short description for the container (substitute for a title) in accessibility mode. Should be used if no title is available, except for pure layout containers. It is only used if accessibility mode (508) is switched on and will then be included into the tooltip. Its read by the screen reader when the container itself gets the focus.

Returns:

the current value of the accessibilityDescription property

See Also:

setAccessibilityDescription(String)

setAccessibilityDescription

public void setAccessibilityDescription(String value)

Sets the accessibilityDescription property to the given value.

Parameters:

value - the new value of the accessibilityDescription property

See Also:

getAccessibilityDescription()

bindDefaultButtonId

public void bindDefaultButtonId(String path)

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

Parameters:

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

bindDefaultButtonId

public void bindDefaultButtonId(IWDAttributeInfo attributeInfo)

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

Parameters:

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

bindingOfDefaultButtonId

public String bindingOfDefaultButtonId()

Returns the binding path of the defaultButtonId property.

Returns:

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

getDefaultButtonId

public String getDefaultButtonId()

Returns the value of the defaultButtonId property.

The initial value is "".

Optional ID of a button (which must belong to the same view) which is used as a default button for this container. Whenever the focus is within this container and pressing ENTER would trigger the default button, that button is highlighted somehow to indicate this. Note: pure layouting containers ignore their default button setting.

Returns:

the current value of the defaultButtonId property

See Also:

setDefaultButtonId(String)

setDefaultButtonId

public void setDefaultButtonId(String value)

Sets the defaultButtonId property to the given value.

Parameters:

value - the new value of the defaultButtonId property

See Also:

getDefaultButtonId()

bindScrollingMode

public void bindScrollingMode(String path)

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

Parameters:

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

bindScrollingMode

public void bindScrollingMode(IWDAttributeInfo attributeInfo)

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

Parameters:

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

bindingOfScrollingMode

public String bindingOfScrollingMode()

Returns the binding path of the scrollingMode property.

Returns:

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

getScrollingMode

public WDScrollingMode getScrollingMode()

Returns the value of the scrollingMode property.

The initial value is WDScrollingMode.NONE.

Determines the container's scrolling mode.

Returns:

the current value of the scrollingMode property

See Also:

setScrollingMode(WDScrollingMode)

setScrollingMode

public void setScrollingMode(WDScrollingMode value)

Sets the scrollingMode property to the given value.

Parameters:

value - the new value of the scrollingMode property

See Also:

getScrollingMode()

getCustomExtensionLabel

public IWDLabel getCustomExtensionLabel(IWDAttributeInfo customExtensionField)

Returns the label for the custom extension field identified by the given attribute info. Returns null if no such label exists (because it has not been configured or not been created yet). Please note the rules when and why such custom extension UI elements are created.

Parameters:

customExtensionField - attribute info that represents the custom extension field in question

Throws:

IllegalArgumentException - if the given attribute does not represent a custom extension field

See Also:

IWDView.nowCreateAllCustomExtensionFields()

getCustomExtensionField

public IWDUIElement getCustomExtensionField(IWDAttributeInfo customExtensionField)

Returns the UI element for the custom extension field identified by the given attribute info. Returns null if no such UI element exists (because it has not been configured or not been created yet). Please note the rules when and why such custom extension UI elements are created.

Parameters:

customExtensionField - attribute info that represents the custom extension field in question

Throws:

IllegalArgumentException - if the given attribute does not represent a custom extension field

See Also:

IWDView.nowCreateAllCustomExtensionFields()