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

Class DialogView

java.lang.Object

org.springframework.shell.component.view.control.AbstractControl

org.springframework.shell.component.view.control.AbstractView

org.springframework.shell.component.view.control.WindowView

org.springframework.shell.component.view.control.DialogView

All Implemented Interfaces:

Control, View

public class DialogView
extends WindowView

DialogView is a View with border, number of buttons and area for a generic content.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	DialogView.DialogViewCloseEvent
static final record	DialogView.DialogViewItemEventArgs

Constructor Summary

Constructors

Constructor	Description
DialogView()
DialogView(View content, List<ButtonView> buttons)
DialogView(View content, ButtonView... buttons)

Method Summary

Modifier and Type	Method	Description
protected void	drawInternal(Screen screen)	Component internal drawing method.
protected String	getBackgroundStyle()
MouseHandler	getMouseHandler()	Handles mouse events by dispatching registered consumers into an event loop.
void	setEventLoop(EventLoop eventLoop)	Set an EventLoop.
void	setLayer(int index)	Sets a layer index this View operates on.
void	setRect(int x, int y, int width, int height)	Sets bounds where this Control should operate.

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

getInnerRect, setBackgroundColor

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

destroy, dispatch, dispatchKeyRunCommand, dispatchMouseRunCommand, dispatchRunnable, draw, drawBackground, 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, 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

DialogView

public DialogView()

DialogView

public DialogView(View content,
 ButtonView... buttons)

DialogView

public DialogView(View content,
 List<ButtonView> buttons)

Method Details

setEventLoop

public void setEventLoop(EventLoop eventLoop)

Description copied from class: AbstractView

Set an EventLoop.

Specified by:

setEventLoop in interface View

Overrides:

setEventLoop in class AbstractView

Parameters:

eventLoop - the event loop

getBackgroundStyle

protected String getBackgroundStyle()

Overrides:

getBackgroundStyle in class WindowView

setLayer

public void setLayer(int index)

Description copied from interface: View

Sets a layer index this View operates on.

Specified by:

setLayer in interface View

Overrides:

setLayer in class AbstractView

Parameters:

index - the layer index

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

setRect

public void setRect(int x,
 int y,
 int width,
 int height)

Description copied from interface: Control

Sets bounds where this Control should operate.

Specified by:

setRect in interface Control

Overrides:

setRect in class AbstractControl

Parameters:

x - a x coord of a bounded box

y - an y coord of a bounded box

width - a width of a bounded box

height - a height of a bounded box

drawInternal

protected void drawInternal(Screen screen)

Description copied from class: AbstractView

Component internal drawing method. Implementing classes needs to define this method to draw something into a Screen.

Overrides:

drawInternal in class WindowView

Parameters:

screen - the screen