to.etc.domui.util

Class AsyncDialogTask

java.lang.Object

to.etc.domui.util.AsyncDialogTask

All Implemented Interfaces:

IAsyncRunnable

public abstract class AsyncDialogTask
extends Object
implements IAsyncRunnable

This implements some core required logic to easily do asynchronous code that shows progress inside a dialog.

Author:

Frits Jalvingh Created on 1/13/15.

Constructor Summary

Constructors

Constructor and Description
AsyncDialogTask()

Method Summary

Modifier and Type	Method and Description
protected QDataContext	dc()
protected abstract void	execute(IProgress progress)
protected ILogicContext	lc()
void	onCompleted(boolean cancelled, Exception errorException) This method gets called with your originating DomUI page "active" when the activity has completed.
void	run(IProgress p) This is the code to call on the newly created worker thread - it should do the long running task that you want to execute in parallel.
static void	runInDialog(NodeContainer addTo, AsyncDialogTask task, String dialogTitle, boolean isAbortable, boolean autoClose)

Methods inherited from class java.lang.Object

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

Constructor Detail

AsyncDialogTask

public AsyncDialogTask()

Method Detail

execute

protected abstract void execute(@Nonnull
                                IProgress progress)
                         throws Exception

Throws:

Exception

run

public void run(@Nonnull
                IProgress p)
         throws Exception

Description copied from interface: IAsyncRunnable

This is the code to call on the newly created worker thread - it should do the long running task that you want to execute in parallel. Important: this method will be called on a separate thread, and it will run while the page it is started from is no longer active at all! This means that this task cannot access any of that page's resources! This means:

• You cannot access the shared QDataContext - if you need one you must call QContextManager.createUnmanagedContext() or something similar to create a context usable within this task - and do not forget to release it either!
• You cannot manipulate any of the originating page's data - no fields, and most certainly no components on that page!!!! To show the result of the long running task you must implement IAsyncRunnable.onCompleted(boolean, Exception), and use properly synchronized(!) member variables in your IAsyncRunnable implementation to create the new UI to show after the task.

Specified by:

run in interface IAsyncRunnable

Throws:

Exception

dc

@Nonnull
protected QDataContext dc()
                            throws Exception

Throws:

Exception

lc

@Nonnull
protected ILogicContext lc()
                             throws Exception

Throws:

Exception

onCompleted

public void onCompleted(boolean cancelled,
                        @Nullable
                        Exception errorException)
                 throws Exception

Description copied from interface: IAsyncRunnable

This method gets called with your originating DomUI page "active" when the activity has completed. At the time of call you can manipulate any kind of structure within your page. This method is to be used to handle response rendering only; it cannot be used to release any kind of resource(!) because it will not be called if your page terminated (was shelved/unshelved) before the task finished.

Specified by:

onCompleted in interface IAsyncRunnable

Parameters:

cancelled - When TRUE, the task was cancelled by the user.

errorException - When non-null the IAsyncRunnable.run(IProgress) method terminated with an exception, and this is that exception. You are supposed to do something with it since no other indication of that error is reported to the user!! So throw this exception on, or display it on your page.

Throws:

Exception

runInDialog

public static void runInDialog(@Nonnull
                               NodeContainer addTo,
                               @Nonnull
                               AsyncDialogTask task,
                               @Nonnull
                               String dialogTitle,
                               boolean isAbortable,
                               boolean autoClose)