Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
jvalkeal committed Oct 8, 2023
1 parent b6d1958 commit f4eec7b
Show file tree
Hide file tree
Showing 3 changed files with 72 additions and 0 deletions.
1 change: 1 addition & 0 deletions spring-shell-docs/modules/ROOT/nav.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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[]
Expand Down
31 changes: 31 additions & 0 deletions spring-shell-docs/modules/ROOT/pages/tui/views/grid.adoc
Original file line number Diff line number Diff line change
@@ -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.
Original file line number Diff line number Diff line change
@@ -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[]
}
}

}

0 comments on commit f4eec7b

Please sign in to comment.