Update docs

spring-shell-docs/modules/ROOT/nav.adoc

@@ -52,11 +52,19 @@
 *** xref:using-shell-components-ui-confirmation.adoc[]
 *** xref:using-shell-components-ui-singleselect.adoc[]
 *** xref:using-shell-components-ui-multiselect.adoc[]
-* xref:using-shell-tui.adoc[]
-** xref:using-shell-tui-intro.adoc[]
-** xref:using-shell-tui-views.adoc[]
-*** xref:using-shell-tui-views-box.adoc[]
-*** xref:using-shell-tui-views-list.adoc[]
+* xref:tui/index.adoc[]
+** xref:tui/intro/index.adoc[]
+** xref:tui/views/index.adoc[]
+*** xref:tui/views/box.adoc[]
+*** xref:tui/views/button.adoc[]
+*** xref:tui/views/dialog.adoc[]
+*** xref:tui/views/list.adoc[]
+*** xref:tui/views/menu.adoc[]
+*** xref:tui/views/menubar.adoc[]
+** xref:tui/events/index.adoc[]
+*** xref:tui/events/eventloop.adoc[]
+*** xref:tui/events/key.adoc[]
+*** xref:tui/events/mouse.adoc[]
 * xref:using-shell-customization.adoc[]
 ** xref:using-shell-customization-styling.adoc[]
 ** xref:using-shell-customization-logging.adoc[]
@@ -77,11 +85,6 @@
 *** xref:appendices-techical-intro-theming.adoc[]
 *** xref:appendices-techical-intro-searchalgorithm.adoc[]
 ** xref:appendices-debugging.adoc[]
-** xref:appendices-tui.adoc[]
-*** xref:appendices-tui-control.adoc[]
-*** xref:appendices-tui-view.adoc[]
-*** xref:appendices-tui-eventloop.adoc[]
-*** xref:appendices-tui-screen.adoc[]
-*** xref:appendices-tui-keyhandling.adoc[]
-*** xref:appendices-tui-mousehandling.adoc[]
-*** xref:appendices-tui-catalog.adoc[]
+** xref:appendices/tui/index.adoc[]
+*** xref:appendices/tui/viewdev.adoc[]
+*** xref:appendices/tui/catalog.adoc[]

spring-shell-docs/modules/ROOT/pages/appendices-tui-control.adoc

