com.jogamp.newt.swt

Class SWTEDTUtil

java.lang.Object

com.jogamp.newt.swt.SWTEDTUtil

All Implemented Interfaces:

EDTUtil

public class SWTEDTUtil
extends Object
implements EDTUtil

Simple EDTUtil implementation utilizing the SWT UI thread of the given Display.

Field Summary

Fields inherited from interface com.jogamp.newt.util.EDTUtil

defaultEDTPollPeriod

Constructor Summary

Constructors

Constructor and Description
SWTEDTUtil(org.eclipse.swt.widgets.Display swtDisplay)

Method Summary

Methods

Modifier and Type	Method and Description
org.eclipse.swt.widgets.Display	getDisplay()
long	getPollPeriod()
void	invoke(boolean wait, Runnable task) Append task to the EDT task queue. Wait until execution is finished if wait == true. Shall start the thread if not running. Can be issued from within EDT, ie from within an enqueued task.
void	invokeStop(Runnable finalTask) Append the final task to the EDT task queue, signals EDT to stop and wait until stopped. Due to the nature of this method: All previous queued tasks will be finished. No new tasks are allowed, an Exception is thrown. Can be issued from within EDT, ie from within an enqueued task. EDTUtil.reset() may follow immediately, ie creating a new EDT
boolean	isCurrentThreadEDT()
boolean	isRunning()
void	reset() Create a new EDT.
void	setPollPeriod(long ms)
void	start() Start the EDT
void	waitUntilIdle() Wait until the EDT task queue is empty. The last task may still be in execution when this method returns.
void	waitUntilStopped() Wait until EDT task is stopped. No stop action is performed, EDTUtil.invokeStop(java.lang.Runnable) should be used before.

Methods inherited from class java.lang.Object

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

Constructor Detail

SWTEDTUtil

public SWTEDTUtil(org.eclipse.swt.widgets.Display swtDisplay)

Method Detail

getDisplay

public final org.eclipse.swt.widgets.Display getDisplay()

getPollPeriod

public long getPollPeriod()

Specified by:

getPollPeriod in interface EDTUtil

Returns:

poll period in milliseconds

setPollPeriod

public void setPollPeriod(long ms)

Specified by:

setPollPeriod in interface EDTUtil

Parameters:

ms - poll period in milliseconds

reset

public void reset()

Description copied from interface: EDTUtil

Create a new EDT. One should invoke reset()
after invokeStop(..) in case another start() or invoke(..) is expected.

Specified by:

reset in interface EDTUtil

See Also:

EDTUtil.start(), EDTUtil.invoke(boolean, java.lang.Runnable), EDTUtil.invokeStop(java.lang.Runnable)

start

public void start()

Description copied from interface: EDTUtil

Start the EDT

Specified by:

start in interface EDTUtil

isCurrentThreadEDT

public boolean isCurrentThreadEDT()

Specified by:

isCurrentThreadEDT in interface EDTUtil

Returns:

True if the current thread is the EDT thread

isRunning

public boolean isRunning()

Specified by:

isRunning in interface EDTUtil

Returns:

True if EDT is running

invokeStop

public void invokeStop(Runnable finalTask)

Description copied from interface: EDTUtil

Append the final task to the EDT task queue, signals EDT to stop and wait until stopped.
Due to the nature of this method:

• All previous queued tasks will be finished.
• No new tasks are allowed, an Exception is thrown.
• Can be issued from within EDT, ie from within an enqueued task.
• EDTUtil.reset() may follow immediately, ie creating a new EDT

Specified by:

invokeStop in interface EDTUtil

invoke

public void invoke(boolean wait,
          Runnable task)

Description copied from interface: EDTUtil

Append task to the EDT task queue.
Wait until execution is finished if wait == true.
Shall start the thread if not running.
Can be issued from within EDT, ie from within an enqueued task.

Specified by:

invoke in interface EDTUtil

waitUntilIdle

public void waitUntilIdle()

Description copied from interface: EDTUtil

Wait until the EDT task queue is empty.
The last task may still be in execution when this method returns.

Specified by:

waitUntilIdle in interface EDTUtil

waitUntilStopped

public void waitUntilStopped()

Description copied from interface: EDTUtil

Wait until EDT task is stopped.
No stop action is performed, EDTUtil.invokeStop(java.lang.Runnable) should be used before.

Specified by:

waitUntilStopped in interface EDTUtil