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

Class ButtonView

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

All Implemented Interfaces:

Control, View

public class ButtonView
extends BoxView

ButtonView is a View with border and text acting as a button.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	ButtonView.ButtonViewItemEventArgs
static final record	ButtonView.ButtonViewSelectEvent

Constructor Summary

Constructors

Constructor	Description
ButtonView()
ButtonView(String text)
ButtonView(String text, Runnable action)

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.
protected String	getBackgroundStyle()
KeyHandler	getKeyHandler()	Handles keys by dispatching registered command runnable into an event loop.
MouseHandler	getMouseHandler()	Handles mouse events by dispatching registered consumers into an event loop.
Dimension	getPreferredDimension()
protected void	initInternal()	Internal init method called from AbstractView.init().
void	setAction(Runnable action)
void	setText(String text)

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

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

ButtonView

public ButtonView()

ButtonView

public ButtonView(String text)

ButtonView

public ButtonView(String text,
 Runnable action)

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

getMouseHandler

public MouseHandler getMouseHandler()

Description copied from class: AbstractView

Handles mouse events by dispatching registered consumers into an event loop. Override to change default behaviour.

Specified by:

getMouseHandler in interface View

Overrides:

getMouseHandler in class AbstractView

Returns:

a view mouse handler

See Also:

• MouseHandler

getBackgroundStyle

protected String getBackgroundStyle()

Overrides:

getBackgroundStyle in class BoxView

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

getPreferredDimension

public Dimension getPreferredDimension()

setText

public void setText(String text)

setAction

public void setAction(Runnable action)