JSONTreeBinding
Basic example showing how a TreeTable can be built using a JSONModel
Z2UI5_CL_SMPC_APP_248
Controls
sap.ui.table
UI5 1.71
The facts
- Repository
- abap2UI5/samples-controls
- Class
Z2UI5_CL_SMPC_APP_248- Source file
z2ui5_cl_smpc_app_248.clas.abap↗- Library
- sap.ui.table
- UI5 entity
sap.ui.table.TreeTable- Demo kit sample
sap.ui.table.sample.TreeTable.JSONTreeBinding- 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: treetable, tree, table, sap.ui.table, treetable.jsontreebinding, overflowtoolbar, title, toolbarspacer, button, column, label, text
Controls it builds
- sap.m.Button
- sap.m.Label
- sap.m.OverflowToolbar
- sap.m.Page
- sap.m.Select
- sap.m.Text
- sap.m.Title
- sap.m.ToolbarSpacer
- sap.ui.core.Item
- sap.ui.core.mvc.View
- sap.ui.table.Column
- sap.ui.table.TreeTable
- sap.ui.unified.Currency
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_248.clas.abap — 288 lines
Click a number to link to a line — shift-click for a range.
Read it on GitHub ↗
" @keywords treetable tree table sap.ui.table treetable.jsontreebinding overflowtoolbar title toolbarspacer button column label text
" @summary Basic example showing how a TreeTable can be built using a JSONModel
CLASS z2ui5_cl_smpc_app_248 DEFINITION PUBLIC.
PUBLIC SECTION.
INTERFACES z2ui5_if_app.
" the Clothing.json tree has a fixed depth: 4 root categories, their
" subcategories, then either leaf articles or one more category level -
" modeled as nested types. A flat ABAP row serializes EVERY field, so a
" level-3 category row (Dresses) does carry initial AMOUNT/CURRENCY/SIZE
" fields its own JSON node omits - which is what the Currency > 0 and the
" !!SIZE guards in the view exist for. Corrected 2026-08-21: this comment
" used to claim the opposite of the two deviations that declare it.
TYPES:
BEGIN OF ty_s_article,
name TYPE string,
amount TYPE p LENGTH 5 DECIMALS 2,
currency TYPE string,
size TYPE string,
END OF ty_s_article.
TYPES ty_t_article TYPE STANDARD TABLE OF ty_s_article WITH EMPTY KEY.
TYPES:
BEGIN OF ty_s_group,
name TYPE string,
amount TYPE p LENGTH 5 DECIMALS 2,
currency TYPE string,
size TYPE string,
categories TYPE ty_t_article,
END OF ty_s_group.
TYPES ty_t_group TYPE STANDARD TABLE OF ty_s_group WITH EMPTY KEY.
TYPES:
BEGIN OF ty_s_area,
name TYPE string,
categories TYPE ty_t_group,
END OF ty_s_area.
TYPES ty_t_area TYPE STANDARD TABLE OF ty_s_area WITH EMPTY KEY.
TYPES:
BEGIN OF ty_s_root,
name TYPE string,
categories TYPE ty_t_area,
END OF ty_s_root.
TYPES ty_t_root TYPE STANDARD TABLE OF ty_s_root WITH EMPTY KEY.
TYPES:
BEGIN OF ty_s_clothing,
categories TYPE ty_t_root,
END OF ty_s_clothing.
TYPES:
BEGIN OF ty_s_catalog,
clothing TYPE ty_s_clothing,
END OF ty_s_catalog.
TYPES:
BEGIN OF ty_s_size,
key TYPE string,
value TYPE string,
END OF ty_s_size.
DATA catalog TYPE ty_s_catalog.
DATA sizes TYPE STANDARD TABLE OF ty_s_size WITH EMPTY KEY.
PROTECTED SECTION.
DATA client TYPE REF TO z2ui5_if_client.
METHODS view_display.
METHODS model_init.
PRIVATE SECTION.
ENDCLASS.
CLASS z2ui5_cl_smpc_app_248 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( ).
ENDIF.
ENDMETHOD.
METHOD view_display.
DATA(view) = z2ui5_cl_ui5_view_builder=>factory( ).
view->ele( n = `View` ns = `mvc`
)->a( n = `xmlns` v = `sap.ui.table`
)->a( n = `xmlns:mvc` v = `sap.ui.core.mvc`
)->a( n = `xmlns:m` v = `sap.m`
)->a( n = `xmlns:u` v = `sap.ui.unified`
)->a( n = `xmlns:core` v = `sap.ui.core`
)->a( n = `height` v = `100%`
)->ele( n = `Page` ns = `m`
)->a( n = `showHeader` v = `false`
)->a( n = `enableScrolling` v = `false`
)->ele( n = `content` ns = `m`
)->ele( `TreeTable`
)->a( n = `id` v = `TreeTableBasic`
)->a( n = `rows` v = |\{ path: '{ client->_bind_path( catalog-clothing ) }', parameters: \{ arrayNames: ['CATEGORIES'] \} \}|
)->a( n = `selectionMode` v = `MultiToggle`
)->a( n = `enableSelectAll` v = `false`
)->a( n = `ariaLabelledBy` v = `title`
)->ele( `extension`
)->ele( n = `OverflowToolbar` ns = `m`
)->a( n = `style` v = `Clear`
)->tag( n = `Title` ns = `m`
)->a( n = `id` v = `title`
)->a( n = `text` v = `Clothing`
)->tag( n = `ToolbarSpacer` ns = `m`
)->tag( n = `Button` ns = `m`
)->a( n = `text` v = `Collapse all`
)->a( n = `press` v = client->follow_up_action( val = client->cs_event-control_by_id
t_arg = VALUE #( ( `TreeTableBasic` ) ( `collapseAll` ) ) )
)->tag( n = `Button` ns = `m`
)->a( n = `text` v = `Collapse selection`
)->a( n = `press` v = client->follow_up_action( val = client->cs_event-control_by_id
t_arg = VALUE #( ( `TreeTableBasic` ) ( `collapse` ) ( `$event.oSource.getParent().getParent().getSelectedIndices()` ) ) )
)->tag( n = `Button` ns = `m`
)->a( n = `text` v = `Expand first level`
)->a( n = `press` v = client->follow_up_action( val = client->cs_event-control_by_id
t_arg = VALUE #( ( `TreeTableBasic` ) ( `expandToLevel` ) ( `1` ) ) )
)->tag( n = `Button` ns = `m`
)->a( n = `text` v = `Expand selection`
)->a( n = `press` v = client->follow_up_action( val = client->cs_event-control_by_id
t_arg = VALUE #( ( `TreeTableBasic` ) ( `expand` ) ( `$event.oSource.getParent().getParent().getSelectedIndices()` ) ) )
)->end(
)->end(
)->ele( `columns`
)->ele( `Column`
)->a( n = `width` v = `13rem`
)->tag( n = `Label` ns = `m`
)->a( n = `text` v = `Categories`
)->ele( `template`
)->tag( n = `Text` ns = `m`
)->a( n = `text` v = `{NAME}`
)->a( n = `wrapping` v = `false`
)->end(
)->end(
)->ele( `Column`
)->a( n = `width` v = `9rem`
)->tag( n = `Label` ns = `m`
)->a( n = `text` v = `Price`
)->ele( `template`
" a category row's own AMOUNT serializes as 0 (initial packed);
" the guard keeps the Price cell empty there like the original's
" absent JSON property (app-220 idiom, declared)
)->tag( n = `Currency` ns = `u`
)->a( n = `value` v = `{= ${AMOUNT} > 0 ? ${AMOUNT} : null }`
)->a( n = `currency` v = `{CURRENCY}`
)->end(
)->end(
)->ele( `Column`
)->a( n = `width` v = `11rem`
)->tag( n = `Label` ns = `m`
)->a( n = `text` v = `Size`
)->ele( `template`
)->ele( n = `Select` ns = `m`
)->a( n = `items` v = |\{ path: '{ client->_bind_path( sizes ) }', templateShareable: true \}|
)->a( n = `selectedKey` v = `{SIZE}`
)->a( n = `visible` v = `{= !!${SIZE}}`
)->a( n = `forceSelection` v = `false`
)->tag( n = `Item` ns = `core`
)->a( n = `key` v = `{KEY}`
)->a( n = `text` v = `{VALUE}` ).
client->view_display( view->stringify( ) ).
ENDMETHOD.
METHOD model_init.
" Clothing.json 1:1 - the full tree (Women/Men/Girls/Boys), every leaf
" with its amount/currency/size; a leaf without a size in the JSON keeps
" the field initial so the Select stays hidden via the !!SIZE guard
catalog-clothing-categories = VALUE #(
( name = `Women` categories = VALUE #(
( name = `Clothing` categories = VALUE #(
( name = `Dresses` categories = VALUE #(
( name = `Casual Red Dress` amount = `16.99` currency = `EUR` size = `S` )
( name = `Short Black Dress` amount = `47.99` currency = `EUR` size = `M` )
( name = `Long Blue Dinner Dress` amount = `103.99` currency = `USD` size = `L` ) ) )
( name = `Tops` categories = VALUE #(
( name = `Printed Shirt` amount = `24.99` currency = `USD` size = `M` )
( name = `Tank Top` amount = `14.99` currency = `USD` size = `S` ) ) )
( name = `Pants` categories = VALUE #(
( name = `Red Pant` amount = `32.99` currency = `USD` size = `M` )
( name = `Skinny Jeans` amount = `44.99` currency = `USD` size = `S` )
( name = `Black Jeans` amount = `99.99` currency = `USD` size = `XS` )
( name = `Relaxed Fit Jeans` amount = `56.99` currency = `USD` size = `L` ) ) )
( name = `Skirts` categories = VALUE #(
( name = `Striped Skirt` amount = `24.99` currency = `USD` size = `M` )
( name = `Black Skirt` amount = `44.99` currency = `USD` size = `S` ) ) ) ) )
( name = `Jewelry` categories = VALUE #(
( name = `Necklace` amount = `16.99` currency = `USD` )
( name = `Bracelet` amount = `47.99` currency = `USD` )
( name = `Gold Ring` amount = `399.99` currency = `USD` ) ) )
( name = `Handbags` categories = VALUE #(
( name = `Little Black Bag` amount = `16.99` currency = `USD` size = `S` )
( name = `Grey Shopper` amount = `47.99` currency = `USD` size = `M` ) ) )
( name = `Shoes` categories = VALUE #(
( name = `Pumps` amount = `89.99` currency = `USD` )
( name = `Sport Shoes` amount = `47.99` currency = `USD` )
( name = `Boots` amount = `103.99` currency = `USD` ) ) ) ) )
( name = `Men` categories = VALUE #(
( name = `Clothing` categories = VALUE #(
( name = `Shirts` categories = VALUE #(
( name = `Black T-shirt` amount = `9.99` currency = `USD` size = `XL` )
( name = `Polo T-shirt` amount = `47.99` currency = `USD` size = `M` )
( name = `White Shirt` amount = `103.99` currency = `USD` size = `L` ) ) )
( name = `Pants` categories = VALUE #(
( name = `Blue Jeans` amount = `78.99` currency = `USD` size = `M` )
( name = `Stretch Pant` amount = `54.99` currency = `USD` size = `S` ) ) )
( name = `Shorts` categories = VALUE #(
( name = `Trouser Short` amount = `62.99` currency = `USD` size = `M` )
( name = `Slim Short` amount = `44.99` currency = `USD` size = `S` ) ) ) ) )
( name = `Accessories` categories = VALUE #(
( name = `Tie` amount = `36.99` currency = `USD` )
( name = `Wallet` amount = `47.99` currency = `USD` )
( name = `Sunglasses` amount = `199.99` currency = `USD` ) ) )
( name = `Shoes` categories = VALUE #(
( name = `Fashion Sneaker` amount = `89.99` currency = `USD` )
( name = `Sport Shoe` amount = `47.99` currency = `USD` )
( name = `Boots` amount = `103.99` currency = `USD` ) ) ) ) )
( name = `Girls` categories = VALUE #(
( name = `Clothing` categories = VALUE #(
( name = `Shirts` categories = VALUE #(
( name = `Red T-shirt` amount = `16.99` currency = `USD` size = `S` )
( name = `Tunic Top` amount = `47.99` currency = `USD` size = `M` )
( name = `Fuzzy Sweater` amount = `103.99` currency = `USD` size = `L` ) ) )
( name = `Pants` categories = VALUE #(
( name = `Blue Jeans` amount = `24.99` currency = `USD` size = `M` )
( name = `Red Pant` amount = `54.99` currency = `USD` size = `S` ) ) )
( name = `Shorts` categories = VALUE #(
( name = `Jeans Short` amount = `32.99` currency = `USD` size = `M` )
( name = `Sport Short` amount = `14.99` currency = `USD` size = `S` ) ) ) ) )
( name = `Accessories` categories = VALUE #(
( name = `Necklace` amount = `26.99` currency = `USD` )
( name = `Gloves` amount = `7.99` currency = `USD` )
( name = `Beanie` amount = `12.99` currency = `USD` ) ) )
( name = `Shoes` categories = VALUE #(
( name = `Sport Shoes` amount = `39.99` currency = `USD` )
( name = `Boots` amount = `87.99` currency = `USD` )
( name = `Sandals` amount = `63.99` currency = `USD` ) ) ) ) )
( name = `Boys` categories = VALUE #(
( name = `Clothing` categories = VALUE #(
( name = `Shirts` categories = VALUE #(
( name = `Black T-shirt with Print` amount = `16.99` currency = `USD` size = `S` )
( name = `Blue Shirt` amount = `47.99` currency = `USD` size = `M` )
( name = `Yellow Sweater` amount = `63.99` currency = `USD` size = `L` ) ) )
( name = `Pants` categories = VALUE #(
( name = `Blue Jeans` amount = `44.99` currency = `USD` size = `M` )
( name = `Brown Pant` amount = `89.99` currency = `USD` size = `S` ) ) )
( name = `Shorts` categories = VALUE #(
( name = `Sport Short` amount = `32.99` currency = `USD` size = `M` )
( name = `Jeans Short` amount = `99.99` currency = `USD` size = `XS` )
( name = `Black Short` amount = `56.99` currency = `USD` size = `L` ) ) ) ) )
( name = `Accessories` categories = VALUE #(
( name = `Sunglasses` amount = `36.99` currency = `USD` )
( name = `Beanie` amount = `17.99` currency = `USD` )
( name = `Scarf` amount = `15.99` currency = `USD` ) ) )
( name = `Shoes` categories = VALUE #(
( name = `Sneaker` amount = `89.99` currency = `USD` )
( name = `Sport Shoe` amount = `47.99` currency = `USD` )
( name = `Boots` amount = `103.99` currency = `USD` ) ) ) ) ) ).
" /sizes - the shared Select item list
sizes = VALUE #(
( key = `XS` value = `Extra Small` )
( key = `S` value = `Small` )
( key = `M` value = `Medium` )
( key = `L` value = `Large` ) ).
ENDMETHOD.
ENDCLASS.
More in sap.ui.table
- Basic — Basic example showing most controls which are intended to be used inside a table.
- Multi Header — Example for multi-header of table
- Row Modes — Example for the different row modes
- Row Highlights — Shows how row highlights and alternating row colors can be used.
- Column Resizing — Example for column resizing
- Aggregations — Example which shows the different aggregations of the table
- Drag and Drop — Shows various drag-and-drop capabilities along with custom context menu alternatives for…
- Filtering — Example showing the different facets of filtering within a table
- Table related Menus — Example which focuses the handling of the table related Menus
- MultiSelectionPlugin — Example showing the behavior of MultiSelectionPlugin
- OData — OData related example
- OData Metadata — Shows an example how an OData metadata driven table creation can look like.
On this page