View Settings Dialog - Standard
The View Settings Dialog is a standard UI pattern for specifying sorting, grouping and filtering.
Z2UI5_CL_SMPC_APP_098
Controls
sap.m
UI5 1.71
The facts
- Repository
- abap2UI5/samples-controls
- Class
Z2UI5_CL_SMPC_APP_098- Source file
z2ui5_cl_smpc_app_098.clas.abap↗- Library
- sap.m
- UI5 entity
sap.m.ViewSettingsDialog- Demo kit sample
sap.m.sample.ViewSettingsDialog- SAP's own sample
- running at sdk.openui5.org ↗
- Minimum UI5
- 1.71 — the floor abap2UI5 holds its samples to
- In the playground
- runs in the browser, with no system and nothing installed
Keywords: viewsettingsdialog, settings, dialog, sap.m, sort, group, filter, viewsettingsitem, viewsettingsfilteritem, verticallayout, button
Controls it builds
- sap.m.Button
- sap.m.ViewSettingsDialog
- sap.m.ViewSettingsFilterItem
- sap.m.ViewSettingsItem
- sap.ui.core.mvc.View
- sap.ui.layout.VerticalLayout
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_098.clas.abap — 329 lines
Click a number to link to a line — shift-click for a range.
Read it on GitHub ↗
" @keywords viewsettingsdialog settings dialog sap.m sort group filter viewsettingsitem viewsettingsfilteritem verticallayout button
" @summary The View Settings Dialog is a standard UI pattern for specifying sorting, grouping and filtering.
CLASS z2ui5_cl_smpc_app_098 DEFINITION PUBLIC.
PUBLIC SECTION.
INTERFACES z2ui5_if_app.
PROTECTED SECTION.
DATA client TYPE REF TO z2ui5_if_client.
METHODS view_display.
METHODS on_event.
PRIVATE SECTION.
ENDCLASS.
CLASS z2ui5_cl_smpc_app_098 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( ).
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:core` v = `sap.ui.core`
)->a( n = `xmlns` v = `sap.m`
" the controller-loaded fragments, declared in the view's dependents aggregation
)->ele( n = `dependents` ns = `mvc`
)->ele( `ViewSettingsDialog`
)->a( n = `id` v = `vsd`
)->a( n = `confirm` v = client->_event( val = `CONFIRM` arg = `${$parameters>/filterString}` )
)->ele( `sortItems`
)->tag( `ViewSettingsItem`
)->a( n = `text` v = `Field 1`
)->a( n = `key` v = `1`
)->a( n = `selected` v = `true`
)->tag( `ViewSettingsItem`
)->a( n = `text` v = `Field 2`
)->a( n = `key` v = `2`
)->tag( `ViewSettingsItem`
)->a( n = `text` v = `Field 3`
)->a( n = `key` v = `3`
)->end(
)->ele( `groupItems`
)->tag( `ViewSettingsItem`
)->a( n = `text` v = `Field 1`
)->a( n = `key` v = `1`
)->a( n = `selected` v = `true`
)->tag( `ViewSettingsItem`
)->a( n = `text` v = `Field 2`
)->a( n = `key` v = `2`
)->tag( `ViewSettingsItem`
)->a( n = `text` v = `Field 3`
)->a( n = `key` v = `3`
)->end(
)->ele( `filterItems`
)->ele( `ViewSettingsFilterItem`
)->a( n = `text` v = `Field1`
)->a( n = `key` v = `1`
)->ele( `items`
)->tag( `ViewSettingsItem`
)->a( n = `text` v = `Value A`
)->a( n = `key` v = `1a`
)->tag( `ViewSettingsItem`
)->a( n = `text` v = `Value B`
)->a( n = `key` v = `1b`
)->tag( `ViewSettingsItem`
)->a( n = `text` v = `Value C`
)->a( n = `key` v = `1c`
)->end(
)->end(
)->ele( `ViewSettingsFilterItem`
)->a( n = `text` v = `Field2`
)->a( n = `key` v = `2`
)->ele( `items`
)->tag( `ViewSettingsItem`
)->a( n = `text` v = `Value A`
)->a( n = `key` v = `2a`
)->tag( `ViewSettingsItem`
)->a( n = `text` v = `Value B`
)->a( n = `key` v = `2b`
)->tag( `ViewSettingsItem`
)->a( n = `text` v = `Value C`
)->a( n = `key` v = `2c`
)->end(
)->end(
)->ele( `ViewSettingsFilterItem`
)->a( n = `text` v = `Field3`
)->a( n = `key` v = `3`
)->ele( `items`
)->tag( `ViewSettingsItem`
)->a( n = `text` v = `Value A`
)->a( n = `key` v = `3a`
)->tag( `ViewSettingsItem`
)->a( n = `text` v = `Value B`
)->a( n = `key` v = `3b`
)->tag( `ViewSettingsItem`
)->a( n = `text` v = `Value C`
)->a( n = `key` v = `3c`
)->end(
)->end(
)->end(
)->end(
)->ele( `ViewSettingsDialog`
)->a( n = `id` v = `vsdPreselected`
)->a( n = `title` v = `Preselected Settings`
)->a( n = `sortDescending` v = `true`
)->a( n = `groupDescending` v = `true`
)->a( n = `confirm` v = client->_event( val = `CONFIRM` arg = `${$parameters>/filterString}` )
)->a( n = `selectedSortItem` v = `sortItem3`
)->ele( `sortItems`
)->tag( `ViewSettingsItem`
)->a( n = `text` v = `Field 1`
)->a( n = `key` v = `1`
)->tag( `ViewSettingsItem`
)->a( n = `text` v = `Field 2`
)->a( n = `key` v = `2`
)->tag( `ViewSettingsItem`
)->a( n = `id` v = `sortItem3`
)->a( n = `text` v = `Field 3`
)->a( n = `key` v = `3`
)->end(
)->ele( `groupItems`
)->tag( `ViewSettingsItem`
)->a( n = `text` v = `Field 1`
)->a( n = `key` v = `1`
)->tag( `ViewSettingsItem`
)->a( n = `text` v = `Field 2`
)->a( n = `key` v = `2`
)->a( n = `selected` v = `true`
)->tag( `ViewSettingsItem`
)->a( n = `text` v = `Field 3`
)->a( n = `key` v = `3`
)->end(
)->ele( `filterItems`
)->ele( `ViewSettingsFilterItem`
)->a( n = `text` v = `Field1`
)->a( n = `key` v = `1`
)->ele( `items`
)->tag( `ViewSettingsItem`
)->a( n = `text` v = `Value A`
)->a( n = `key` v = `1a`
)->a( n = `selected` v = `true`
)->tag( `ViewSettingsItem`
)->a( n = `text` v = `Value B`
)->a( n = `key` v = `1b`
)->tag( `ViewSettingsItem`
)->a( n = `text` v = `Value C`
)->a( n = `key` v = `1c`
)->tag( `ViewSettingsItem`
)->a( n = `text` v = `Value D`
)->a( n = `key` v = `1d`
)->end(
)->end(
)->ele( `ViewSettingsFilterItem`
)->a( n = `text` v = `Field2`
)->a( n = `key` v = `2`
)->ele( `items`
)->tag( `ViewSettingsItem`
)->a( n = `text` v = `Value A`
)->a( n = `key` v = `2a`
)->a( n = `selected` v = `true`
)->tag( `ViewSettingsItem`
)->a( n = `text` v = `Value B`
)->a( n = `key` v = `2b`
)->a( n = `selected` v = `true`
)->end(
)->end(
)->ele( `ViewSettingsFilterItem`
)->a( n = `text` v = `Field3`
)->a( n = `key` v = `3`
)->ele( `items`
)->tag( `ViewSettingsItem`
)->a( n = `text` v = `Value A`
)->a( n = `key` v = `3a`
)->a( n = `selected` v = `true`
)->tag( `ViewSettingsItem`
)->a( n = `text` v = `Value B`
)->a( n = `key` v = `3b`
)->a( n = `selected` v = `true`
)->tag( `ViewSettingsItem`
)->a( n = `text` v = `Value C`
)->a( n = `key` v = `3c`
)->a( n = `selected` v = `true`
)->tag( `ViewSettingsItem`
)->a( n = `text` v = `Value D`
)->a( n = `key` v = `3d`
)->tag( `ViewSettingsItem`
)->a( n = `text` v = `Value E`
)->a( n = `key` v = `3e`
)->end(
)->end(
)->end(
)->end(
)->ele( `ViewSettingsDialog`
)->a( n = `id` v = `vsdPreset`
)->a( n = `confirm` v = client->_event( val = `CONFIRM` arg = `${$parameters>/filterString}` )
)->ele( `sortItems`
)->tag( `ViewSettingsItem`
)->a( n = `text` v = `Field 1`
)->a( n = `key` v = `1`
)->a( n = `selected` v = `true`
)->tag( `ViewSettingsItem`
)->a( n = `text` v = `Field 2`
)->a( n = `key` v = `2`
)->tag( `ViewSettingsItem`
)->a( n = `text` v = `Field 3`
)->a( n = `key` v = `3`
)->end(
)->ele( `groupItems`
)->tag( `ViewSettingsItem`
)->a( n = `text` v = `Field 1`
)->a( n = `key` v = `1`
)->a( n = `selected` v = `true`
)->tag( `ViewSettingsItem`
)->a( n = `text` v = `Field 2`
)->a( n = `key` v = `2`
)->tag( `ViewSettingsItem`
)->a( n = `text` v = `Field 3`
)->a( n = `key` v = `3`
)->end(
" presetFilterItems added declaratively (the original adds them in _presetFiltersInit; the Filter payload is inert here - no list is bound)
)->ele( `presetFilterItems`
)->tag( `ViewSettingsItem`
)->a( n = `key` v = `myPresetFilter1`
)->a( n = `text` v = `A very complex filter`
)->tag( `ViewSettingsItem`
)->a( n = `key` v = `myPresetFilter2`
)->a( n = `text` v = `Ridiculously complex filter`
)->tag( `ViewSettingsItem`
)->a( n = `key` v = `myPresetFilter3`
)->a( n = `text` v = `Expensive stuff`
)->end(
)->end(
)->end(
)->ele( n = `VerticalLayout` ns = `l`
)->a( n = `class` v = `sapUiContentPadding`
)->a( n = `width` v = `100%`
)->tag( `Button`
)->a( n = `text` v = `Open View Settings Dialog`
)->a( n = `press` v = client->_event( `OPEN_DIALOG` )
)->tag( `Button`
)->a( n = `text` v = `Open View Settings Dialog in Filter view`
)->a( n = `press` v = client->_event( `OPEN_FILTER` )
)->tag( `Button`
)->a( n = `text` v = `Open View Settings Dialog with preselected filters`
)->a( n = `press` v = client->_event( `OPEN_PRESELECTED` )
)->tag( `Button`
)->a( n = `text` v = `Open View Settings Dialog with presetFilterItems`
)->a( n = `press` v = client->_event( `OPEN_PRESET` ) ).
client->view_display( view->stringify( ) ).
ENDMETHOD.
METHOD on_event.
CASE client->get_event( ).
WHEN `OPEN_DIALOG`.
client->follow_up_action( val = client->cs_event-control_by_id
t_arg = VALUE #( ( `vsd` ) ( `open` ) ) ).
WHEN `OPEN_FILTER`.
client->follow_up_action( val = client->cs_event-control_by_id
t_arg = VALUE #( ( `vsd` ) ( `open` ) ( `filter` ) ) ).
WHEN `OPEN_PRESELECTED`.
client->follow_up_action( val = client->cs_event-control_by_id
t_arg = VALUE #( ( `vsdPreselected` ) ( `open` ) ( `filter` ) ) ).
WHEN `OPEN_PRESET`.
client->follow_up_action( val = client->cs_event-control_by_id
t_arg = VALUE #( ( `vsdPreset` ) ( `open` ) ( `filter` ) ) ).
WHEN `CONFIRM`.
DATA(filter_string) = client->get_event_arg( ).
IF filter_string IS NOT INITIAL.
client->message_toast_display( filter_string ).
ENDIF.
ENDCASE.
ENDMETHOD.
ENDCLASS.More in sap.m
- Table - Auto popin of the table columns — This example demonstrates the automatic pop-in behavior of the table and hiding columns i…
- Tab Container — The sap.m.TabContainer allows for working with multiple tabs.
- Popover Controlling Closing Behavior — In some cases the closing behavior of the Popover can lead to drill down navigation. This…
- Time Picker Sliders — TimePickerSliders used in a Dialog.
- SplitContainer standard use case — SplitContainer maintains two NavContainers if running on tablet or desktop and one NavCon…
- SplitApp standard use case — The SplitApp is the base for each master detail application. It extends the sap.m.SplitCo…
- QuickViewCard — QuickViewCard embedded in container
- QuickView — QuickView basic samples.
- Wizard standard use case — The Wizard is useful for breaking down complex tasks into smaller steps.
- Late Model Update — The sample demonstrates how to rebind a control to a different data source after a certai…
- Select Dialog — The Select Dialog allows the user to search for and pick an item from a possibly long opt…
- Table Select Dialog — Similar to the Select Dialog, the Table Select Dialog presents selectable items in a tabl…
On this page