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

Class ProgressView

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

All Implemented Interfaces:

Control, View

public class ProgressView
extends BoxView

ProgressView is used to show a progress indicator. Defaults to

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ProgressView.ProgressContext	Context for ProgressView cell components.
static final record	ProgressView.ProgressState	Encapsulates a current running state of a ProgressView.
static final record	ProgressView.ProgressViewEndEvent	ViewEvent indicating that proggress has been ended.
static class	ProgressView.ProgressViewItem	Defines an item within a progress view.
static final record	ProgressView.ProgressViewStartEvent	ViewEvent indicating that proggress has been started.
static final record	ProgressView.ProgressViewStateChangeEvent	ViewEvent indicating that proggress state has been changed.
static final record	ProgressView.ProgressViewStateEventArgs	ViewEventArgs for events using ProgressView.ProgressState.

Constructor Summary

Constructors

Constructor	Description
ProgressView()	Construct view with tickStart 0 and tickEnd 100.
ProgressView(int tickStart, int tickEnd)	Construct view with tickStart 0 and tickEnd 100.
ProgressView(int tickStart, int tickEnd, ProgressView.ProgressViewItem... items)	Construct view with given bounds for tickStart and tickEnd.
ProgressView(ProgressView.ProgressViewItem... items)	Construct view with given ProgressView.ProgressViewItems using tickStart 0 and tickEnd 100.

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	getDescription()	Gets a progress description.
ProgressView.ProgressState	getState()	Gets a state of this ProgressView.
void	setDescription(String description)	Sets a progress description.
void	setSpinner(Spinner spinner)	Sets an explicit spinner to use.
void	setTickValue(int value)	Sets a tick value.
void	start()	Starts a runtime logic.
void	stop()	Stops a runtime logic.
void	tickAdvance(int count)	Advance tickValue by a given count.

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

ProgressView

public ProgressView()

Construct view with tickStart 0 and tickEnd 100. Uses default ProgressView.ProgressViewItems.

ProgressView

public ProgressView(int tickStart,
 int tickEnd)

Construct view with tickStart 0 and tickEnd 100. Uses default ProgressView.ProgressViewItems.

Parameters:

tickStart - the tick start

tickEnd - the tick end

ProgressView

public ProgressView(ProgressView.ProgressViewItem... items)

Construct view with given ProgressView.ProgressViewItems using tickStart 0 and tickEnd 100.

Parameters:

items - the progress view items

ProgressView

public ProgressView(int tickStart,
 int tickEnd,
 ProgressView.ProgressViewItem... items)

Construct view with given bounds for tickStart and tickEnd. tickStart needs to be equal or more than zero. tickEnd needs to be higher than tickStart. Uses defined progress view items.

Parameters:

tickStart - the tick start

tickEnd - the tick end

items - the progress view items

Method Details

getDescription

public String getDescription()

Gets a progress description.

Returns:

a progress description

setDescription

public void setDescription(String description)

Sets a progress description. Used in items as a text item.

Parameters:

description - the progress description

setSpinner

public void setSpinner(Spinner spinner)

Sets an explicit spinner to use.

Parameters:

spinner - the spinner to use

start

public void start()

Starts a runtime logic. Call to already started progress has no effect.

stop

public void stop()

Stops a runtime logic.

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

tickAdvance

public void tickAdvance(int count)

Advance tickValue by a given count. Note that negative count will advance backwards.

Parameters:

count - the count to advance tick value

setTickValue

public void setTickValue(int value)

Sets a tick value. If value is lower or higher than tickStart or tickEnd respectively tickValue will be set to low/high bounds. This means tickValue is always kept within range inclusively.

Parameters:

value - the new tick value to set

getState

public ProgressView.ProgressState getState()

Gets a state of this ProgressView.

Returns:

a view progress state