Uses of Interface
org.springframework.shell.component.view.control.View

Packages that use View

Package	Description
org.springframework.shell.component
org.springframework.shell.component.message
org.springframework.shell.component.view
org.springframework.shell.component.view.control
org.springframework.shell.component.view.event

Uses of View in org.springframework.shell.component

Methods in org.springframework.shell.component with parameters of type View

Modifier and Type	Method	Description
ViewComponent	ViewComponentBuilder.build(View view)	Build a new ViewComponent instance and configure it using this builder.

Constructors in org.springframework.shell.component with parameters of type View

Modifier	Constructor	Description
	ViewComponent(TerminalUI terminalUI, org.jline.terminal.Terminal terminal, ViewComponentExecutor viewComponentExecutor, View view)	Construct view component with a given Terminal and View.

Uses of View in org.springframework.shell.component.message

Methods in org.springframework.shell.component.message that return View

Modifier and Type	Method	Description
View	ShellMessageHeaderAccessor.getView()
static View	StaticShellMessageHeaderAccessor.getView(org.springframework.messaging.Message<?> message)

Methods in org.springframework.shell.component.message with parameters of type View

Modifier and Type	Method	Description
static org.springframework.messaging.Message<?>	ShellMessageBuilder.ofView(View view, Object args)
static org.springframework.messaging.Message<String>	ShellMessageBuilder.ofViewFocus(String action, View view)
ShellMessageBuilder<T>	ShellMessageBuilder.setView(View view)

Uses of View in org.springframework.shell.component.view

Methods in org.springframework.shell.component.view that return View

Modifier and Type	Method	Description
View	TerminalUI.getModal()

Methods in org.springframework.shell.component.view with parameters of type View

Modifier and Type	Method	Description
void	TerminalUI.configure(View view)	Configure view for EventLoop, ThemeResolver, theme name and ViewService.
void	TerminalUI.setFocus(View view)
void	TerminalUI.setModal(View view)
void	TerminalUI.setRoot(View root, boolean fullScreen)	Sets a root view.

Method parameters in org.springframework.shell.component.view with type arguments of type View

Modifier and Type	Method	Description
void	TerminalUI.setFullScreenViewRect(BiFunction<org.jline.terminal.Terminal,View,Rectangle> fullScreenViewRect)	Sets a view rect function for full screen mode.
void	TerminalUI.setNonfullScreenViewRect(BiFunction<org.jline.terminal.Terminal,View,Rectangle> nonfullScreenViewRect)	Sets a view rect function for full screen mode.

Uses of View in org.springframework.shell.component.view.control

Classes in org.springframework.shell.component.view.control that implement View

Modifier and Type	Class	Description
class	AbstractView	Base implementation of a View and its parent interface Control providing some common functionality for implementations.
class	AppView	AppView provides an opinionated terminal UI application view controlling main viewing area, menubar, statusbar and modal window system.
class	BoxView	BoxView is a View with an empty background and optional border and title.
class	ButtonView	ButtonView is a View with border and text acting as a button.
class	DialogView	DialogView is a View with border, number of buttons and area for a generic content.
class	GridView	GridView is a layout container with no initial views.
class	InputView	InputView is used as a text input.
class	ListView<T>	ListView is a View showing items in a vertical list.
class	MenuBarView	MenuBarView shows items horizontally and is typically used in layouts which builds complete terminal UI's.
class	MenuView	MenuView shows MenuView items vertically and is typically used in layouts which builds complete terminal UI's.
class	ProgressView	ProgressView is used to show a progress indicator.
class	StatusBarView	StatusBarView shows items horizontally and is typically used in layouts which builds complete terminal UI's.
class	WindowView	WindowView is a View defining area within view itself.

Methods in org.springframework.shell.component.view.control that return View

