From f4eec7b809dd40ac5c924e7e64344fc5282e7523 Mon Sep 17 00:00:00 2001
From: Janne Valkealahti <janne.valkealahti@gmail.com>
Date: Sun, 8 Oct 2023 15:16:20 +0100
Subject: [PATCH] Update docs

---
 spring-shell-docs/modules/ROOT/nav.adoc       |  1 +
 .../modules/ROOT/pages/tui/views/grid.adoc    | 31 ++++++++++++++
 .../shell/docs/GridViewSnippets.java          | 40 +++++++++++++++++++
 3 files changed, 72 insertions(+)
 create mode 100644 spring-shell-docs/modules/ROOT/pages/tui/views/grid.adoc
 create mode 100644 spring-shell-docs/src/test/java/org/springframework/shell/docs/GridViewSnippets.java

diff --git a/spring-shell-docs/modules/ROOT/nav.adoc b/spring-shell-docs/modules/ROOT/nav.adoc
index 9d9dc2679..6aa88cd5d 100644
--- a/spring-shell-docs/modules/ROOT/nav.adoc
+++ b/spring-shell-docs/modules/ROOT/nav.adoc
@@ -59,6 +59,7 @@
 *** xref:tui/views/box.adoc[]
 *** xref:tui/views/button.adoc[]
 *** xref:tui/views/dialog.adoc[]
+*** xref:tui/views/grid.adoc[]
 *** xref:tui/views/list.adoc[]
 *** xref:tui/views/menu.adoc[]
 *** xref:tui/views/menubar.adoc[]
diff --git a/spring-shell-docs/modules/ROOT/pages/tui/views/grid.adoc b/spring-shell-docs/modules/ROOT/pages/tui/views/grid.adoc
new file mode 100644
index 000000000..26a3d3033
--- /dev/null
+++ b/spring-shell-docs/modules/ROOT/pages/tui/views/grid.adoc
@@ -0,0 +1,31 @@
+= GridView
+:page-section-summary-toc: 1
+
+ifndef::snippets[:snippets: ../../../../../src/test/java/org/springframework/shell/docs]
+
+_GridView_ is a special type of view and its purpose is to layout other views
+using a grid layout algorithms. Inherits xref:tui/views/box.adoc[].
+
+[source, java, indent=0]
+----
+include::{snippets}/GridViewSnippets.java[tag=snippet1]
+----
+
+Will result layout of:
+
+[source, text, indent=0]
+----
+┌---┬---┐
+|   |   |
+|   |   |
+├---┼---┤
+|   |   |
+|   |   |
+└---┴---┘
+----
+
+== Default Bindings
+Does not have any default bindings.
+
+== Events
+Does not have any events.
diff --git a/spring-shell-docs/src/test/java/org/springframework/shell/docs/GridViewSnippets.java b/spring-shell-docs/src/test/java/org/springframework/shell/docs/GridViewSnippets.java
new file mode 100644
index 000000000..797a908a9
--- /dev/null
+++ b/spring-shell-docs/src/test/java/org/springframework/shell/docs/GridViewSnippets.java
@@ -0,0 +1,40 @@
+/*
+ * 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.control.BoxView;
+import org.springframework.shell.component.view.control.GridView;
+
+class GridViewSnippets {
+
+	class Dump1 {
+
+		void dump1() {
+			// tag::snippet1[]
+			GridView grid = new GridView();
+			grid.setShowBorders(true);
+			grid.setRowSize(0, 0);
+			grid.setColumnSize(0, 0);
+
+			grid.addItem(new BoxView(), 0, 0, 1, 1, 0, 0);
+			grid.addItem(new BoxView(), 0, 1, 1, 1, 0, 0);
+			grid.addItem(new BoxView(), 1, 0, 1, 1, 0, 0);
+			grid.addItem(new BoxView(), 1, 1, 1, 1, 0, 0);
+			// end::snippet1[]
+		}
+	}
+
+}