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!

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

static interface

IWDTray.IWDOnToggle Interface defining the parameter names for event onToggle.

Field Summary

static WDTrayDesign	DEFAULT_DESIGN Default value of the design property is WDTrayDesign.TRANSPARENT.
static boolean	DEFAULT_EXPANDED Default value of the expanded property is true.
static boolean	DEFAULT_HAS_CONTENT_PADDING Default value of the hasContentPadding property is true.

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

DEFAULT_ACCESSIBILITY_DESCRIPTION, DEFAULT_DEFAULT_BUTTON_ID, 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	bindDesign(IWDAttributeInfo attributeInfo) Binds the design property to the context attribute specified by the given attribute info.
void	bindDesign(String path) Binds the design property to the context attribute specified by the given path.
void	bindExpanded(IWDAttributeInfo attributeInfo) Binds the expanded property to the context attribute specified by the given attribute info.
void	bindExpanded(String path) Binds the expanded property to the context attribute specified by the given path.
void	bindHasContentPadding(IWDAttributeInfo attributeInfo) Binds the hasContentPadding property to the context attribute specified by the given attribute info.
void	bindHasContentPadding(String path) Binds the hasContentPadding property to the context attribute specified by the given path.
String	bindingOfDesign() Returns the binding path of the design property.
String	bindingOfExpanded() Returns the binding path of the expanded property.
String	bindingOfHasContentPadding() Returns the binding path of the hasContentPadding property.
void	destroyHeader() Destroys the aggregated Header element.
void	destroyPopupMenu() Destroys the aggregated PopupMenu element.
void	destroyToolBar() Destroys the aggregated ToolBar element.
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() Returns the aggregated Header element.
IWDAction	getOnToggle() Returns the action assigned to event onToggle.
IWDMenu	getPopupMenu() Returns the aggregated PopupMenu element
IWDToolBar	getToolBar() Returns the aggregated ToolBar element.
IWDParameterMapping	mappingOfOnToggle() Returns the parameter mapping for event onToggle.
void	setDesign(WDTrayDesign value) Sets the design property to the given value.
void	setExpanded(boolean value) Sets the expanded property to the given value.
void	setHasContentPadding(boolean value) Sets the hasContentPadding property to the given value.
void	setHeader(IWDCaption header) Sets the aggregated Header element.
void	setOnToggle(IWDAction action) Assigns the given action to event onToggle.
void	setPopupMenu(IWDMenu popupMenu) Sets the aggregated PopupMenu element.
void	setToolBar(IWDToolBar toolBar) Sets the aggregated ToolBar element.

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

bindAccessibilityDescription, bindAccessibilityDescription, bindDefaultButtonId, bindDefaultButtonId, bindingOfAccessibilityDescription, bindingOfDefaultButtonId, bindingOfScrollingMode, bindScrollingMode, bindScrollingMode, getAccessibilityDescription, getCustomExtensionField, getCustomExtensionLabel, getDefaultButtonId, getScrollingMode, setAccessibilityDescription, setDefaultButtonId, 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

destroy, getId, getView, requestFocus

Field Detail

DEFAULT_DESIGN

public static final WDTrayDesign DEFAULT_DESIGN

Default value of the design property is WDTrayDesign.TRANSPARENT.

DEFAULT_EXPANDED

public static final boolean DEFAULT_EXPANDED

Default value of the expanded property is true.

See Also:

Constant Field Values

DEFAULT_HAS_CONTENT_PADDING

public static final boolean DEFAULT_HAS_CONTENT_PADDING

Default value of the hasContentPadding property is true.

See Also:

Constant Field Values

Method Detail

getOnToggle

public IWDAction getOnToggle()

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

Returns:

the action assigned to event onToggle

See Also:

mappingOfOnToggle()

setOnToggle

public void setOnToggle(IWDAction action)

Assigns the given action to event onToggle.

Parameters:

action - the action assigned to the event

See Also:

getOnToggle()

mappingOfOnToggle

public IWDParameterMapping mappingOfOnToggle()

Returns the parameter mapping for event onToggle.

To pass UI element event parameter values into action handler parameters, a parameter mapping has to be defined. Add code like the following inside method wdDoModifyView() of the view controller:

 if (firstTime)
 {
   IWDTray myTray = (IWDTray) view.getElement("ID-of-Tray");
   myTray.mappingOfOnToggle().addSourceMapping
   (
     IWDTray.IWDOnToggle.EXPANDED, // event parameter name
     "name-of-action-parameter" // (type boolean)
   ); 
 }

 

Event onToggle has the following parameters:

• boolean expanded
  The new expansion state.

Returns:

the parameter mapping for event onToggle

See Also:

getOnToggle()

bindDesign

public void bindDesign(String path)

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

Parameters:

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

bindDesign

public void bindDesign(IWDAttributeInfo attributeInfo)

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

Parameters:

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

bindingOfDesign

public String bindingOfDesign()

Returns the binding path of the design property.

Returns:

the path of the context attribute to which the design property 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 the design property to the given value.

Parameters:

value - the new value of the design property

See Also:

getDesign()

bindExpanded

public void bindExpanded(String path)

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

Parameters:

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

bindExpanded

public void bindExpanded(IWDAttributeInfo attributeInfo)

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

Parameters:

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

bindingOfExpanded

public String bindingOfExpanded()

Returns the binding path of the expanded property.

Returns:

the path of the context attribute to which the expanded property 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 the expanded property to the given value.

Parameters:

value - the new value of the expanded property

See Also:

getExpanded()

bindHasContentPadding

public void bindHasContentPadding(String path)

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

Parameters:

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

bindHasContentPadding

public void bindHasContentPadding(IWDAttributeInfo attributeInfo)

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

Parameters:

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

bindingOfHasContentPadding

public String bindingOfHasContentPadding()

Returns the binding path of the hasContentPadding property.

Returns:

the path of the context attribute to which the hasContentPadding property 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 the hasContentPadding property to the given value.

Parameters:

value - the new value of the hasContentPadding property

See Also:

getHasContentPadding()

getHeader

public IWDCaption getHeader()

Returns the aggregated Header element. The header of a tray contains a caption.

Returns:

the aggregated Header element

See Also:

setHeader(IWDCaption)

setHeader

public void setHeader(IWDCaption header)

Sets the aggregated Header element.

Parameters:

header - the new header

See Also:

getHeader()

destroyHeader

public void destroyHeader()

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

getPopupMenu

public IWDMenu getPopupMenu()

Returns the aggregated PopupMenu element.

Returns:

the aggregated PopupMenu element

See Also:

setPopupMenu(IWDMenu)

setPopupMenu

public void setPopupMenu(IWDMenu popupMenu)

Sets the aggregated PopupMenu element.

Parameters:

popupMenu - the new popupMenu

See Also:

getPopupMenu()

destroyPopupMenu

public void destroyPopupMenu()

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

getToolBar

public IWDToolBar getToolBar()

Returns the aggregated ToolBar element. A tray may contain a toolbar.

Returns:

the aggregated ToolBar element

See Also:

setToolBar(IWDToolBar)

setToolBar

public void setToolBar(IWDToolBar toolBar)

Sets the aggregated ToolBar element.

Parameters:

toolBar - the new toolBar

See Also:

getToolBar()

destroyToolBar

public void destroyToolBar()

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