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

All Superinterfaces:

IWDScrollContainer, IWDUIElement, IWDUIElementContainer, IWDViewElement

public interface IWDTray

extends IWDScrollContainer

Web Dynpro Tray API. Tray is used to group a number of UI elements under a common header. A Tray may be collapsed by setting expanded to false. A collapsed tray displays only its header.

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

Field Summary

static java.lang.String	DEFAULT_ACCESSIBILITY_DESCRIPTION Default value of property accessibilityDescription.
static WDTrayDesign	DEFAULT_DESIGN Default value of property design.
static boolean	DEFAULT_EXPANDED Default value of property expanded.
static boolean	DEFAULT_HAS_CONTENT_PADDING Default value of property hasContentPadding.

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

DEFAULT_SCROLLING_MODE

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 property accessibilityDescription to the context attribute specified by the given attribute info.
void	bindAccessibilityDescription(java.lang.String path) Binds property accessibilityDescription to the context attribute specified by path.
void	bindDesign(IWDAttributeInfo attributeInfo) Binds property design to the context attribute specified by the given attribute info.
void	bindDesign(java.lang.String path) Binds property design to the context attribute specified by path.
void	bindExpanded(IWDAttributeInfo attributeInfo) Binds property expanded to the context attribute specified by the given attribute info.
void	bindExpanded(java.lang.String path) Binds property expanded to the context attribute specified by path.
void	bindHasContentPadding(IWDAttributeInfo attributeInfo) Binds property hasContentPadding to the context attribute specified by the given attribute info.
void	bindHasContentPadding(java.lang.String path) Binds property hasContentPadding to the context attribute specified by path.
java.lang.String	bindingOfAccessibilityDescription() Binding path of property accessibilityDescription.
java.lang.String	bindingOfDesign() Binding path of property design.
java.lang.String	bindingOfExpanded() Binding path of property expanded.
java.lang.String	bindingOfHasContentPadding() Binding path of property hasContentPadding.
void	destroyHeader() Destroys the Header instance.
void	destroyPopupMenu() Destroys the PopupMenu instance.
void	destroyToolBar() Destroys the ToolBar instance.
java.lang.String	getAccessibilityDescription() Returns the value of the accessibilityDescription property.
WDTrayDesign	getDesign() Returns the value of the design property.
boolean	getExpanded() Returns the value of the expanded property.
boolean	getHasContentPadding() Returns the value of the hasContentPadding property.
IWDCaption	getHeader() Gets the Header instance.
IWDAction	getOnToggle() Returns the action to which the event onToggle is mapped.
IWDMenu	getPopupMenu() Gets the PopupMenu instance.
IWDToolBar	getToolBar() Gets the ToolBar instance.
IWDParameterMapping	mappingOfOnToggle() Returns the parameter mapping of event onToggle.
void	setAccessibilityDescription(java.lang.String value) Sets property accessibilityDescription to the new value.
void	setDesign(WDTrayDesign value) Sets property design to the new value.
void	setExpanded(boolean value) Sets property expanded to the new value.
void	setHasContentPadding(boolean value) Sets property hasContentPadding to the new value.
void	setHeader(IWDCaption header) Sets the Header instance.
void	setOnToggle(IWDAction action) Maps the event onToggle to the given action.
void	setPopupMenu(IWDMenu popupMenu) Sets the PopupMenu instance.
void	setToolBar(IWDToolBar toolBar) Sets the ToolBar instance.

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

bindingOfScrollingMode, bindScrollingMode, bindScrollingMode, getScrollingMode, setScrollingMode

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

getId, getView, requestFocus

Field Detail

DEFAULT_ACCESSIBILITY_DESCRIPTION

public static final java.lang.String DEFAULT_ACCESSIBILITY_DESCRIPTION

Default value of property accessibilityDescription.

DEFAULT_DESIGN

public static final WDTrayDesign DEFAULT_DESIGN

Default value of property design.

DEFAULT_EXPANDED

public static final boolean DEFAULT_EXPANDED

Default value of property expanded.

DEFAULT_HAS_CONTENT_PADDING

public static final boolean DEFAULT_HAS_CONTENT_PADDING

Default value of property hasContentPadding.

Method Detail

getOnToggle

public IWDAction getOnToggle()

Returns the action to which the event onToggle is mapped. The action performed when the tray is toggled (collapsed resp. expanded). Event parameter is the new expansion state.

Returns:

the action to which the event is mapped

See Also:

mappingOfOnToggle()

setOnToggle

public void setOnToggle(IWDAction action)

Maps the event onToggle to the given action.

Parameters:

action - the action for the event

See Also:

getOnToggle()

mappingOfOnToggle

public IWDParameterMapping mappingOfOnToggle()

Returns the parameter mapping of event onToggle.

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:

• boolean expanded - The new expansion state.

Returns:

parameter mapping list.

See Also:

getOnToggle()

bindAccessibilityDescription

