Samples / Controls / sap.ui.core
Commands
This example demonstrates how to define shortcuts using commands in your application
- Class
z2ui5_cl_smpc_app_232- Repository
- abap2UI5/samples-controls
- Ports
sap.ui.core.sample.Commands- UI5 libraries
- sap.m, sap.ui.core
- Lowest UI5 release
- 1.84
- In the browser
- Runs in the playground
- Controls it builds
- sap.m.App, sap.m.Button, sap.m.ComboBox, sap.m.Input, sap.m.Label, sap.m.Page, sap.m.Panel, sap.m.Popover, sap.m.Select, sap.m.Switch, sap.m.Toolbar, sap.m.ToolbarSpacer, sap.ui.core.Item, sap.ui.core.mvc.View
The class
" @keywords commandexecution command execution sap.ui.core commands app popover toolbar button toolbarspacer input panel
" @summary This example demonstrates how to define shortcuts using commands in your application
" @origin sap.ui.core.sample.Commands - https://sdk.openui5.org/entity/sap.ui.core.CommandExecution/sample/sap.ui.core.sample.Commands (status: reviewed - read against the original, not run)
CLASS z2ui5_cl_smpc_app_232 DEFINITION PUBLIC.
PUBLIC SECTION.
INTERFACES z2ui5_if_app.
TYPES:
BEGIN OF ty_s_country,
key TYPE string,
text TYPE string,
END OF ty_s_country.
DATA t_countries TYPE STANDARD TABLE OF ty_s_country WITH EMPTY KEY.
DATA value TYPE string.
DATA selected TYPE string.
" the sample's $cmd> command model (CommandExecution enabled/visible) has no
" abap2UI5 equivalent - modeled here as default-model booleans the switches
" toggle two-way and the popover command-buttons bind their enabled/visible to
DATA save_enabled TYPE abap_bool.
DATA delete_enabled TYPE abap_bool.
DATA save_visible TYPE abap_bool.
DATA delete_visible TYPE abap_bool.
DATA psave_enabled TYPE abap_bool.
DATA psave_visible TYPE abap_bool.
PROTECTED SECTION.
DATA client TYPE REF TO z2ui5_if_client.
METHODS view_display.
METHODS on_event.
METHODS model_init.
PRIVATE SECTION.
ENDCLASS.
CLASS z2ui5_cl_smpc_app_232 IMPLEMENTATION.
METHOD z2ui5_if_app~main.
me->client = client.
IF client->check_on_init( ).
model_init( ).
view_display( ).
ELSEIF 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( ).
view->ele( n = `View` ns = `mvc`
)->a( n = `xmlns` v = `sap.m`
)->a( n = `xmlns:mvc` v = `sap.ui.core.mvc`
)->a( n = `xmlns:core` v = `sap.ui.core`
)->a( n = `displayBlock` v = `true`
)->ele( `App`
)->a( n = `id` v = `commands`
)->ele( `Page`
)->a( n = `id` v = `page`
)->a( n = `title` v = `Commands`
)->ele( `dependents`
" the two core:CommandExecution controls (CE_SAVE/CE_DELETE) that
" sat here are DROPPED as controls; their Ctrl+S / Ctrl+D shortcuts
" are reproduced via cs_event-keyboard_shortcut (registered on init)
)->ele( `Popover`
)->a( n = `id` v = `popoverCommand`
)->a( n = `title` v = `Popover`
)->a( n = `class` v = `sapUiContentPadding`
" the inner core:CommandExecution CE_SAVE_POPOVER is DROPPED too;
" the popover Save button binds enabled/visible to the popover flags
)->ele( `footer`
)->ele( `Toolbar`
)->tag( `Button`
)->a( n = `text` v = `Delete`
)->a( n = `enabled` v = client->_bind( delete_enabled )
)->a( n = `visible` v = client->_bind( delete_visible )
)->a( n = `press` v = client->_event( `DELETE` )
)->tag( `ToolbarSpacer`
)->tag( `Button`
)->a( n = `text` v = `Save`
)->a( n = `enabled` v = client->_bind( psave_enabled )
)->a( n = `visible` v = client->_bind( psave_visible )
)->a( n = `press` v = client->_event( `PSAVE` )
)->end(
)->end(
)->tag( `Input`
)->a( n = `value` v = client->_bind( value )
)->end(
)->ele( `Popover`
)->a( n = `id` v = `popover`
)->a( n = `title` v = `Popover`
)->a( n = `class` v = `sapUiContentPadding`
)->ele( `footer`
)->ele( `Toolbar`
)->tag( `Button`
)->a( n = `text` v = `Delete`
)->a( n = `enabled` v = client->_bind( delete_enabled )
)->a( n = `visible` v = client->_bind( delete_visible )
)->a( n = `press` v = client->_event( `DELETE` )
)->tag( `ToolbarSpacer`
)->tag( `Button`
)->a( n = `text` v = `Save`
)->a( n = `enabled` v = client->_bind( save_enabled )
)->a( n = `visible` v = client->_bind( save_visible )
)->a( n = `press` v = client->_event( `SAVE` )
)->end(
)->end(
)->tag( `Input`
)->a( n = `value` v = client->_bind( value )
)->end(
)->end(
)->ele( `Panel`
)->a( n = `headerText` v = `Button`
)->tag( `Button`
)->a( n = `text` v = `Save`
)->a( n = `press` v = client->_event( `SAVE` )
)->end(
)->ele( `Panel`
)->a( n = `headerText` v = `sap.m.Input`
)->tag( `Input`
)->a( n = `id` v = `myInput`
)->a( n = `value` v = client->_bind( value )
)->end(
)->ele( `Panel`
)->a( n = `headerText` v = `sap.m.ComboBox`
)->ele( `ComboBox`
)->a( n = `items` v = client->_bind( t_countries )
)->a( n = `selectedKey` v = client->_bind( selected )
)->tag( n = `Item` ns = `core`
)->a( n = `key` v = `{KEY}`
)->a( n = `text` v = `{TEXT}`
)->end(
)->end(
)->ele( `Panel`
)->a( n = `headerText` v = `sap.m.Select`
)->ele( `Select`
)->a( n = `selectedKey` v = client->_bind( selected )
)->a( n = `items` v = |\{ path: '{ client->_bind_path( t_countries ) }', sorter: \{ path: 'TEXT' \} \}|
)->tag( n = `Item` ns = `core`
)->a( n = `key` v = `{KEY}`
)->a( n = `text` v = `{TEXT}`
)->end(
)->end(
)->ele( `Panel`
)->a( n = `headerText` v = `Popover - CommandExecution defined on underlying content`
)->tag( `Button`
)->a( n = `text` v = `Open Popover`
)->a( n = `ariaHasPopup` v = `Dialog`
)->a( n = `press` v = client->follow_up_action( val = client->cs_event-control_by_id
t_arg = VALUE #( ( `popover` ) ( `openBy` ) ( `$event.oSource.sId` ) ) )
)->end(
)->ele( `Panel`
)->a( n = `headerText` v = `Popover - CommandExecution defined in Popup content`
)->tag( `Button`
)->a( n = `text` v = `Open Popover`
)->a( n = `ariaHasPopup` v = `Dialog`
)->a( n = `press` v = client->follow_up_action( val = client->cs_event-control_by_id
t_arg = VALUE #( ( `popoverCommand` ) ( `openBy` ) ( `$event.oSource.sId` ) ) )
)->end(
)->ele( `Panel`
)->a( n = `headerText` v = `toggle enabled/visibility for CommandExecution in Page`
)->ele( `Panel`
)->a( n = `headerText` v = `enabled`
)->tag( `Label`
)->a( n = `text` v = `Save:`
)->tag( `Switch`
)->a( n = `state` v = client->_bind( save_enabled )
)->tag( `Label`
)->a( n = `text` v = `Delete:`
)->tag( `Switch`
)->a( n = `state` v = client->_bind( delete_enabled )
)->end(
)->ele( `Panel`
)->a( n = `headerText` v = `visible`
)->tag( `Label`
)->a( n = `text` v = `Save:`
)->tag( `Switch`
)->a( n = `state` v = client->_bind( save_visible )
)->tag( `Label`
)->a( n = `text` v = `Delete:`
)->tag( `Switch`
)->a( n = `state` v = client->_bind( delete_visible )
)->end(
)->end(
)->ele( `Panel`
)->a( n = `headerText` v = `toggle enabled/visibility for CommandExecution in Popover`
)->ele( `Panel`
)->a( n = `headerText` v = `enabled`
)->tag( `Label`
)->a( n = `text` v = `Save:`
)->tag( `Switch`
)->a( n = `state` v = client->_bind( psave_enabled )
)->end(
)->ele( `Panel`
)->a( n = `headerText` v = `visible`
)->tag( `Label`
)->a( n = `text` v = `Save:`
)->tag( `Switch`
)->a( n = `state` v = client->_bind( psave_visible )
)->end(
)->end(
)->end(
)->end( ).
client->view_display( view->stringify( ) ).
" the manifest's sap.ui5/commands shortcuts (Save = Ctrl+S, Delete = Ctrl+D)
" - registered as declarative combo -> named-event bindings; pressing the
" combo fires the event like a button press and suppresses the browser default
client->follow_up_action( val = client->cs_event-keyboard_shortcut
t_arg = VALUE #( ( `Ctrl+S` ) ( `SAVE` ) ) ).
client->follow_up_action( val = client->cs_event-keyboard_shortcut
t_arg = VALUE #( ( `Ctrl+D` ) ( `DELETE` ) ) ).
" CE_SAVE_POPOVER: the sample's point is that a CommandExecution in a
" Popover's dependents SHADOWS the page-level one for the same command
" while the popover is open - so Ctrl+S is registered a second time,
" scoped to the popover, and fires PSAVE (which the popover's own
" enabled/visible flags gate) instead of SAVE. The scope is the CONTROL
" id: this Popover is declared in the view and opened with openBy, so it
" never enters the framework's popover SLOT
client->follow_up_action( val = client->cs_event-keyboard_shortcut
t_arg = VALUE #( ( `Ctrl+S` )
( `PSAVE` )
( `popoverCommand` ) ) ).
ENDMETHOD.
METHOD on_event.
CASE client->get_event( ).
WHEN `SAVE`.
" original onSave (page CE_SAVE): a disabled/invisible CommandExecution
" swallows the command, so the flags gate the toast server-side
IF save_enabled = abap_true AND save_visible = abap_true.
client->message_toast_display( `CTRL+S: save triggered on controller` ).
ENDIF.
WHEN `DELETE`.
" original onDelete (page CE_DELETE)
IF delete_enabled = abap_true AND delete_visible = abap_true.
client->message_toast_display( `CTRL+D: Delete triggered on controller` ).
ENDIF.
WHEN `PSAVE`.
" original onSave via the popover-local CE_SAVE_POPOVER. enabled and
" visible are NOT the same veto in UI5: setEnabled( false ) keeps the
" registration and swallows the command, while setVisible( false )
" UNREGISTERS the shortcut at that parent, so the key travels on to the
" ancestor CommandExecution - here the page's CE_SAVE. Reproduced by
" falling through to the page command's own gate instead of going silent
IF psave_visible = abap_false.
IF save_enabled = abap_true AND save_visible = abap_true.
client->message_toast_display( `CTRL+S: save triggered on controller` ).
ENDIF.
ELSEIF psave_enabled = abap_true.
client->message_toast_display( `CTRL+S: save triggered on controller` ).
ENDIF.
ENDCASE.
ENDMETHOD.
METHOD model_init.
value = `HelloWorld!`.
selected = ``.
save_enabled = abap_true.
delete_enabled = abap_true.
save_visible = abap_true.
delete_visible = abap_true.
psave_enabled = abap_true.
psave_visible = abap_true.
t_countries = VALUE #( ( key = `DZ` text = `Algeria` )
( key = `AR` text = `Argentina` ) ).
ENDMETHOD.
ENDCLASS.