com.googlecode.lanterna.gui

Class Window

java.lang.Object

com.googlecode.lanterna.gui.Window

Direct Known Subclasses:

ActionListDialog, FileDialog, MessageBox, TextInputDialog, WaitingDialog

public class Window
extends Object

The Window class is the basis for Lanternas GUI system. The workflow is to create and show modal windows and promt the user for input. A window, once displayed, will take over control by entering an event loop and won't come back until the window is closed.

Author:

Martin

Constructor Summary

Constructors

Constructor and Description
Window(String title) Creates a new window

Method Summary

Methods

Modifier and Type	Method and Description
void	addComponent(Component component, LayoutParameter... layoutParameters)
void	addContainerListener(ContainerListener cl)
void	addEmptyLine() Deprecated.
void	addWindowListener(WindowListener listener)
void	close()
Border	getBorder()
Component	getComponentAt(int index)
int	getComponentCount()
protected Interactable	getInputFocusedComponent()
GUIScreen	getOwner()
TerminalSize	getWindowSizeOverride() Returns the current window size override or null if none is set
boolean	isDrawShadow()
boolean	isSoloWindow()
protected void	onClosed()
void	onKeyPressed(Key key)
protected void	onVisible()
void	removeAllComponents() Removes all components from the window
void	removeComponent(Component component) Removes a top-level component from the window
void	removeContainerListener(ContainerListener cl)
void	setBorder(Border border)
void	setDrawShadow(boolean drawShadow)
protected void	setFocus(Interactable newFocus)
protected void	setFocus(Interactable newFocus, Interactable.FocusChangeDirection direction)
void	setSoloWindow(boolean soloWindow) If set to true, when this window is shown, all previous windows are hidden.
void	setWindowSizeOverride(TerminalSize windowSizeOverride) Sets the size of the window to a fixed value, rather than using automatic size calculation.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

Window

public Window(String title)

Creates a new window

Parameters:

title - Title for the new window

Method Detail

addWindowListener

public void addWindowListener(WindowListener listener)

getOwner

public GUIScreen getOwner()

Returns:

The GUIScreen which this window is displayed on

getBorder

public Border getBorder()

Returns:

The border of this window

setBorder

public void setBorder(Border border)

getWindowSizeOverride

public TerminalSize getWindowSizeOverride()

Returns the current window size override or null if none is set

Returns:

Override for the window size or null

setWindowSizeOverride

public void setWindowSizeOverride(TerminalSize windowSizeOverride)

Sets the size of the window to a fixed value, rather than using automatic size calculation. If you call this method with windowSizeOverride parameter set to null, the automatic size calculation will be activated again.

Parameters:

windowSizeOverride - Size the window should have, or null if you want to use automatic size calculation

addEmptyLine

@Deprecated
public void addEmptyLine()

Deprecated.

Don't use the method, call addComponent(new EmptySpace(1, 1)) instead

addComponent

public void addComponent(Component component,
                LayoutParameter... layoutParameters)

addContainerListener

public void addContainerListener(ContainerListener cl)

removeContainerListener

public void removeContainerListener(ContainerListener cl)

getComponentAt

public Component getComponentAt(int index)

getComponentCount

public int getComponentCount()

Returns:

How many top-level components this window has

removeComponent

public void removeComponent(Component component)

Removes a top-level component from the window

Parameters:

component - Top-level component to remove

removeAllComponents

public void removeAllComponents()

Removes all components from the window

onKeyPressed

public void onKeyPressed(Key key)

isSoloWindow

public boolean isSoloWindow()

setSoloWindow

public void setSoloWindow(boolean soloWindow)

If set to true, when this window is shown, all previous windows are hidden. Set to false to show them again.

isDrawShadow

public boolean isDrawShadow()

setDrawShadow

public void setDrawShadow(boolean drawShadow)

setFocus

protected void setFocus(Interactable newFocus)

setFocus

protected void setFocus(Interactable newFocus,
            Interactable.FocusChangeDirection direction)

getInputFocusedComponent

protected Interactable getInputFocusedComponent()

close

public void close()

onVisible

protected void onVisible()

onClosed

protected void onClosed()

toString

public String toString()

Overrides:

toString in class Object