@@ -1,7 +0,0 @@
-[#appendix-tui-control]
-= Control
-:page-section-summary-toc: 1
-
-ifndef::snippets[:snippets: ../../test/java/org/springframework/shell/docs]
-
-_Control_ draws something into a screen with a given bounds.

spring-shell-docs/modules/ROOT/pages/appendices-tui-eventloop.adoc

@@ -1,7 +0,0 @@
-[#appendix-tui-eventloop]
-= EventLoop
-:page-section-summary-toc: 1
-
-ifndef::snippets[:snippets: ../../test/java/org/springframework/shell/docs]
-
-_EventLoop_ is a central system handling eventing in a framework.

spring-shell-docs/modules/ROOT/pages/appendices-tui-keyhandling.adoc

@@ -1,7 +0,0 @@
-[#appendix-tui-keyhandling]
-= Key Handling
-:page-section-summary-toc: 1
-
-ifndef::snippets[:snippets: ../../test/java/org/springframework/shell/docs]
-
-Handles incoming key events.

spring-shell-docs/modules/ROOT/pages/appendices-tui-mousehandling.adoc

@@ -1,7 +0,0 @@
-[#appendix-tui-mousehandling]
-= Mouse Handling
-:page-section-summary-toc: 1
-
-ifndef::snippets[:snippets: ../../test/java/org/springframework/shell/docs]
-
-Handles incoming mouse events.

spring-shell-docs/modules/ROOT/pages/appendices-tui-screen.adoc

@@ -1,8 +0,0 @@
-[#appendix-tui-screen]
-= Screen
-:page-section-summary-toc: 1
-
-ifndef::snippets[:snippets: ../../test/java/org/springframework/shell/docs]
-
-_Screen_ is an abstraction providing higher level concept to draw something
-into a terminal.

spring-shell-docs/modules/ROOT/pages/appendices-tui-view.adoc

@@ -1,7 +0,0 @@
-[#appendix-tui-view]
-= View
-:page-section-summary-toc: 1
-
-ifndef::snippets[:snippets: ../../test/java/org/springframework/shell/docs]
-
-_View_ extends _Control_ providing integration into event loop.

spring-shell-docs/modules/ROOT/pages/appendices/tui/catalog.adoc

@@ -2,7 +2,7 @@
 = Catalog App
 :page-section-summary-toc: 1
 
-ifndef::snippets[:snippets: ../../test/java/org/springframework/shell/docs]
+ifndef::snippets[:snippets: ../../../../../src/test/java/org/springframework/shell/docs]
 
 Catalog application is showing various ways how Terminal UI Framework can be used.
 In this section we discuss how this application works. It can be considered to be
@@ -12,4 +12,13 @@ to follow best practices.
 [[create-scenario]]
 == Create Scenario
 Every `Scenario` essentially is a sample code of a `View` as that's what catalog
-app demonstrates.
+app demonstrates. In the sample app create a new scenario class under
+_scenario_ package and implement it as something shown below.
+
+[source, java, indent=0]
+----
+include::{snippets}/CatalogSnippets.java[tag=samplescenario]
+----
+
+NOTE: You need to define all fields, `name`, `description` and `category`
+with _@ScenarioComponent_.

spring-shell-docs/modules/ROOT/pages/appendices/tui/viewdev.adoc

@@ -0,0 +1,11 @@
+[#appendix-tui-eventloop]
+= View Development
+:page-section-summary-toc: 1
+
+While a _view_ just need to implement `View` it's usually convenient to just
+use `BoxView` as a parent.
+
+== Register Bindings
+
+In an `AbstractView` use variants of _registerKeyBinding_, _registerHotKeyBinding_
+and _registerMouseBinding_.

spring-shell-docs/modules/ROOT/pages/tui/events/eventloop.adoc

@@ -0,0 +1,23 @@
+[[tui-events-eventloop]]
+= EventLoop
+:page-section-summary-toc: 1
+
+ifndef::snippets[:snippets: ../../../../../src/test/java/org/springframework/shell/docs]
+
+`EventLoop` is a central place where all eventing will be orchestrated for
+a lifecycle of a component. Orchestration is usually needed around timings
+of redraws and and component state updates.
+
+Everything in an event loop is represented as a Spring Message.
+
+[source, java, indent=0]
+----
+include::{snippets}/EventLoopSnippets.java[tag=plainevents]
+----
+
+Selecting key events use a build-in filtering method _keyEvents()_.
+
+[source, java, indent=0]
+----
+include::{snippets}/EventLoopSnippets.java[tag=keyevents]
+----

spring-shell-docs/modules/ROOT/pages/tui/events/index.adoc

@@ -0,0 +1,7 @@
+[[tui-events]]
+= Events
+:page-section-summary-toc: 1
+
+ifndef::snippets[:snippets: ../../../../test/java/org/springframework/shell/docs]
+
+This section contains information about eventing.

spring-shell-docs/modules/ROOT/pages/tui/events/key.adoc

@@ -0,0 +1,7 @@
+[[tui-events-key]]
+= Key Handling
+:page-section-summary-toc: 1
+
+ifndef::snippets[:snippets: ../../../../../src/test/java/org/springframework/shell/docs]
+
+tbd

spring-shell-docs/modules/ROOT/pages/tui/events/mouse.adoc

@@ -0,0 +1,7 @@
+[[tui-events-mouse]]
+= Mouse Handling
+:page-section-summary-toc: 1
+
+ifndef::snippets[:snippets: ../../../../../src/test/java/org/springframework/shell/docs]
+
+tbd

spring-shell-docs/modules/ROOT/pages/tui/index.adoc

@@ -0,0 +1,14 @@
+[[tui]]
+= Terminal UI
+:page-section-summary-toc: 1
+
+NOTE: Feature is experimental and subject to breaking changes until foundation
+and related concepts around framework are getting more stable.
+
+_Terminal UI Framework_ is a toolkit to build rich console apps. This section is
+for those using existing features as is. If you're planning to go deeper possibly
+creating your own components xref:appendices/tui/index.adoc[Terminal UI Appendix]
+provides more detailed documentation.
+
+TIP: xref:appendices/tui/catalog.adoc[Catalog Sample App] is a good place to
+study a real application.

spring-shell-docs/modules/ROOT/pages/tui/intro/index.adoc

@@ -1,8 +1,8 @@
-[[using-shell-tui-intro]]
+[[tui-introduction]]
 = Introduction
 :page-section-summary-toc: 1
 
-ifndef::snippets[:snippets: ../../test/java/org/springframework/shell/docs]
+ifndef::snippets[:snippets: ../../../../../src/test/java/org/springframework/shell/docs]
 
 Lets start with a simple app which prints "hello world" in a view.
 [source, java, indent=0]
@@ -12,3 +12,8 @@ include::{snippets}/TerminalUiSnippets.java[tag=snippet1]
 
 There is not much to see here other than `TerminalUI` is a class handling
 all logic aroung views and uses `View` as it's root view.
+
+[source, java, indent=0]
+----
+include::{snippets}/TerminalUiSnippets.java[tag=snippet2]
+----

spring-shell-docs/modules/ROOT/pages/tui/views/box.adoc

@@ -0,0 +1,14 @@
+[[tui-views-box]]
+= BoxView
+:page-section-summary-toc: 1
+
+ifndef::snippets[:snippets: ../../../../../src/test/java/org/springframework/shell/docs]
+
+_BoxView_ is a base implementation providing functionality to draw into a
+bounded _Rectancle_. Only direct use of it is its `drawFunction` which
+allows to do simple things without implementing a full custom `View`.
+
+[source, java, indent=0]
+----
+include::{snippets}/BoxViewSnippets.java[tag=sample]
+----

spring-shell-docs/modules/ROOT/pages/tui/views/button.adoc

@@ -0,0 +1,8 @@
+[[tui-views-button]]
+= ButtonView
+:page-section-summary-toc: 1
+
+ifndef::snippets[:snippets: ../../../../../src/test/java/org/springframework/shell/docs]
+
+_ButtonView_ is a base implementation providing functionality to draw a button.
+Inherits xref:tui/views/box.adoc[].

spring-shell-docs/modules/ROOT/pages/tui/views/dialog.adoc

@@ -0,0 +1,8 @@
+[[tui-views-dialog]]
+= DialogView
+:page-section-summary-toc: 1
+
+ifndef::snippets[:snippets: ../../../../../src/test/java/org/springframework/shell/docs]
+
+_DialogView_ is a base implementation providing functionality to draw a dialog.
+Inherits xref:tui/views/box.adoc[].

spring-shell-docs/modules/ROOT/pages/tui/views/index.adoc

@@ -0,0 +1,7 @@
+[[tui-views]]
+= Views
+:page-section-summary-toc: 1
+
+ifndef::snippets[:snippets: ../../../../test/java/org/springframework/shell/docs]
+
+Framework provides a build-in views which are documented below.

spring-shell-docs/modules/ROOT/pages/tui/views/list.adoc

@@ -0,0 +1,84 @@
+[[tui-views-list]]
+= ListView
+:page-section-summary-toc: 1
+
+ifndef::snippets[:snippets: ../../../../../src/test/java/org/springframework/shell/docs]
+
+_ListView_ is a base implementation providing functionality to draw a list of
+_items_. Inherits xref:tui/views/box.adoc[].
+
+_ListView<T>_ is typed as its _item_ and can take any object. Further _item_
+processing happens in a _CellFactory_. For conveniance there is a support
+for generic higher level list feature showing checked states as normal
+_check_ and _radio_ types. Essentially what you can have is a list of
+items which are shown as is, shown where any items can have a checked
+state or only one item can have a checked state.
+
+[source, java, indent=0]
+----
+include::{snippets}/ListViewSnippets.java[tag=snippet1]
+----
+
+Default _item style_ is nocheck but can be changed.
+
+Supports `NOCHECK``, `CHECK`` and `RADIO``
+
+[source, java, indent=0]
+----
+include::{snippets}/ListViewSnippets.java[tag=snippet2]
+----
+
+== Default Bindings
+
+Default _view commands_ are:
+
+[[tui-views-list-viewcommands]]
+.ViewCommands
+|===
+|Command |Description
+
+|LINE_UP
+|Selection moves up. Bound to _CursorUp_ and _WheelUp_.
+
+|LINE_DOWN
+|Selection moves down. Bound to _CursorDown_ and _WheelDown_.
+
+|===
+
+_Enter_ is choosing an active item. _Space_ is changing selection state.
+
+== Events
+
+Events are sent depending on a used list type.
+
+[[tui-views-list-events]]
+.ListView Events
+|===
+|Event |Description
+
+|ListViewOpenSelectedItemEvent
+|Active item is requested to get opened.
+
+|ListViewSelectedItemChangedEvent
+|Active item is changed.
+
+|===
+
+== Customisation
+
+How individual cells are shown depends on a _CellFactory_. Default implementation
+simply shows _item_ using its `toString()` method.
+
+It can be customised by modifying a used _CellFactory_.
+
+[source, java, indent=0]
+----
+include::{snippets}/ListViewSnippets.java[tag=listcell]
+----
+
+And set it as a factory:
+
+[source, java, indent=0]
+----
+include::{snippets}/ListViewSnippets.java[tag=uselistcell]
+----

spring-shell-docs/modules/ROOT/pages/tui/views/menu.adoc

@@ -0,0 +1,8 @@
+[[tui-views-menu]]
+= MenuView
+:page-section-summary-toc: 1
+
+ifndef::snippets[:snippets: ../../../../../src/test/java/org/springframework/shell/docs]
+
+_MenuView_ is a base implementation providing functionality to draw a menu.
+Inherits xref:tui/views/box.adoc[].

spring-shell-docs/modules/ROOT/pages/tui/views/menubar.adoc

@@ -0,0 +1,8 @@
+[[tui-views-menubar]]
+= MenuBarView
+:page-section-summary-toc: 1
+
+ifndef::snippets[:snippets: ../../../../../src/test/java/org/springframework/shell/docs]
+
+_MenuBarView_ is a base implementation providing functionality to draw a menu bar.
+Inherits xref:tui/views/box.adoc[].

spring-shell-docs/modules/ROOT/pages/using-shell-tui-views-box.adoc

@@ -1,8 +0,0 @@
-[[using-shell-tui-views-box]]
-= BoxView
-:page-section-summary-toc: 1
-
-ifndef::snippets[:snippets: ../../test/java/org/springframework/shell/docs]
-
-_BoxView_ is a base implementation providing functionality to draw into a
-bounded _Rectancle_.

spring-shell-docs/modules/ROOT/pages/using-shell-tui-views-list.adoc

@@ -1,7 +0,0 @@
-[[using-shell-tui-views-list]]
-= ListView
-:page-section-summary-toc: 1
-
-ifndef::snippets[:snippets: ../../test/java/org/springframework/shell/docs]
-
-_ListView_ is a base implementation providing functionality to draw list of items.

spring-shell-docs/modules/ROOT/pages/using-shell-tui-views.adoc

@@ -1,11 +0,0 @@
-[[using-shell-tui-views]]
-= Views
-:page-section-summary-toc: 1
-
-ifndef::snippets[:snippets: ../../test/java/org/springframework/shell/docs]
-
-Framework provides a build-in views which are documented below.
-
-TIP: To learn more about views, see xref:appendices-tui-view.adoc[View].
-
-

spring-shell-docs/modules/ROOT/pages/using-shell-tui.adoc

@@ -1,15 +0,0 @@
-[[using-shell-tui]]
-= Terminal UI
-:page-section-summary-toc: 1
-
-NOTE: Feature is experimental and subject to breaking changes until foundation
-      and related concepts around framework are getting more stable.
-
-_Terminal UI Framework_ is a toolkit to build rich console apps. This section is
-for those using existing features as is. If you're planning to go deeper possibly
-creating your own components xref:appendices-tui.adoc[Terminal UI] provides more detailed
-documentation.
-
-TIP: Catalog sample is a good place to study a real application xref:appendices-tui-catalog.adoc[Catalog App].
-
-