public void bindAccessibilityDescription(java.lang.String path)

Binds property accessibilityDescription to the context attribute specified by path.

Parameters:

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

bindAccessibilityDescription

public void bindAccessibilityDescription(IWDAttributeInfo attributeInfo)

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

Parameters:

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

bindingOfAccessibilityDescription

public java.lang.String bindingOfAccessibilityDescription()

Binding path of property accessibilityDescription.

Returns:

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

getAccessibilityDescription

public java.lang.String getAccessibilityDescription()

Returns the value of the accessibilityDescription property. The initial value is "". Short description for the Tray (It's like a title) in the accessibility mode. Should be used if no title is available. It is only used if accessibility mode (508) is switched on and will be included into the tooltip. Its read by the screen reader when the whole UI element gets the focus.

Returns:

the current value of the accessibilityDescription property

See Also:

setAccessibilityDescription(String)

setAccessibilityDescription

public void setAccessibilityDescription(java.lang.String value)

Sets property accessibilityDescription to the new value.

Parameters:

value - the new value of the accessibilityDescription property

See Also:

getAccessibilityDescription()

bindDesign

public void bindDesign(java.lang.String path)

Binds property design to the context attribute specified by path.

Parameters:

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

bindDesign

public void bindDesign(IWDAttributeInfo attributeInfo)

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

Parameters:

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

bindingOfDesign

public java.lang.String bindingOfDesign()

Binding path of property design.

Returns:

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

getDesign

public WDTrayDesign getDesign()

Returns the value of the design property. The initial value is WDTrayDesign.TRANSPARENT. Determines the design of this tray.

Returns:

the current value of the design property

See Also:

setDesign(WDTrayDesign)

setDesign

public void setDesign(WDTrayDesign value)

Sets property design to the new value.

Parameters:

value - the new value of the design property

See Also:

getDesign()

bindExpanded

public void bindExpanded(java.lang.String path)

Binds property expanded to the context attribute specified by path.

Parameters:

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

bindExpanded

public void bindExpanded(IWDAttributeInfo attributeInfo)

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

Parameters:

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

bindingOfExpanded

public java.lang.String bindingOfExpanded()

Binding path of property expanded.

Returns:

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

getExpanded

public boolean getExpanded()

Returns the value of the expanded property. The initial value is true. Determines if this tray is expanded.

Returns:

the current value of the expanded property

See Also:

setExpanded(boolean)

setExpanded

public void setExpanded(boolean value)

Sets property expanded to the new value.

Parameters:

value - the new value of the expanded property

See Also:

getExpanded()

bindHasContentPadding

public void bindHasContentPadding(java.lang.String path)

Binds property hasContentPadding to the context attribute specified by path.

Parameters:

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

bindHasContentPadding

public void bindHasContentPadding(IWDAttributeInfo attributeInfo)

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

Parameters:

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

bindingOfHasContentPadding

public java.lang.String bindingOfHasContentPadding()

Binding path of property hasContentPadding.

Returns:

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

getHasContentPadding

public boolean getHasContentPadding()

Returns the value of the hasContentPadding property. The initial value is true.

Returns:

the current value of the hasContentPadding property

See Also:

setHasContentPadding(boolean)

setHasContentPadding

public void setHasContentPadding(boolean value)

Sets property hasContentPadding to the new value.

Parameters:

value - the new value of the hasContentPadding property

See Also:

getHasContentPadding()

getHeader

public IWDCaption getHeader()

Gets the Header instance. The header of a tray contains a caption.

Returns:

the current Header

See Also:

setHeader(IWDCaption)

setHeader

public void setHeader(IWDCaption header)

Sets the Header instance.

Parameters:

header - the new header

See Also:

getHeader()

destroyHeader

public void destroyHeader()

Destroys the Header instance. Destroyed elements do not exist any longer, i.e. a new element may be created with the same ID.

getPopupMenu

public IWDMenu getPopupMenu()

Gets the PopupMenu instance.

Returns:

the current PopupMenu

See Also:

setPopupMenu(IWDMenu)

setPopupMenu

public void setPopupMenu(IWDMenu popupMenu)

Sets the PopupMenu instance.

Parameters:

popupMenu - the new popupMenu

See Also:

getPopupMenu()

destroyPopupMenu

public void destroyPopupMenu()

Destroys the PopupMenu instance. Destroyed elements do not exist any longer, i.e. a new element may be created with the same ID.

getToolBar

public IWDToolBar getToolBar()

Gets the ToolBar instance. A tray may contain a toolbar.

Returns:

the current ToolBar

See Also:

setToolBar(IWDToolBar)

setToolBar

public void setToolBar(IWDToolBar toolBar)

Sets the ToolBar instance.

Parameters:

toolBar - the new toolBar

See Also:

getToolBar()

destroyToolBar

public void destroyToolBar()

Destroys the ToolBar instance. Destroyed elements do not exist any longer, i.e. a new element may be created with the same ID.