org.kuali.student.common.ui.client.widgets.progress
Class KSBlockingProgressIndicator

java.lang.Object
  org.kuali.student.common.ui.client.widgets.progress.KSBlockingProgressIndicator

public class KSBlockingProgressIndicator
extends Object

This class handles a static list of BlockingTasks, when a blocking task is added to the list, the blocking progress indicator is shown to the user and the user can perform no action until all blocking tasks are finished/removed.

Author:

Bsmith

Field Summary

private static int	height
private static boolean	initialized
private static com.google.gwt.user.client.ui.VerticalPanel	listPanel
private static com.google.gwt.user.client.ui.VerticalPanel	mainPanel
private static KSLightBox	popupIndicator
private static LinkedList<BlockingTask>	tasks
private static int	width

Constructor Summary

KSBlockingProgressIndicator()

Method Summary

static void	addTask(BlockingTask task) Adds a blocking task to the queue.
private static void	hideIndicator()
static void	initialize() Initializes the blocking progress indicator.
static void	removeTask(BlockingTask task) Removes the blocking task from the queue
static void	setSize(int w, int h)
private static void	setupDefaultStyle()
private static void	showIndicator()
private static void	updateIndicator()

Methods inherited from class java.lang.Object

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

Field Detail

tasks

private static LinkedList<BlockingTask> tasks

mainPanel

private static final com.google.gwt.user.client.ui.VerticalPanel mainPanel

listPanel

private static final com.google.gwt.user.client.ui.VerticalPanel listPanel

popupIndicator

private static KSLightBox popupIndicator

initialized

private static boolean initialized

width

private static int width

height

private static int height

Constructor Detail

KSBlockingProgressIndicator

public KSBlockingProgressIndicator()

Method Detail

initialize

public static void initialize()

Initializes the blocking progress indicator. This must be called before blocking task are added.

addTask

public static void addTask(BlockingTask task)

Adds a blocking task to the queue. When all tasks are removed, the indicator is no longer shown.

Parameters:

task - the task description to be added

removeTask

public static void removeTask(BlockingTask task)

Removes the blocking task from the queue

Parameters:

task - the task to be removed from the blocking task queue

setSize

public static void setSize(int w,
                           int h)

updateIndicator

private static void updateIndicator()

showIndicator

private static void showIndicator()

hideIndicator

private static void hideIndicator()

setupDefaultStyle

private static void setupDefaultStyle()