Class SeparateTextGUIThread

java.lang.Object

com.googlecode.lanterna.gui2.AbstractTextGUIThread

com.googlecode.lanterna.gui2.SeparateTextGUIThread

All Implemented Interfaces:

AsynchronousTextGUIThread, TextGUIThread

public class SeparateTextGUIThread
extends AbstractTextGUIThread
implements AsynchronousTextGUIThread

Default implementation of TextGUIThread, this class runs the GUI event processing on a dedicated thread. The GUI needs to be explicitly started in order for the event processing loop to begin, so you must call start() for this. The GUI thread will stop if stop() is called, the input stream returns EOF or an exception is thrown from inside the event handling loop.

Here is an example of how to use this TextGUIThread:

    
    MultiWindowTextGUI textGUI = new MultiWindowTextGUI(new SeparateTextGUIThread.Factory(), screen);
    // ... add components ...
    ((AsynchronousTextGUIThread)textGUI.getGUIThread()).start();
    // ... this thread will continue while the GUI runs on a separate thread ...
    

See Also:

• TextGUIThread
• SameTextGUIThread

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SeparateTextGUIThread.Factory	Factory class for creating SeparateTextGUIThread objects

Nested classes/interfaces inherited from interface AsynchronousTextGUIThread

AsynchronousTextGUIThread.State

Nested classes/interfaces inherited from interface TextGUIThread

TextGUIThread.ExceptionHandler

Field Summary

Fields

Modifier and Type	Field	Description
private AsynchronousTextGUIThread.State	state
private final Thread	textGUIThread
private final CountDownLatch	waitLatch

Fields inherited from class AbstractTextGUIThread

customTasks, exceptionHandler, textGUI

Constructor Summary

Constructors

Modifier	Constructor	Description
private	SeparateTextGUIThread(TextGUI textGUI)

Method Summary

Modifier and Type	Method	Description
AsynchronousTextGUIThread.State	getState()	Returns the current status of this GUI thread
Thread	getThread()	Returns the Java thread which is processing GUI events and updating the screen
void	invokeLater(Runnable runnable)	Invokes custom code on the GUI thread.
private void	mainGUILoop()
void	start()	Starts the AsynchronousTextGUIThread, typically meaning that the event processing loop will start.
void	stop()	Requests that the AsynchronousTextGUIThread stops, typically meaning that the event processing loop will exit
void	waitForStop()	Blocks until the GUI loop has stopped
void	waitForStop(long time, TimeUnit unit)	Blocks until the GUI loop has stopped

Methods inherited from class AbstractTextGUIThread

invokeAndWait, processEventsAndUpdate, setExceptionHandler

Methods inherited from class Object

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

Methods inherited from interface TextGUIThread

invokeAndWait, processEventsAndUpdate, setExceptionHandler

Field Details

state

private volatile AsynchronousTextGUIThread.State state

textGUIThread

private final Thread textGUIThread

waitLatch

private final CountDownLatch waitLatch

Constructor Details

SeparateTextGUIThread

private SeparateTextGUIThread(TextGUI textGUI)

Method Details

start

public void start()

Description copied from interface: AsynchronousTextGUIThread

Starts the AsynchronousTextGUIThread, typically meaning that the event processing loop will start.

Specified by:

start in interface AsynchronousTextGUIThread

stop

public void stop()

Description copied from interface: AsynchronousTextGUIThread

Requests that the AsynchronousTextGUIThread stops, typically meaning that the event processing loop will exit

Specified by:

stop in interface AsynchronousTextGUIThread

waitForStop

public void waitForStop()
                 throws InterruptedException

Description copied from interface: AsynchronousTextGUIThread

Blocks until the GUI loop has stopped

Specified by:

waitForStop in interface AsynchronousTextGUIThread

Throws:

InterruptedException - In case this thread was interrupted while waiting for the GUI thread to exit

waitForStop

public void waitForStop(long time,
 TimeUnit unit)
                 throws InterruptedException

Description copied from interface: AsynchronousTextGUIThread

Blocks until the GUI loop has stopped

Specified by:

waitForStop in interface AsynchronousTextGUIThread

Throws:

InterruptedException - In case this thread was interrupted while waiting for the GUI thread to exit

getState

public AsynchronousTextGUIThread.State getState()

Description copied from interface: AsynchronousTextGUIThread

Returns the current status of this GUI thread

Specified by:

getState in interface AsynchronousTextGUIThread

Returns:

Current status of the GUI thread

getThread

public Thread getThread()

Description copied from interface: TextGUIThread

Returns the Java thread which is processing GUI events and updating the screen

Specified by:

getThread in interface TextGUIThread

Returns:

Thread which is processing events and updating the screen

invokeLater

public void invokeLater(Runnable runnable)
                 throws IllegalStateException

Description copied from interface: TextGUIThread

Invokes custom code on the GUI thread. Even if the current thread is the GUI thread, the code will be executed at a later time when the event processing is done.

Specified by:

invokeLater in interface TextGUIThread

Overrides:

invokeLater in class AbstractTextGUIThread

Parameters:

runnable - Code to run asynchronously

Throws:

IllegalStateException - If the GUI thread is not running

mainGUILoop

private void mainGUILoop()