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

Class StatusBarView

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

All Implemented Interfaces:

Control, View

public class StatusBarView
extends BoxView

StatusBarView shows items horizontally and is typically used in layouts which builds complete terminal UI's. item primary denotes if item is drawn to left or right, priority on which order items are drawn until bar runs out of space. Default primary is true and priority is 0.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	StatusBarView.StatusBarViewItemEventArgs	ViewEventArgs for StatusBarView.StatusBarViewOpenSelectedItemEvent.
static final record	StatusBarView.StatusBarViewOpenSelectedItemEvent	ViewEvent indicating that selected item has been requested to open.
static class	StatusBarView.StatusItem	StatusBarView.StatusItem represents an item in a StatusBarView.

Constructor Summary

Constructors

Constructor	Description
StatusBarView()
StatusBarView(List<StatusBarView.StatusItem> items)
StatusBarView(StatusBarView.StatusItem[] 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.
protected String	getBackgroundStyle()
List<StatusBarView.StatusItem>	getItems()	Gets a status items.
String	getItemSeparator()	Gets the item separator.
MouseHandler	getMouseHandler()	Handles mouse events by dispatching registered consumers into an event loop.
void	setItems(List<StatusBarView.StatusItem> items)	Sets items.
void	setItemSeparator(String itemSeparator)	Sets the item separator.

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, getKeyHandler, getLayer, getMouseBindings, getViewCommands, getViewService, hasFocus, init, initInternal, 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

StatusBarView

public StatusBarView()

StatusBarView

public StatusBarView(StatusBarView.StatusItem[] items)

StatusBarView

public StatusBarView(List<StatusBarView.StatusItem> items)

Method Details

getBackgroundStyle

protected String getBackgroundStyle()

Overrides:

getBackgroundStyle in class BoxView

getItemSeparator

@Nullable
public String getItemSeparator()

Gets the item separator.

Returns:

a separator

setItemSeparator

public void setItemSeparator(@Nullable
 String itemSeparator)

Sets the item separator. Separator can be null or empty which essentially disables it.

Parameters:

itemSeparator - the item separator

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

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

setItems

public void setItems(List<StatusBarView.StatusItem> items)

Sets items.

Parameters:

items - status items

getItems

public List<StatusBarView.StatusItem> getItems()

Gets a status items.

Returns:

the status items