Package org.springframework.shell.component.view.screen

Interface Screen

All Known Implementing Classes:

DefaultScreen

public interface Screen

Screen is representing a virtual area which is sitting between a user and lower level jline terminal providing convenient methods working with visible content.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	Screen.Writer	Interface to write into a Screen.
static interface	Screen.WriterBuilder	Builder interface for a Screen.Writer.

Method Summary

Modifier and Type	Method	Description
Screen	clip(int x, int y, int width, int height)	Clip a screen with a given bounds.
Position	getCursorPosition()	Gets a cursor position.
ScreenItem[][]	getItems()	Gets a screen items.
boolean	isShowCursor()	Gets if cursor is visible.
void	resize(int rows, int columns)	Resize a screen.
void	setCursorPosition(Position position)	Sets a cursor position.
void	setShowCursor(boolean show)	Sets if cursor should be visible.
Screen.WriterBuilder	writerBuilder()	Gets a new instance of a Screen.WriterBuilder.

Method Details

setShowCursor

void setShowCursor(boolean show)

Sets if cursor should be visible.

Parameters:

show - true if cursor should be visible

isShowCursor

boolean isShowCursor()

Gets if cursor is visible.

Returns:

true if cursor is visible

setCursorPosition

void setCursorPosition(Position position)

Sets a cursor position.

Parameters:

position - new cursor position

getCursorPosition

Position getCursorPosition()

Gets a cursor position.

Returns:

cursor position

writerBuilder

Screen.WriterBuilder writerBuilder()

Gets a new instance of a Screen.WriterBuilder.

Returns:

a new writer builder

resize

void resize(int rows,
 int columns)

Resize a screen.

Parameters:

rows - the new row count

columns - the new column count

getItems

ScreenItem[][] getItems()

Gets a screen items.

Returns:

a screen items

clip

Screen clip(int x,
 int y,
 int width,
 int height)

Clip a screen with a given bounds.

Parameters:

x - the x coordinate

y - the y coordinate

width - the width

height - the height

Returns:

new clipped screen