Start of Content Area

Background documentation Tray Locate the document in its SAP Library structure

The Tray UI element (IWDTray) is a UI element container like the Group UI element container and can be used to group a set of UI elements under one common title. Unlike the Group UI element it provides additional functions. For example, the Tray UI element can be displayed or hidden.

Examples of the Display

Tray with Plain Design

This graphic is explained in the accompanying text

 

Tray with Fill and Menu Design

This graphic is explained in the accompanying text

 

Collapsed Tray with Transparent Design

This graphic is explained in the accompanying text

Note

To enable the development of Structure linkaccessible applications, the accessibilityDescription property is checked during the syntax check if the caption property is not set.

The tooltip property is not checked.

A tooltip does not necessarily have to be set for this UI element, but it could make sense to set it if it contains detailed semantic information.

 

Runtime Class

CL_WD_TRAY

 

Properties in View Designer

Name

Type

Initial Value

Bindable

id

STRING

(automatic)

No

Structure linkaccessibilityDescription

Text

 

Yes

Structure linkdefaultButtonId

STRING

 

Yes

Structure linkdesign

WDUI_TRAY_DESIGN

transparent

Yes

Structure linkenabled

WDY_BOOLEAN

true

Yes

Structure linkexpanded

WDY_BOOLEAN

true

Yes

Structure linkhasContentPadding

WDY_BOOLEAN

true

Yes

Structure linkheight

STRING

 

Yes

Structure linkscrollingMode

WDUI_SCROLLING_MODE

none

Yes

Structure linktooltip

Text

 

Yes

Structure linkvisible

WDUI_VISIBILITY

visible

Yes

Structure linkwidth

STRING

 

Yes

 

Aggregations in View Designer

Name

Cardinality

Type

Structure linkElement

0..n

Structure linkUIElement

Structure linkHeader

1..1

Structure linkCaption

Structure linkMenu

0..1

Structure linkMenu

Structure linkToolbar

0..1

Structure linkToolBar

 

Events in View Designer

Name

Structure linkonToggle

Note

Other properties that can be inherited are defined in the associated higher-level class. The associated UI elements are:

      ScrollContainer

      Structure linkUIElementContainer

      Structure linkUIElement

      Structure linkViewElement

Dynamic Programming

For dynamic programming, the same properties, events and aggregations are available as in View Designer. Bear in mind the different spellings.

Dynamic Programming of Properties

View Designer Name

Runtime Name

Type

Structure linkaccessibilityDescription

ACCESSIBILITY_DESCR

WDY_MD_TRANSLATABLE_TEXT

Structure linkdefaultButtonId

DEFAULT_BUTTON_ID

STRING

Structure linkdesign

DESIGN

WDUI_TRAY_DESIGN

 design: fill

CL_WD_TRAY=>E_DESIGN-FILL

 design: plain

CL_WD_TRAY=>E_DESIGN-PLAIN

 design: transparent

CL_WD_TRAY=>E_DESIGN-TRANSPARENT

Structure linkenabled

ENABLED

WDY_BOOLEAN

Structure linkexpanded

EXPANDED

WDY_BOOLEAN

Structure linkhasContentPadding

HAS_CONTENT_PADDING

WDY_BOOLEAN

Structure linkheight

HEIGHT

STRING

Structure linkscrollingMode

SCROLLING_MODE

WDUI_SCROLLING_MODE

 scrollingMode: auto

CL_WD_TRAY=>E_SCROLLING_MODE-AUTO

 scrollingMode: both

CL_WD_TRAY=>E_SCROLLING_MODE-BOTH

 scrollingMode: none

CL_WD_TRAY=>E_SCROLLING_MODE-NONE

Structure linktooltip

TOOLTIP

WDY_MD_TRANSLATABLE_TEXT

Structure linkvisible

VISIBLE

WDUI_VISIBILITY

 visible: none

CL_WD_TRAY=>E_VISIBLE-NONE

 visible: visible

CL_WD_TRAY=>E_VISIBLE-VISIBLE

Structure linkwidth

WIDTH

STRING

 

Dynamic Programming of Events

View Designer Name

Runtime Name

Structure linkonToggle

ON_TOGGLE

 

Dynamic Programming of Aggregations

View Designer Name

Runtime Name

Cardinality

Structure linkElement

CHILDREN

0..n

Structure linkHeader

HEADER

1..1

Structure linkMenü

POPUP_MENU

0..1

Structure linkToolbar

TOOLBAR

0..1

Example

You can find examples of this interface element in the system in the Web Dynpro application WDR_TEST_UI_ELEMENTS, and in the component WDR_TEST_EVENTS in the view Tray.

 

 

End of Content Area