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

Class ListView<T>

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.ListView<T>

All Implemented Interfaces:

Control, View

public class ListView<T>
extends BoxView

ListView is a View showing items in a vertical list.

Supported view commands:

• ViewCommand.LINE_UP - Move active line upwards.
• ViewCommand.LINE_DOWN - Move active line downwards.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	ListView.ItemStyle	Specifies how a item shows selection state.
static final record	ListView.ListViewItemEventArgs<T>	ViewEventArgs for ListView.ListViewOpenSelectedItemEvent and ListView.ListViewSelectedItemChangedEvent.
static final record	ListView.ListViewOpenSelectedItemEvent<T>	ViewEvent indicating that selected item has been requested to open.
static final record	ListView.ListViewSelectedItemChangedEvent<T>	ViewEvent indicating that selected item has changed.

Constructor Summary

Constructors

Constructor	Description
ListView()
ListView(List<T> items, ListView.ItemStyle itemStyle)
ListView(ListView.ItemStyle itemStyle)
ListView(T[] items, ListView.ItemStyle itemStyle)

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.
ListView.ItemStyle	getItemStyle()
protected void	initInternal()	Internal init method called from AbstractView.init().
void	setCellFactory(BiFunction<ListView<T>,T,ListCell<T>> factory)
void	setItems(List<T> items)

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

ListView

public ListView()

ListView

public ListView(ListView.ItemStyle itemStyle)

ListView

public ListView(T[] items,
 ListView.ItemStyle itemStyle)

ListView

public ListView(@Nullable
 List<T> items,
 ListView.ItemStyle itemStyle)

Method Details

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

getItemStyle

public ListView.ItemStyle getItemStyle()

setItems

public void setItems(@Nullable
 List<T> items)

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

setCellFactory

public void setCellFactory(BiFunction<ListView<T>,T,ListCell<T>> factory)