Dynamic Message Strip Generator
Generates MessageStrips with random properties.
Z2UI5_CL_SMPC_APP_289
Controls
sap.m
UI5 1.78
The facts
- Repository
- abap2UI5/samples-controls
- Class
Z2UI5_CL_SMPC_APP_289- Source file
z2ui5_cl_smpc_app_289.clas.abap↗- Library
- sap.m
- UI5 entity
sap.m.MessageStrip- Demo kit sample
sap.m.sample.DynamicMessageStripGenerator- SAP's own sample
- running at sdk.openui5.org ↗
- Minimum UI5
- 1.78
- In the playground
- runs in the browser, with no system and nothing installed
Keywords: messagestrip, message, strip, sap.m, dynamicmessagestripgenerator, verticallayout, button
Controls it builds
Read out of the builder chain by the abap2UI5 linter, not from the category this sample is filed under — which is what makes “which samples build one of these” a question the catalogue can answer at all.
Libraries
Run it here
The sample running, in this page — the app on its own, with no editor over it.
Switch to Playground with this code
Nothing is installed and nothing is sent anywhere: the ABAP is compiled to JavaScript in this browser and runs against abap2UI5 itself.
The ABAP
z2ui5_cl_smpc_app_289.clas.abap — 124 lines
Click a number to link to a line — shift-click for a range.
Read it on GitHub ↗
" @keywords messagestrip message strip sap.m dynamicmessagestripgenerator verticallayout button
" @summary Generates MessageStrips with random properties.
CLASS z2ui5_cl_smpc_app_289 DEFINITION PUBLIC.
PUBLIC SECTION.
INTERFACES z2ui5_if_app.
DATA strip_visible TYPE abap_bool.
DATA strip_text TYPE string.
" MessageStrip.type is an enum: an empty string is rejected by
" validateProperty, so the field carries the control's own default
DATA strip_type TYPE string VALUE `Information`.
DATA show_icon TYPE abap_bool.
DATA show_close TYPE abap_bool.
PROTECTED SECTION.
DATA client TYPE REF TO z2ui5_if_client.
" how often the button was pressed - drives the rotation that replaces the
" original's Math.random( ); not bound, so it stays out of the model
DATA press_count TYPE i.
METHODS view_display.
METHODS on_event.
PRIVATE SECTION.
ENDCLASS.
CLASS z2ui5_cl_smpc_app_289 IMPLEMENTATION.
METHOD z2ui5_if_app~main.
me->client = client.
IF client->check_on_navigated( ).
view_display( ).
ELSEIF client->check_on_event( ).
on_event( ).
ENDIF.
ENDMETHOD.
METHOD view_display.
DATA(view) = z2ui5_cl_ui5_view_builder=>factory( ).
" the original builds the MessageStrip in the controller and adds it to the
" VerticalLayout (destroying the previous one first). Here it is part of the
" view and its four varying properties are bound; visible keeps it out of
" the layout until the button was pressed once
view->ele( n = `View` ns = `mvc`
)->a( n = `xmlns:l` v = `sap.ui.layout`
)->a( n = `xmlns:mvc` v = `sap.ui.core.mvc`
)->a( n = `xmlns` v = `sap.m`
)->ele( n = `VerticalLayout` ns = `l`
)->a( n = `class` v = `sapUiContentPadding`
)->a( n = `id` v = `oVerticalContent`
)->a( n = `width` v = `100%`
)->ele( n = `content` ns = `l`
)->tag( `Button`
)->a( n = `text` v = `Generate MessageStrip`
)->a( n = `class` v = `sapUiSmallMarginBottom`
)->a( n = `press` v = client->_event( `GENERATE` )
)->a( n = `width` v = `250px`
)->tag( `MessageStrip`
)->a( n = `id` v = `msgStrip`
)->a( n = `visible` v = client->_bind( strip_visible )
)->a( n = `text` v = client->_bind( strip_text )
)->a( n = `type` v = client->_bind( strip_type )
)->a( n = `showIcon` v = client->_bind( show_icon )
)->a( n = `showCloseButton` v = client->_bind( show_close ) ).
client->view_display( view->stringify( ) ).
ENDMETHOD.
METHOD on_event.
IF client->get_event( ) = `GENERATE`.
" _generateMsgStrip picks type, showIcon and showCloseButton at random.
" Randomness is a decision, so it is taken in ABAP - and taken
" DETERMINISTICALLY: the press counter rotates through the four types
" and through the two flag combinations, so every press still changes
" the strip and the port stays reproducible
press_count = press_count + 1.
strip_visible = abap_true.
strip_text = `Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua ut enim ` &&
`ad minim veniam, quis nostrud exercitation ullamco.`.
strip_type = SWITCH string( press_count MOD 4
WHEN 1 THEN `Information`
WHEN 2 THEN `Warning`
WHEN 3 THEN `Error`
WHEN 0 THEN `Success` ).
show_icon = xsdbool( press_count MOD 2 = 1 ).
show_close = xsdbool( press_count MOD 3 <> 0 ).
" onInit takes an InvisibleMessage instance and _generateMsgStrip
" announces the new strip assertively. InvisibleMessage is a singleton
" with no control id, so the announcement goes through the global
" target added for it (pr/invisible-message-announce)
client->follow_up_action( val = client->cs_event-control_global
t_arg = VALUE #( ( `INVISIBLE_MESSAGE` )
( `announce` )
( |New Information Bar of type { strip_type } { strip_text }| )
( `Assertive` ) ) ).
" showMsgStrip DESTROYS the old strip and creates a new one, so a strip
" the user closed always comes back. Rebinding cannot do that on its own:
" MessageStrip.close( ) calls setVisible( false ) on the CONTROL, and the
" model still holds abap_true - an unchanged value fires no binding
" update, so the strip would stay invisible for the rest of the session
" while text and type kept changing behind it. Re-rendering the view is
" the destroy-and-create the original does
view_display( ).
ENDIF.
ENDMETHOD.
ENDCLASS.
More in sap.m
- MultiComboBox - showSelectAll functionality — MultiComboBox with enabled Select All feature inside suggestions.
- Message View inside Dialog — A sample with Message View placed inside a Dialog.
- Popover in Custom Within Area — Within area of sap.ui.core.Popup determines where all popups (including popovers) are pos…
- Breadcrumbs sample with current page link — Breadcrumbs sample with current page set as aggregation, resulting in a link
- Icon Tab Bar - Badges — This sample illustrates the possibility to add badges to the icon tab filters.
- PDF Viewer - Embedded — A PDF viewer embedded in another control.
- MultiInput with Value Help — MultiInput that includes a SelectDialog as a value help dialog
- Notification List Group with data bindings — A control suitable for grouping notifications. The sample uses JSON data bindings.
- Panel - Background Design — Panels support different background designs for better visual distinction inside containe…
- Message View with Grouping — A sample with Message View and inside a Dialog and grouping of items
- View Settings Dialog - Custom Filters — You can have custom filters in your View Settings Dialog, as shown in this example here.
- View Settings Dialog - Custom Search — You can filter the items in the filter details page using different string filter operato…
On this page