Package org.springframework.shell.component.view.control

Class MenuView

java.lang.Object

org.springframework.shell.component.view.control.AbstractControl

org.springframework.shell.component.view.control.AbstractView

org.springframework.shell.component.view.control.BoxView

org.springframework.shell.component.view.control.MenuView

All Implemented Interfaces:

Control, View

public class MenuView
extends BoxView

MenuView shows MenuView items vertically and is typically used in layouts which builds complete terminal UI's.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	MenuView.Menu	MenuView.Menu represents an item in a MenuView being a specialisation of MenuView.MenuItem indicating it having a sub-menu.
static class	MenuView.MenuItem	MenuView.MenuItem represents an item in a MenuView.
static enum	MenuView.MenuItemCheckStyle	Specifies how a MenuView.MenuItem shows selection state.
static final record	MenuView.MenuViewItemEventArgs	ViewEventArgs for MenuView.MenuViewOpenSelectedItemEvent and MenuView.MenuViewSelectedItemChangedEvent.
static final record	MenuView.MenuViewOpenSelectedItemEvent	ViewEvent indicating that selected item has been requested to open.
static final record	MenuView.MenuViewSelectedItemChangedEvent	ViewEvent indicating that selected item has changed.

Constructor Summary

Constructors

Constructor	Description
MenuView()	Construct menu view with no initial menu items.
MenuView(List<MenuView.MenuItem> items)	Construct menu view with menu items.
MenuView(MenuView.MenuItem[] items)	Construct menu view with menu items.

Method Summary

Modifier and Type	Method	Description
protected void	drawInternal(Screen screen)	Possibly draws a box around this view and title in a box top boundary.
List<MenuView.MenuItem>	getItems()	Gets a menu items.
Dimension	getPreferredDimension()	Gets a preferred dimension menu needs to show it's content.
protected void	initInternal()	Internal init method called from AbstractView.init().
void	setItems(List<MenuView.MenuItem> items)	Sets a new menu items.
void	toggle(MenuView.MenuItem item)	Toggle MenuView.MenuItem checked state.

Methods inherited from class org.springframework.shell.component.view.control.BoxView

drawBackground, getBackgroundStyle, getInnerRect, isShowBorder, setBackgroundColor, setBorderPadding, setFocusedTitleColor, setFocusedTitleStyle, setRect, setShowBorder, setTitle, setTitleAlign, setTitleColor, setTitleStyle

Methods inherited from class org.springframework.shell.component.view.control.AbstractView

destroy, dispatch, dispatchKeyRunCommand, dispatchMouseRunCommand, dispatchRunnable, draw, focus, getDrawFunction, getEventLoop, getHotKeyBindings, getHotKeyHandler, getKeyBindings, getKeyHandler, getLayer, getMouseBindings, getMouseHandler, getViewCommands, getViewService, hasFocus, init, onDestroy, registerHotKeyBinding, registerHotKeyBinding, registerHotKeyBinding, registerKeyBinding, registerKeyBinding, registerKeyBinding, registerMouseBinding, registerMouseBinding, registerMouseBinding, registerViewCommand, runViewCommand, setDrawFunction, setEventLoop, setLayer, setViewService, shortcut

Methods inherited from class org.springframework.shell.component.view.control.AbstractControl

getRect, getThemeName, getThemeResolver, resolveThemeBackground, resolveThemeForeground, resolveThemeSpinner, resolveThemeStyle, setThemeName, setThemeResolver

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.springframework.shell.component.view.control.Control

getRect, setThemeName, setThemeResolver

Constructor Details

MenuView

public MenuView()

Construct menu view with no initial menu items.

MenuView

public MenuView(MenuView.MenuItem[] items)

Construct menu view with menu items.

Parameters:

items - the menu items

MenuView

public MenuView(@Nullable
 List<MenuView.MenuItem> items)

Construct menu view with menu items.

Parameters:

items - the menu items

Method Details

setItems

public void setItems(@Nullable
 List<MenuView.MenuItem> items)

Sets a new menu items. Will always clear existing items and if null is passed this effectively keeps items empty.

Parameters:

items - the menu items

getItems

public List<MenuView.MenuItem> getItems()

Gets a menu items.

Returns:

the menu items

getPreferredDimension

public Dimension getPreferredDimension()

Gets a preferred dimension menu needs to show it's content.

Returns:

preferred dimension

drawInternal

protected void drawInternal(Screen screen)

Description copied from class: BoxView

Possibly draws a box around this view and title in a box top boundary. Also calls a draw function if defined.

Overrides:

drawInternal in class BoxView

Parameters:

screen - the screen

initInternal

protected void initInternal()

Description copied from class: AbstractView

Internal init method called from AbstractView.init(). Override to do something usefull. Typically key and mousebindings are registered from this method.

Overrides:

initInternal in class AbstractView

toggle

public void toggle(MenuView.MenuItem item)

Toggle MenuView.MenuItem checked state.

Parameters:

item - the menu item to toggle