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

Class InputView

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.InputView

All Implemented Interfaces:

Control, View

public class InputView
extends BoxView

InputView is used as a text input.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	InputView.InputViewTextChangeEvent
static final record	InputView.InputViewTextChangeEventArgs

Constructor Summary

Constructors

Constructor	Description
InputView()

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.
String	getInputText()	Get a current known input text.
KeyHandler	getKeyHandler()	Handles keys by dispatching registered command runnable into an event loop.
protected void	initInternal()	Internal init method called from AbstractView.init().

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, 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

InputView

public InputView()

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

getKeyHandler

public KeyHandler getKeyHandler()

Description copied from class: AbstractView

Handles keys by dispatching registered command runnable into an event loop. Override to change default behaviour.

Specified by:

getKeyHandler in interface View

Overrides:

getKeyHandler in class AbstractView

Returns:

a view key handler

See Also:

• KeyHandler

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

getInputText

public String getInputText()

Get a current known input text.

Returns:

current input text