net.sf.mmm.client.ui.base.widget

Class AbstractUiDispatcher

java.lang.Object

net.sf.mmm.util.component.base.AbstractComponent

net.sf.mmm.util.component.base.AbstractLoggableComponent

net.sf.mmm.client.ui.base.widget.AbstractUiDispatcher

All Implemented Interfaces:

UiDispatcher

Direct Known Subclasses:

UiDispatcherGwt, UiDispatcherTestImpl

public abstract class AbstractUiDispatcher
extends AbstractLoggableComponent
implements UiDispatcher

This is the abstract base implementation of UiDispatcher.

Since:

1.0.0

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

Constructor Summary

Constructors

Constructor and Description
AbstractUiDispatcher() The constructor.

Method Summary

Modifier and Type	Method and Description
boolean	dispatch() If you want to support SWT in its intended way (this method delegates to Display.readAndDispatch), you need to call this method frequently from a main loop of your application client.
<T> T	invokeSynchron(Callable<T> task) This method invokes the given task synchronous in the dispatcher thread of the UI.
void	invokeSynchron(Runnable task) This method invokes the given task synchronous in the dispatcher thread of the UI.
boolean	isDispatchThread() This method checks if the "current thread" is the dispatcher thread of the underlying UI toolkit.
String	toString()

Methods inherited from class net.sf.mmm.util.component.base.AbstractLoggableComponent

createLogger, doInitialize, getLogger

Methods inherited from class net.sf.mmm.util.component.base.AbstractComponent

doInitialized, getInitializationState, initialize

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.sf.mmm.client.ui.api.UiDispatcher

invokeAsynchron, invokeTimer, invokeTimer, sleep

Constructor Detail

AbstractUiDispatcher

public AbstractUiDispatcher()

The constructor.

Method Detail

dispatch

public boolean dispatch()

If you want to support SWT in its intended way (this method delegates to Display.readAndDispatch), you need to call this method frequently from a main loop of your application client. For other toolkit implementations this method will simply do nothing.
If you have a main loop in your foreground thread waiting until the GUI is closed, it is recommended to call this method from your main loop followed by UiDispatcher.sleep().

Specified by:

dispatch in interface UiDispatcher

Returns:

true if there is more work to do, false if it is safe to sleep for a short while.

isDispatchThread

public boolean isDispatchThread()

This method checks if the "current thread" is the dispatcher thread of the underlying UI toolkit.

Specified by:

isDispatchThread in interface UiDispatcher

Returns:

true if this method was invoked within the dispatcher thread, false otherwise.

invokeSynchron

public void invokeSynchron(Runnable task)

This method invokes the given task synchronous in the dispatcher thread of the UI. The term "synchronous" means that the current thread is suspended and this method will NOT return before the task is completed. If this method is called in the dispatcher thread or there is NO dispatcher thread in the underlying UI implementation, the task may simply be invoked directly in the implementation of this method.

Specified by:

invokeSynchron in interface UiDispatcher

Parameters:

task - is the job to invoke.

invokeSynchron

public <T> T invokeSynchron(Callable<T> task)
                     throws Exception

This method invokes the given task synchronous in the dispatcher thread of the UI. The term "synchronous" means that the current thread is suspended and this method will NOT return before the task is completed. If this method is called in the dispatcher thread or there is NO dispatcher thread in the underlying UI implementation, the task may simply be invoked directly in the implementation of this method.

Specified by:

invokeSynchron in interface UiDispatcher

Type Parameters:

T - is the templated type of the task result.

Parameters:

task - is the piece of code to be executed synchronous.

Returns:

is the result of the task.

Throws:

Exception - if Callable.call() throws an exception.

toString

public String toString()

Overrides:

toString in class Object