Modifier and Type	Method	Description
View	ViewService.getModal()	Gets a current modal view.
View	AppView.AppViewEvent.view()	Returns the value of the view record component.
View	ButtonView.ButtonViewSelectEvent.view()	Returns the value of the view record component.
View	DialogView.DialogViewCloseEvent.view()	Returns the value of the view record component.
View	InputView.InputViewTextChangeEvent.view()	Returns the value of the view record component.
View	ListView.ListViewOpenSelectedItemEvent.view()	Returns the value of the view record component.
View	ListView.ListViewSelectedItemChangedEvent.view()	Returns the value of the view record component.
View	MenuView.MenuViewOpenSelectedItemEvent.view()	Returns the value of the view record component.
View	MenuView.MenuViewSelectedItemChangedEvent.view()	Returns the value of the view record component.
View	ProgressView.ProgressViewEndEvent.view()	Returns the value of the view record component.
View	ProgressView.ProgressViewStartEvent.view()	Returns the value of the view record component.
View	ProgressView.ProgressViewStateChangeEvent.view()	Returns the value of the view record component.
View	StatusBarView.StatusBarViewOpenSelectedItemEvent.view()	Returns the value of the view record component.
View	ViewDoneEvent.GenericViewDoneEvent.view()	Returns the value of the view record component.
View	ViewEvent.view()

Methods in org.springframework.shell.component.view.control with parameters of type View

Modifier and Type	Method	Description
GridView	GridView.addItem(View view, int row, int column, int rowSpan, int colSpan, int minGridHeight, int minGridWidth)	Adds a View and its position to the grid.
void	AbstractView.focus(View view, boolean focus)
void	View.focus(View view, boolean focus)	Called when View gets or loses a focus.
static AppView.AppViewEvent	AppView.AppViewEvent.of(View view, AppView.AppViewEventArgs.Direction direction)
static ButtonView.ButtonViewSelectEvent	ButtonView.ButtonViewSelectEvent.of(View view)
static DialogView.DialogViewCloseEvent	DialogView.DialogViewCloseEvent.of(View view)
static InputView.InputViewTextChangeEvent	InputView.InputViewTextChangeEvent.of(View view, String oldText, String newText)
static <T> ListView.ListViewOpenSelectedItemEvent<T>	ListView.ListViewOpenSelectedItemEvent.of(View view, T item)
static <T> ListView.ListViewSelectedItemChangedEvent<T>	ListView.ListViewSelectedItemChangedEvent.of(View view, T item)
static MenuView.MenuViewOpenSelectedItemEvent	MenuView.MenuViewOpenSelectedItemEvent.of(View view, MenuView.MenuItem item)
static MenuView.MenuViewSelectedItemChangedEvent	MenuView.MenuViewSelectedItemChangedEvent.of(View view, MenuView.MenuItem item)
static ProgressView.ProgressViewEndEvent	ProgressView.ProgressViewEndEvent.of(View view, ProgressView.ProgressState state)
static ProgressView.ProgressViewStartEvent	ProgressView.ProgressViewStartEvent.of(View view, ProgressView.ProgressState state)
static ProgressView.ProgressViewStateChangeEvent	ProgressView.ProgressViewStateChangeEvent.of(View view, ProgressView.ProgressState state)
static StatusBarView.StatusBarViewOpenSelectedItemEvent	StatusBarView.StatusBarViewOpenSelectedItemEvent.of(View view, StatusBarView.StatusItem item)
static ViewDoneEvent	ViewDoneEvent.of(View view)	Create a generic event with empty view args.
void	ViewService.setFocus(View view)	Sets a view to be focused.
void	ViewService.setModal(View view)	Sets a new modal view.

Constructors in org.springframework.shell.component.view.control with parameters of type View

