org.solovyev.android.tasks.TaskOverlayDialog Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of android-common-samples Show documentation

There is a newer version: 1.1.18

Show newest version

package org.solovyev.android.tasks;

import android.app.Activity;
import android.app.ProgressDialog;
import org.solovyev.tasks.NoSuchTaskException;
import org.solovyev.tasks.TaskFinishedException;
import org.solovyev.tasks.TaskService;

import javax.annotation.Nonnull;
import javax.annotation.Nullable;

/**
 * User: serso
 * Date: 4/3/13
 * Time: 11:01 PM
 */

/**
 * Task overlay dialog - masks the whole screen and prevents user to do anything until task has been finished
 *
 * @param  type of the task result
 */
public final class TaskOverlayDialog implements ContextCallback {

	@Nonnull
	private final ProgressDialog progressDialog;

	private volatile boolean finished = false;

	private TaskOverlayDialog(@Nonnull ProgressDialog progressDialog) {
		this.progressDialog = progressDialog;
	}

	@Nonnull
	private static  TaskOverlayDialog newInstance(@Nonnull Activity activity, int titleResId, int messageResId) {
		final ProgressDialog progressDialog = new ProgressDialog(activity);
		progressDialog.setIndeterminate(true);
		progressDialog.setCancelable(false);
		progressDialog.setTitle(titleResId);
		progressDialog.setMessage(activity.getText(messageResId));
		return new TaskOverlayDialog(progressDialog);
	}

	/**
	 * Method tries to attach overlay dialog to the task identified by taskName.
	 * If task has been finished or not started - nothing is done and null is returned.
	 *
	 * @param taskService  task service
	 * @param activity     activity which should be masked
	 * @param taskName     name of the task which result is waited
	 * @param titleResId   dialog title
	 * @param messageResId dialog message
	 * @return not null dialog if task is running, null otherwise
	 */
	@Nullable
	public static TaskOverlayDialog attachToTask(@Nonnull TaskService taskService, @Nonnull Activity activity, @Nonnull String taskName, int titleResId, int messageResId) {
		TaskOverlayDialog