com.googlecode.lanterna.gui

Class GUIScreen

java.lang.Object

com.googlecode.lanterna.gui.GUIScreen

public class GUIScreen
extends Object

This is the main class of the GUI system in Lanterna. To setup a GUI, you instantiate this class and call the showWindow(...) method on window. Please notice that this class doesn't have any start or stop methods, this must be managed by the underlying screen which is the backend for the GUI.

Author:

Martin

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GUIScreen.Position Where to position a window that is to be put on the screen

Field Summary

Fields

Modifier and Type	Field and Description
protected Queue<Action>	actionToRunInEventThread

Constructor Summary

Constructors

Constructor and Description
GUIScreen(Screen screen)
GUIScreen(Screen screen, GUIScreenBackgroundRenderer backgroundRenderer)
GUIScreen(Screen screen, String title)

Method Summary

Methods

Modifier and Type	Method and Description
void	closeWindow() Deprecated. Call getActiveWindow().close() instead
protected void	closeWindow(Window window) Used internally to close a window; API users should call Window.close() instead
protected void	doEventLoop()
protected Queue<Action>	getActionsToRunInEventThreadQueue()
Window	getActiveWindow() Returns the top window in the window stack, the one which currently has user input focus.
GUIScreenBackgroundRenderer	getBackgroundRenderer()
Screen	getScreen() Gets the underlying screen, which can be used for starting, stopping, querying for size and much more
void	invalidate() Signals the the entire screen needs to be re-drawn
boolean	isInEventThread()
void	runInEventThread(Action codeToRun) Since Lanterna isn't thread safe, here's a way to run code on the same thread as the GUI system is using.
void	setBackgroundRenderer(GUIScreenBackgroundRenderer backgroundRenderer)
void	setTheme(Theme newTheme) Sets a new Theme for the entire GUI
void	setTitle(String title) Deprecated. Use a GUI background renderer instead
void	showWindow(Window window) Same as calling showWindow(window, Position.OVERLAPPING)
void	showWindow(Window window, GUIScreen.Position position) This method starts the GUI system with an initial window.
protected boolean	update()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

actionToRunInEventThread

protected final Queue<Action> actionToRunInEventThread

Constructor Detail

GUIScreen

public GUIScreen(Screen screen)

GUIScreen

public GUIScreen(Screen screen,
         String title)

GUIScreen

public GUIScreen(Screen screen,
         GUIScreenBackgroundRenderer backgroundRenderer)

Method Detail

setTitle

@Deprecated
public void setTitle(String title)

Deprecated. Use a GUI background renderer instead

Parameters:

title - Title to be displayed in the top-left corner

setTheme

public void setTheme(Theme newTheme)

Sets a new Theme for the entire GUI

setBackgroundRenderer

public void setBackgroundRenderer(GUIScreenBackgroundRenderer backgroundRenderer)

getBackgroundRenderer

public GUIScreenBackgroundRenderer getBackgroundRenderer()

getScreen

public Screen getScreen()

Gets the underlying screen, which can be used for starting, stopping, querying for size and much more

Returns:

The Screen which is backing this GUI

update

protected boolean update()

getActionsToRunInEventThreadQueue

protected Queue<Action> getActionsToRunInEventThreadQueue()

invalidate

public void invalidate()

Signals the the entire screen needs to be re-drawn

doEventLoop

protected void doEventLoop()

showWindow

public void showWindow(Window window)

Same as calling showWindow(window, Position.OVERLAPPING)

Parameters:

window - Window to be shown

showWindow

public void showWindow(Window window,
              GUIScreen.Position position)

This method starts the GUI system with an initial window. The method does not return until the window has been closed, so you need to provide a mechanism for closing the window using the GUI. If you call this method when already in GUI mode, it will create the new window stacked on top of any previous window(s) and won't return until this new window has been closed.

Parameters:

window - Window to display

position - Where to position the new window

closeWindow

@Deprecated
public void closeWindow()

Deprecated. Call getActiveWindow().close() instead

closeWindow

protected void closeWindow(Window window)

Used internally to close a window; API users should call Window.close() instead

getActiveWindow

public Window getActiveWindow()

Returns the top window in the window stack, the one which currently has user input focus.

Returns:

The uppermost window in the window stack, or null if there are no windows

runInEventThread

public void runInEventThread(Action codeToRun)

Since Lanterna isn't thread safe, here's a way to run code on the same thread as the GUI system is using. Pass an action in and it will be queued for execution.

Parameters:

codeToRun - Code to be executed on the same thread as the GUI

isInEventThread

public boolean isInEventThread()

Returns:

True if the current thread calling this method is the same thread as the GUI system is using