Modifier	Constructor	Description
	AppView(View main, View menuBar, View statusBar)
	AppViewEvent(View view, AppView.AppViewEventArgs args)	Creates an instance of a AppViewEvent record class.
	ButtonViewSelectEvent(View view, ButtonView.ButtonViewItemEventArgs args)	Creates an instance of a ButtonViewSelectEvent record class.
	DialogView(View content, List<ButtonView> buttons)
	DialogView(View content, ButtonView... buttons)
	DialogViewCloseEvent(View view, DialogView.DialogViewItemEventArgs args)	Creates an instance of a DialogViewCloseEvent record class.
	GenericViewDoneEvent(View view, ViewEventArgs args)	Creates an instance of a GenericViewDoneEvent record class.
	InputViewTextChangeEvent(View view, InputView.InputViewTextChangeEventArgs args)	Creates an instance of a InputViewTextChangeEvent record class.
	ListViewOpenSelectedItemEvent(View view, ListView.ListViewItemEventArgs<T> args)	Creates an instance of a ListViewOpenSelectedItemEvent record class.
	ListViewSelectedItemChangedEvent(View view, ListView.ListViewItemEventArgs<T> args)	Creates an instance of a ListViewSelectedItemChangedEvent record class.
	MenuViewOpenSelectedItemEvent(View view, MenuView.MenuViewItemEventArgs args)	Creates an instance of a MenuViewOpenSelectedItemEvent record class.
	MenuViewSelectedItemChangedEvent(View view, MenuView.MenuViewItemEventArgs args)	Creates an instance of a MenuViewSelectedItemChangedEvent record class.
	ProgressViewEndEvent(View view, ProgressView.ProgressViewStateEventArgs args)	Creates an instance of a ProgressViewEndEvent record class.
	ProgressViewStartEvent(View view, ProgressView.ProgressViewStateEventArgs args)	Creates an instance of a ProgressViewStartEvent record class.
	ProgressViewStateChangeEvent(View view, ProgressView.ProgressViewStateEventArgs args)	Creates an instance of a ProgressViewStateChangeEvent record class.
	StatusBarViewOpenSelectedItemEvent(View view, StatusBarView.StatusBarViewItemEventArgs args)	Creates an instance of a StatusBarViewOpenSelectedItemEvent record class.

Uses of View in org.springframework.shell.component.view.event

Methods in org.springframework.shell.component.view.event that return View

Modifier and Type	Method	Description
View	KeyHandler.KeyHandlerResult.capture()	Returns the value of the capture record component.
View	MouseHandler.MouseHandlerResult.capture()	Returns the value of the capture record component.
View	KeyHandler.KeyHandlerResult.focus()	Returns the value of the focus record component.
View	MouseHandler.MouseHandlerResult.focus()	Returns the value of the focus record component.

Methods in org.springframework.shell.component.view.event with parameters of type View

Modifier and Type	Method	Description
static KeyHandler.KeyHandlerResult	KeyHandler.resultOf(KeyEvent event, boolean consumed, View focus)	Construct KeyHandler.KeyHandlerResult from a KeyEvent and a View.
static MouseHandler.MouseHandlerResult	MouseHandler.resultOf(MouseEvent event, boolean consumed, View focus, View capture)	Construct MouseHandler.MouseHandlerResult from a MouseEvent and a View.
<T extends ViewEvent> reactor.core.publisher.Flux<T>	DefaultEventLoop.viewEvents(Class<T> clazz, View filterBy)
<T extends ViewEvent> reactor.core.publisher.Flux<T>	DefaultEventLoop.viewEvents(org.springframework.core.ParameterizedTypeReference<T> typeRef, View filterBy)
<T extends ViewEvent> reactor.core.publisher.Flux<T>	EventLoop.viewEvents(Class<T> clazz, View filterBy)	Specialisation of EventLoop.events() which returns type safe ViewEvents.
<T extends ViewEvent> reactor.core.publisher.Flux<T>	EventLoop.viewEvents(org.springframework.core.ParameterizedTypeReference<T> typeRef, View filterBy)	Specialisation of EventLoop.events() which returns type safe ViewEvents.

Constructors in org.springframework.shell.component.view.event with parameters of type View

Modifier	Constructor	Description
	KeyHandlerResult(KeyEvent event, boolean consumed, View focus, View capture)	Creates an instance of a KeyHandlerResult record class.
	MouseHandlerResult(MouseEvent event, boolean consumed, View focus, View capture)	Creates an instance of a MouseHandlerResult record class.