Update docs

spring-shell-docs/src/test/java/org/springframework/shell/docs/KeyHandlingSnippets.java

@@ -0,0 +1,33 @@
+/*
+ * Copyright 2023 the original author or authors.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.springframework.shell.docs;
+
+import org.springframework.shell.component.view.event.EventLoop;
+import org.springframework.shell.component.view.event.KeyEvent;
+
+class KeyHandlingSnippets {
+
+	EventLoop eventLoop;
+
+	void dump1() {
+		// tag::sample[]
+		eventLoop.keyEvents().subscribe((KeyEvent event) -> {
+			// do something with key event
+		});
+		// end::sample[]
+	}
+
+}

spring-shell-docs/src/test/java/org/springframework/shell/docs/MouseHandlingSnippets.java

@@ -0,0 +1,33 @@
+/*
+ * Copyright 2023 the original author or authors.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.springframework.shell.docs;
+
+import org.springframework.shell.component.view.event.EventLoop;
+import org.springframework.shell.component.view.event.MouseEvent;
+
+class MouseHandlingSnippets {
+
+	EventLoop eventLoop;
+
+	void dump1() {
+		// tag::sample[]
+		eventLoop.mouseEvents().subscribe((MouseEvent event) -> {
+			// do something with mouse event
+		});
+		// end::sample[]
+	}
+
+}

spring-shell-docs/src/test/java/org/springframework/shell/docs/TerminalUiSnippets.java

@@ -20,6 +20,7 @@ import org.jline.terminal.Terminal;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.shell.component.message.ShellMessageBuilder;
 import org.springframework.shell.component.view.TerminalUI;
+import org.springframework.shell.component.view.TerminalUIBuilder;
 import org.springframework.shell.component.view.control.BoxView;
 import org.springframework.shell.component.view.event.EventLoop;
 import org.springframework.shell.component.view.event.KeyEvent.Key;
@@ -28,14 +29,14 @@ import org.springframework.shell.geom.VerticalAlign;
 
 class TerminalUiSnippets {
 
-	class Sample1 {
+	class SampleIntro {
 
-		// tag::snippet1[]
+		// tag::introsample[]
 		@Autowired
-		Terminal terminal;
+		TerminalUIBuilder builder;
 
 		void sample() {
-			TerminalUI ui = new TerminalUI(terminal);
+			TerminalUI ui = builder.build();
 			BoxView view = new BoxView();
 			view.setDrawFunction((screen, rect) -> {
 				screen.writerBuilder()
@@ -46,33 +47,12 @@ class TerminalUiSnippets {
 			ui.setRoot(view, true);
 			ui.run();
 		}
-		// end::snippet1[]
-	}
-
-	class Sample2 {
-
-		// tag::snippet2[]
-		@Autowired
-		Terminal terminal;
-
-		void sample() {
-			TerminalUI ui = new TerminalUI(terminal);
-			BoxView view = new BoxView();
-			view.setDrawFunction((screen, rect) -> {
-				screen.writerBuilder()
-					.build()
-					.text("Hello World", rect, HorizontalAlign.CENTER, VerticalAlign.CENTER);
-				return rect;
-			});
-			ui.setRoot(view, false);
-			ui.run();
-		}
-		// end::snippet2[]
+		// end::introsample[]
 	}
 
 	class Sample3 {
 
-		// tag::snippet3[]
+		// tag::exitingfromloop[]
 		@Autowired
 		Terminal terminal;
 
@@ -89,7 +69,44 @@ class TerminalUiSnippets {
 				});
 			ui.run();
 		}
-		// end::snippet3[]
+		// end::exitingfromloop[]
+	}
+
+	@SuppressWarnings("unused")
+	class SampleUiAutowire {
+
+		// tag::uibuilderautowire[]
+		@Autowired
+		TerminalUIBuilder builder;
+
+		void sample() {
+			TerminalUI ui = builder.build();
+			// do something with ui
+		}
+		// end::uibuilderautowire[]
+	}
+
+	class SampleConfigureView {
+
+		// tag::configureview[]
+		TerminalUI ui;
+
+		void sample() {
+			BoxView view = new BoxView();
+			ui.configure(view);
+		}
+		// end::configureview[]
+	}
+
+	class SampleUiLoop {
+
+		// tag::uirun[]
+		TerminalUI ui;
+
+		void sample() {
+			ui.run();
+		}
+		// end::uirun[]
 	}
 
 }