edu.stanford.smi.protegex.owl.model.impl
Class NoopProgressDisplay

java.lang.Object
  edu.stanford.smi.protegex.owl.model.impl.NoopProgressDisplay

All Implemented Interfaces:

TaskProgressDisplay

public class NoopProgressDisplay

extends Object

implements TaskProgressDisplay

User: matthewhorridge
The University Of Manchester
Medical Informatics Group
Date: Sep 13, 2005

matthew.horridge@cs.man.ac.uk
www.cs.man.ac.uk/~horridgm

Constructor Summary

NoopProgressDisplay()

Method Summary

void	begin(Task task) Starts the display of progress to the user.
void	end() Stops (hides) the progress display.
long	getDisplayDelay() Gets the length of time between the task starting and the progress display being displayed.
boolean	isModal() Determines whether or not the progress display is modal and therfore blocks the main event pump when run() is called.
void	setMessage(String message) Sets the message that will be displayed to the user.
void	setProgress(int progress) Updates the value of the progress that is displayed to the user.
void	setProgressIndeterminate(boolean b) Sets the progress display to indicate that the progress cannot be determined, but the task is proceding as normal.
void	setSubTaskMessage(String message)

Methods inherited from class java.lang.Object

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

Constructor Detail

NoopProgressDisplay

public NoopProgressDisplay()

Method Detail

begin

public void begin(Task task)

Description copied from interface: TaskProgressDisplay

Starts the display of progress to the user. Note that this method will be called after any period of delay that is specified by the getDisplayDelay method.

Specified by:

begin in interface TaskProgressDisplay

Parameters:

task - The Task whose progress will be monitored and displayed.

setProgress

public void setProgress(int progress)

Description copied from interface: TaskProgressDisplay

Updates the value of the progress that is displayed to the user.

Specified by:

setProgress in interface TaskProgressDisplay

Parameters:

progress - The progress that will be between the min and max progress for the Task

setProgressIndeterminate

public void setProgressIndeterminate(boolean b)

Description copied from interface: TaskProgressDisplay

Sets the progress display to indicate that the progress cannot be determined, but the task is proceding as normal.

Specified by:

setProgressIndeterminate in interface TaskProgressDisplay

Parameters:

b - true if the progress is indeterminate, or false if the progress is not indeterminate.

setSubTaskMessage

public void setSubTaskMessage(String message)

Specified by:

setSubTaskMessage in interface TaskProgressDisplay

setMessage

public void setMessage(String message)

Description copied from interface: TaskProgressDisplay

Sets the message that will be displayed to the user.

Specified by:

setMessage in interface TaskProgressDisplay

end

public void end()

Description copied from interface: TaskProgressDisplay

Stops (hides) the progress display. This methods is generally called when the task is complete.

Specified by:

end in interface TaskProgressDisplay

getDisplayDelay

public long getDisplayDelay()

Description copied from interface: TaskProgressDisplay

Gets the length of time between the task starting and the progress display being displayed.

Specified by:

getDisplayDelay in interface TaskProgressDisplay

Returns:

The delay in milliseconds.

isModal

public boolean isModal()

Description copied from interface: TaskProgressDisplay

Determines whether or not the progress display is modal and therfore blocks the main event pump when run() is called. For example if the progress display is a modal JDialog then this method should return true since showing the progress display will block user input until the task has finished and end() is called. In general, any Swing progress display should be modal.

Specified by:

isModal in interface TaskProgressDisplay