diff --git a/SAMPLES.md b/SAMPLES.md index fedc736d..40c3a6f8 100644 --- a/SAMPLES.md +++ b/SAMPLES.md @@ -40,10 +40,10 @@ ready-to-run apps** the README leads with. | Sample | Class | |---|---| -| **Basics I** — Hello World, the Smallest App
The smallest app that runs: one class, one view_display( ), a Page with a title - the shape every other sample starts from.
hello world smallest first app minimal start here template
docs: [get_started/hello_world](https://abap2ui5.github.io/docs/get_started/hello_world), [cookbook/view/definition](https://abap2ui5.github.io/docs/cookbook/view/definition), [cookbook/expert_more/snippets](https://abap2ui5.github.io/docs/cookbook/expert_more/snippets) | [`Z2UI5_CL_SMP_APP_493`](src/01/z2ui5_cl_smp_app_493.clas.abap) | -| **Basics II** — Data Binding: Input and Button
Binds a class attribute to an Input with _bind( ), so what the user types is in the ABAP variable on the next roundtrip and a Text shows it back.
binding _bind model attribute value input button serialize
docs: [cookbook/model/binding](https://abap2ui5.github.io/docs/cookbook/model/binding) | [`Z2UI5_CL_SMP_APP_494`](src/01/z2ui5_cl_smp_app_494.clas.abap) | -| **Basics III** — Lifecycle: Init, Event, Navigated
The three questions main( ) asks - init, event, navigated - as one dispatcher, showing what survives a roundtrip and what a navigation does to it.
lifecycle roundtrip main dispatcher state serialize check_on_init check_on_event check_on_navigated
docs: [cookbook/event_navigation/life_cycle](https://abap2ui5.github.io/docs/cookbook/event_navigation/life_cycle), [cookbook/expert_more/snippets](https://abap2ui5.github.io/docs/cookbook/expert_more/snippets) | [`Z2UI5_CL_SMP_APP_495`](src/01/z2ui5_cl_smp_app_495.clas.abap) | -| **Basics IV** — Events, Views and Roundtrips
What one event does to a running app: a second view replaces the first, the state comes back with it, and an uncaught error surfaces where you can see it.
roundtrip restart second view uncaught error controller basics
docs: [cookbook/event_navigation/life_cycle](https://abap2ui5.github.io/docs/cookbook/event_navigation/life_cycle), [cookbook/expert_more/snippets](https://abap2ui5.github.io/docs/cookbook/expert_more/snippets) | [`Z2UI5_CL_SMP_APP_004`](src/01/z2ui5_cl_smp_app_004.clas.abap) | +| **Basics I** — Hello World, the Smallest App
The smallest app that runs: one class, one view_display( ), a Page with a title - the shape every other sample starts from.
hello world smallest first app minimal start here template
docs: [get_started/hello_world](https://abap2ui5.github.io/docs/get_started/hello_world), [cookbook/view/definition](https://abap2ui5.github.io/docs/cookbook/view/definition), [cookbook/expert_more/snippets](https://abap2ui5.github.io/docs/cookbook/expert_more/snippets), [tutorials/walkthrough/step-1](https://abap2ui5.github.io/docs/tutorials/walkthrough/step-1) | [`Z2UI5_CL_SMP_APP_493`](src/01/z2ui5_cl_smp_app_493.clas.abap) | +| **Basics II** — Data Binding: Input and Button
Binds a class attribute to an Input with _bind( ), so what the user types is in the ABAP variable on the next roundtrip and a Text shows it back.
binding _bind model attribute value input button serialize
docs: [cookbook/model/binding](https://abap2ui5.github.io/docs/cookbook/model/binding), [tutorials/walkthrough/step-4](https://abap2ui5.github.io/docs/tutorials/walkthrough/step-4) | [`Z2UI5_CL_SMP_APP_494`](src/01/z2ui5_cl_smp_app_494.clas.abap) | +| **Basics III** — Lifecycle: Init, Event, Navigated
The three questions main( ) asks - init, event, navigated - as one dispatcher, showing what survives a roundtrip and what a navigation does to it.
lifecycle roundtrip main dispatcher state serialize check_on_init check_on_event check_on_navigated
docs: [cookbook/event_navigation/life_cycle](https://abap2ui5.github.io/docs/cookbook/event_navigation/life_cycle), [cookbook/expert_more/snippets](https://abap2ui5.github.io/docs/cookbook/expert_more/snippets), [tutorials/walkthrough/step-3](https://abap2ui5.github.io/docs/tutorials/walkthrough/step-3) | [`Z2UI5_CL_SMP_APP_495`](src/01/z2ui5_cl_smp_app_495.clas.abap) | +| **Basics IV** — Events, Views and Roundtrips
What one event does to a running app: a second view replaces the first, the state comes back with it, and an uncaught error surfaces where you can see it.
roundtrip restart second view uncaught error controller basics
docs: [cookbook/event_navigation/life_cycle](https://abap2ui5.github.io/docs/cookbook/event_navigation/life_cycle), [cookbook/expert_more/snippets](https://abap2ui5.github.io/docs/cookbook/expert_more/snippets), [tutorials/walkthrough/step-3](https://abap2ui5.github.io/docs/tutorials/walkthrough/step-3) | [`Z2UI5_CL_SMP_APP_004`](src/01/z2ui5_cl_smp_app_004.clas.abap) | | **Basics V** — The Developer Tools (Ctrl+F12)
What Ctrl+F12 opens: the request and response payload, the generated XML view, the model, the source and the error log - the first place to look when something does not render.
developer tools devtools ctrl f12 debug inspect payload previous request response view xml view model source code log error adt export
docs: [cookbook/troubleshooting/common_failures](https://abap2ui5.github.io/docs/cookbook/troubleshooting/common_failures) | [`Z2UI5_CL_SMP_APP_496`](src/01/z2ui5_cl_smp_app_496.clas.abap) | ### Binding @@ -104,7 +104,7 @@ ready-to-run apps** the README leads with. | Sample | Class | |---|---| | Control Objects in t_arg (FacetFilter)
Passes whole control objects to the backend in t_arg: a FacetFilter's selected items arrive as data instead of being reconstructed by hand.
facetfilter filter object marshalling selected items
docs: [cookbook/event_navigation/backend](https://abap2ui5.github.io/docs/cookbook/event_navigation/backend) | [`Z2UI5_CL_SMP_APP_197`](src/01/z2ui5_cl_smp_app_197.clas.abap) | -| Extra Arguments with t_arg
Sends extra arguments with an event (t_arg), so a handler knows which row, which value or which fixed payload it was called for.
argument parameter payload event data fixed value
docs: [cookbook/event_navigation/backend](https://abap2ui5.github.io/docs/cookbook/event_navigation/backend) | [`Z2UI5_CL_SMP_APP_167`](src/01/z2ui5_cl_smp_app_167.clas.abap) | +| Extra Arguments with t_arg
Sends extra arguments with an event (t_arg), so a handler knows which row, which value or which fixed payload it was called for.
argument parameter payload event data fixed value
docs: [cookbook/event_navigation/backend](https://abap2ui5.github.io/docs/cookbook/event_navigation/backend), [tutorials/walkthrough/step-6](https://abap2ui5.github.io/docs/tutorials/walkthrough/step-6) | [`Z2UI5_CL_SMP_APP_167`](src/01/z2ui5_cl_smp_app_167.clas.abap) | | Keyboard Shortcuts, Ctrl+S (A)
Binds keyboard shortcuts such as Ctrl+S to backend events, so the app answers a key combination the way a desktop program would.
shortcut hotkey ctrl key combination keyboard_shortcut
docs: [cookbook/browser_interaction/keyboard_shortcuts](https://abap2ui5.github.io/docs/cookbook/browser_interaction/keyboard_shortcuts) | [`Z2UI5_CL_SMP_APP_471`](src/01/z2ui5_cl_smp_app_471.clas.abap) | | Link with preventDefault (A)
A Link whose default browser action is suppressed (check_prevent_default), so the app handles the click instead of the href.
link href default action check_prevent_default
docs: [cookbook/event_navigation/frontend](https://abap2ui5.github.io/docs/cookbook/event_navigation/frontend) | [`Z2UI5_CL_SMP_APP_472`](src/01/z2ui5_cl_smp_app_472.clas.abap) | @@ -138,7 +138,7 @@ ready-to-run apps** the README leads with. | Sample | Class | |---|---| | Events on Cell Level
Events on cell level in a grid table: which row and which column the user was in, and what arrives in the backend.
cell enter row index event grid alv
docs: [cookbook/model/tables](https://abap2ui5.github.io/docs/cookbook/model/tables) | [`Z2UI5_CL_SMP_APP_160`](src/01/z2ui5_cl_smp_app_160.clas.abap) | -| Full Example with sap.ui.table
The full sap.ui.table example: a DynamicPage with search, sort, filter, currency columns and row actions - the closest thing here to a finished ALV.
grid alv dynamicpage column row action currency search sort filter
docs: [get_started/full_example](https://abap2ui5.github.io/docs/get_started/full_example), [cookbook/model/tables](https://abap2ui5.github.io/docs/cookbook/model/tables) | [`Z2UI5_CL_SMP_APP_070`](src/01/z2ui5_cl_smp_app_070.clas.abap) | +| Full Example with sap.ui.table
The full sap.ui.table example: a DynamicPage with search, sort, filter, currency columns and row actions - the closest thing here to a finished ALV.
grid alv dynamicpage column row action currency search sort filter
docs: [get_started/full_example](https://abap2ui5.github.io/docs/get_started/full_example), [cookbook/model/tables](https://abap2ui5.github.io/docs/cookbook/model/tables), [tutorials/walkthrough/step-8](https://abap2ui5.github.io/docs/tutorials/walkthrough/step-8) | [`Z2UI5_CL_SMP_APP_070`](src/01/z2ui5_cl_smp_app_070.clas.abap) | | Keep Column Filters on Refresh (C)
Keeps the active sap.ui.table column filters across a view model update, through the abap2UI5 uitableext custom control - without it they are reset.
column filter reset refresh uitableext grid alv
docs: [cookbook/model/tables](https://abap2ui5.github.io/docs/cookbook/model/tables) | [`Z2UI5_CL_SMP_APP_143`](src/01/z2ui5_cl_smp_app_143.clas.abap) | ### List @@ -147,7 +147,7 @@ ready-to-run apps** the README leads with. |---|---| | Filter and Sort the Binding from ABAP (A)
Sorts and filters a bound list from ABAP by calling getBinding on the control - the binding does the work, not a rebuilt table.
binding_call getbinding sorter filter follow_up_action | [`Z2UI5_CL_SMP_APP_454`](src/01/z2ui5_cl_smp_app_454.clas.abap) | | Live Filter on the Client, No Roundtrip (A)
Filters a list live on the client as the user types - no roundtrip, no backend, the same binding_call from the view chain.
binding_call live search client side no roundtrip filter | [`Z2UI5_CL_SMP_APP_455`](src/01/z2ui5_cl_smp_app_455.clas.abap) | -| StandardListItem, Highlight and Events
A sap.m.List of StandardListItems: highlight, info state, press events and what a selection sends back.
sap.m.list standardlistitem highlight infostate press selection | [`Z2UI5_CL_SMP_APP_048`](src/01/z2ui5_cl_smp_app_048.clas.abap) | +| StandardListItem, Highlight and Events
A sap.m.List of StandardListItems: highlight, info state, press events and what a selection sends back.
sap.m.list standardlistitem highlight infostate press selection
docs: [tutorials/walkthrough/step-5](https://abap2ui5.github.io/docs/tutorials/walkthrough/step-5) | [`Z2UI5_CL_SMP_APP_048`](src/01/z2ui5_cl_smp_app_048.clas.abap) | ### Menu @@ -204,7 +204,7 @@ ready-to-run apps** the README leads with. | Element Binding to the Selected Row (A)
Element binding on a popup: the dialog binds RELATIVELY to the row that was pressed, so its fields need no path of their own.
element binding relative path aggregation dialog row
docs: [cookbook/event_navigation/frontend](https://abap2ui5.github.io/docs/cookbook/event_navigation/frontend), [cookbook/popup_popover/popup](https://abap2ui5.github.io/docs/cookbook/popup_popover/popup) | [`Z2UI5_CL_SMP_APP_470`](src/01/z2ui5_cl_smp_app_470.clas.abap) | | Navigate between Dialogs (NavContainer) (A)
A NavContainer inside a dialog: several pages in one popup, with back and forward between them.
navcontainer dialog pages back forward
docs: [cookbook/popup_popover/popup](https://abap2ui5.github.io/docs/cookbook/popup_popover/popup) | [`Z2UI5_CL_SMP_APP_170`](src/01/z2ui5_cl_smp_app_170.clas.abap) | | Value Help: Suggestions and F4 Dialog
The value help, both halves: suggestions while typing and the F4 dialog behind the field, over the same data.
f4 search help suggestion input dialog select
docs: [cookbook/popup_popover/popup](https://abap2ui5.github.io/docs/cookbook/popup_popover/popup), [cookbook/expert_more/value_help](https://abap2ui5.github.io/docs/cookbook/expert_more/value_help) | [`Z2UI5_CL_SMP_APP_009`](src/01/z2ui5_cl_smp_app_009.clas.abap) | -| Ways to Open a Dialog (A)
The ways to open a dialog - from this app, from a sub app, rebuilt or destroyed - and what each one does to the view behind it.
dialog sub app destroy rerender background view
docs: [cookbook/popup_popover/popup](https://abap2ui5.github.io/docs/cookbook/popup_popover/popup) | [`Z2UI5_CL_SMP_APP_012`](src/01/z2ui5_cl_smp_app_012.clas.abap) | +| Ways to Open a Dialog (A)
The ways to open a dialog - from this app, from a sub app, rebuilt or destroyed - and what each one does to the view behind it.
dialog sub app destroy rerender background view
docs: [cookbook/popup_popover/popup](https://abap2ui5.github.io/docs/cookbook/popup_popover/popup), [tutorials/walkthrough/step-7](https://abap2ui5.github.io/docs/tutorials/walkthrough/step-7) | [`Z2UI5_CL_SMP_APP_012`](src/01/z2ui5_cl_smp_app_012.clas.abap) | ### Scroll diff --git a/src/01/z2ui5_cl_smp_app_004.clas.abap b/src/01/z2ui5_cl_smp_app_004.clas.abap index e30ec441..47a550b0 100644 --- a/src/01/z2ui5_cl_smp_app_004.clas.abap +++ b/src/01/z2ui5_cl_smp_app_004.clas.abap @@ -1,6 +1,6 @@ " @keywords roundtrip restart second view uncaught error controller basics " @summary What one event does to a running app: a second view replaces the first, the state comes back with it, and an uncaught error surfaces where you can see it. -" @docs https://abap2ui5.github.io/docs/cookbook/event_navigation/life_cycle https://abap2ui5.github.io/docs/cookbook/expert_more/snippets +" @docs https://abap2ui5.github.io/docs/cookbook/event_navigation/life_cycle https://abap2ui5.github.io/docs/cookbook/expert_more/snippets https://abap2ui5.github.io/docs/tutorials/walkthrough/step-3 CLASS z2ui5_cl_smp_app_004 DEFINITION PUBLIC. PUBLIC SECTION. diff --git a/src/01/z2ui5_cl_smp_app_012.clas.abap b/src/01/z2ui5_cl_smp_app_012.clas.abap index c5de9eb0..14c9e1f4 100644 --- a/src/01/z2ui5_cl_smp_app_012.clas.abap +++ b/src/01/z2ui5_cl_smp_app_012.clas.abap @@ -1,6 +1,6 @@ " @keywords dialog sub app destroy rerender background view " @summary The ways to open a dialog - from this app, from a sub app, rebuilt or destroyed - and what each one does to the view behind it. -" @docs https://abap2ui5.github.io/docs/cookbook/popup_popover/popup +" @docs https://abap2ui5.github.io/docs/cookbook/popup_popover/popup https://abap2ui5.github.io/docs/tutorials/walkthrough/step-7 CLASS z2ui5_cl_smp_app_012 DEFINITION PUBLIC. PUBLIC SECTION. diff --git a/src/01/z2ui5_cl_smp_app_048.clas.abap b/src/01/z2ui5_cl_smp_app_048.clas.abap index 60047f5f..c4266f93 100644 --- a/src/01/z2ui5_cl_smp_app_048.clas.abap +++ b/src/01/z2ui5_cl_smp_app_048.clas.abap @@ -1,5 +1,6 @@ " @keywords sap.m.list standardlistitem highlight infostate press selection " @summary A sap.m.List of StandardListItems: highlight, info state, press events and what a selection sends back. +" @docs https://abap2ui5.github.io/docs/tutorials/walkthrough/step-5 CLASS z2ui5_cl_smp_app_048 DEFINITION PUBLIC. PUBLIC SECTION. diff --git a/src/01/z2ui5_cl_smp_app_070.clas.abap b/src/01/z2ui5_cl_smp_app_070.clas.abap index b3116f2a..703f2640 100644 --- a/src/01/z2ui5_cl_smp_app_070.clas.abap +++ b/src/01/z2ui5_cl_smp_app_070.clas.abap @@ -1,6 +1,6 @@ " @keywords grid alv dynamicpage column row action currency search sort filter " @summary The full sap.ui.table example: a DynamicPage with search, sort, filter, currency columns and row actions - the closest thing here to a finished ALV. -" @docs https://abap2ui5.github.io/docs/get_started/full_example https://abap2ui5.github.io/docs/cookbook/model/tables +" @docs https://abap2ui5.github.io/docs/get_started/full_example https://abap2ui5.github.io/docs/cookbook/model/tables https://abap2ui5.github.io/docs/tutorials/walkthrough/step-8 CLASS z2ui5_cl_smp_app_070 DEFINITION PUBLIC. PUBLIC SECTION. diff --git a/src/01/z2ui5_cl_smp_app_167.clas.abap b/src/01/z2ui5_cl_smp_app_167.clas.abap index b7ffdb02..a5323824 100644 --- a/src/01/z2ui5_cl_smp_app_167.clas.abap +++ b/src/01/z2ui5_cl_smp_app_167.clas.abap @@ -1,6 +1,6 @@ " @keywords argument parameter payload event data fixed value " @summary Sends extra arguments with an event (t_arg), so a handler knows which row, which value or which fixed payload it was called for. -" @docs https://abap2ui5.github.io/docs/cookbook/event_navigation/backend +" @docs https://abap2ui5.github.io/docs/cookbook/event_navigation/backend https://abap2ui5.github.io/docs/tutorials/walkthrough/step-6 CLASS z2ui5_cl_smp_app_167 DEFINITION PUBLIC. PUBLIC SECTION. diff --git a/src/01/z2ui5_cl_smp_app_493.clas.abap b/src/01/z2ui5_cl_smp_app_493.clas.abap index f16f38cb..bbbbe642 100644 --- a/src/01/z2ui5_cl_smp_app_493.clas.abap +++ b/src/01/z2ui5_cl_smp_app_493.clas.abap @@ -1,6 +1,6 @@ " @keywords hello world smallest first app minimal start here template " @summary The smallest app that runs: one class, one view_display( ), a Page with a title - the shape every other sample starts from. -" @docs https://abap2ui5.github.io/docs/get_started/hello_world https://abap2ui5.github.io/docs/cookbook/view/definition https://abap2ui5.github.io/docs/cookbook/expert_more/snippets +" @docs https://abap2ui5.github.io/docs/get_started/hello_world https://abap2ui5.github.io/docs/cookbook/view/definition https://abap2ui5.github.io/docs/cookbook/expert_more/snippets https://abap2ui5.github.io/docs/tutorials/walkthrough/step-1 CLASS z2ui5_cl_smp_app_493 DEFINITION PUBLIC. PUBLIC SECTION. diff --git a/src/01/z2ui5_cl_smp_app_494.clas.abap b/src/01/z2ui5_cl_smp_app_494.clas.abap index 9d67c552..9a104e45 100644 --- a/src/01/z2ui5_cl_smp_app_494.clas.abap +++ b/src/01/z2ui5_cl_smp_app_494.clas.abap @@ -1,6 +1,6 @@ " @keywords binding _bind model attribute value input button serialize " @summary Binds a class attribute to an Input with _bind( ), so what the user types is in the ABAP variable on the next roundtrip and a Text shows it back. -" @docs https://abap2ui5.github.io/docs/cookbook/model/binding +" @docs https://abap2ui5.github.io/docs/cookbook/model/binding https://abap2ui5.github.io/docs/tutorials/walkthrough/step-4 CLASS z2ui5_cl_smp_app_494 DEFINITION PUBLIC. PUBLIC SECTION. diff --git a/src/01/z2ui5_cl_smp_app_495.clas.abap b/src/01/z2ui5_cl_smp_app_495.clas.abap index ea6424a4..19b99bff 100644 --- a/src/01/z2ui5_cl_smp_app_495.clas.abap +++ b/src/01/z2ui5_cl_smp_app_495.clas.abap @@ -1,6 +1,6 @@ " @keywords lifecycle roundtrip main dispatcher state serialize check_on_init check_on_event check_on_navigated " @summary The three questions main( ) asks - init, event, navigated - as one dispatcher, showing what survives a roundtrip and what a navigation does to it. -" @docs https://abap2ui5.github.io/docs/cookbook/event_navigation/life_cycle https://abap2ui5.github.io/docs/cookbook/expert_more/snippets +" @docs https://abap2ui5.github.io/docs/cookbook/event_navigation/life_cycle https://abap2ui5.github.io/docs/cookbook/expert_more/snippets https://abap2ui5.github.io/docs/tutorials/walkthrough/step-3 CLASS z2ui5_cl_smp_app_495 DEFINITION PUBLIC. PUBLIC SECTION.