Update hotkey docs

- Relates #826
This commit is contained in:
Janne Valkealahti
2023-12-10 09:52:35 +00:00
parent b1084a62ee
commit 90df641750
4 changed files with 59 additions and 0 deletions

View File

@@ -5,6 +5,7 @@
While a _view_ just need to implement `View` it's usually convenient to just
use `BoxView` as a parent.
[[register-bindings]]
== Register Bindings
In an `AbstractView` use variants of _registerKeyBinding_, _registerHotKeyBinding_

View File

@@ -15,3 +15,7 @@ include::{snippets}/KeyHandlingSnippets.java[tag=sample]
`KeyEvent` is a record containing info about a binding coming out
from a terminal.
Some views allow you to register hot keys which are processed before
normal key handling. More about this can be found from
xref:appendices/tui/viewdev.adoc#register-bindings[Register Bindings].

View File

@@ -14,6 +14,15 @@ Inherits xref:tui/views/box.adoc[].
└─────────────────────────────┘
----
_MenuBarView_ is constructed with instances of _MenuBarItem_. _MenuBarItem_ itself
takes instances of _MenuItem_. _MenuItem_ can define its style and action.
_MenuBarItem_ can also define a hot key which is used to active particular menu.
[source, java, indent=0]
----
include::{snippets}/MenuBarViewSnippets.java[tag=snippet1]
----
== Default Bindings
Default _key bindigs_ are:

View File

@@ -0,0 +1,45 @@
/*
* 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.MenuBarView;
import org.springframework.shell.component.view.control.MenuBarView.MenuBarItem;
import org.springframework.shell.component.view.control.MenuView.MenuItem;
import org.springframework.shell.component.view.control.MenuView.MenuItemCheckStyle;
import org.springframework.shell.component.view.event.KeyEvent.Key;
import org.springframework.shell.component.view.event.KeyEvent.KeyMask;
public class MenuBarViewSnippets {
class Dump1 {
@SuppressWarnings("unused")
void dump1() {
// tag::snippet1[]
Runnable quitAction = () -> {};
Runnable aboutAction = () -> {};
MenuBarView menuBar = MenuBarView.of(
MenuBarItem.of("File",
MenuItem.of("Quit", MenuItemCheckStyle.NOCHECK, quitAction))
.setHotKey(Key.f | KeyMask.AltMask),
MenuBarItem.of("Help",
MenuItem.of("About", MenuItemCheckStyle.NOCHECK, aboutAction))
);
// end::snippet1[]
}
}
}