Package editor.util

Class ProgressFeedback

java.lang.Object

editor.util.ProgressFeedback

All Implemented Interfaces:

IProgressCallback, java.awt.event.ActionListener, java.util.EventListener

public class ProgressFeedback
extends java.lang.Object
implements IProgressCallback, java.awt.event.ActionListener

A helper class for displaying a ProgressWindow while a task executes in a worker thread.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ProgressFeedback.ProgressFeedbackThread

Field Summary

Fields

Modifier and Type	Field	Description
private boolean	_bAbort
private boolean	_bHideAbortButton
private boolean	_bShowInStudioGlassPane
private boolean	_changeLength
private java.lang.String	_currentMessage
private int	_currentValue
private int	_length
private ProgressPanel	_pp
private ProgressWindow	_pw
private java.lang.String	_strNotice
private javax.swing.Timer	_timer
private static int	UPDATE_DELAY

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	ProgressFeedback(java.lang.String strNotice, boolean bHideAbortButton, boolean bShowInStudioGlassPane)	Construct a ProgressFeedback with a given text notice.

Method Summary

Modifier and Type	Method	Description
void	actionPerformed(java.awt.event.ActionEvent e)
(package private) void	dispose()	Hides and disposes the ProgressWindow.
int	getProgress()
boolean	incrementProgress(java.lang.String strMessage, java.lang.String... args)
boolean	isAbort()	Should the operation abort?
void	operationComplete()	Signals that the operation is complete
static <T> T	runWithPossibleDialog(java.util.concurrent.Callable<T> callable, java.lang.String message)
protected static ProgressFeedback	runWithProgress(IRunnableWithProgress task, ProgressFeedback progressFeedback)
static ProgressFeedback	runWithProgress(java.lang.String strNotice, IRunnableWithProgress task)	A helper method that executes a task in a worker thread and displays feedback in a progress windows.
static ProgressFeedback	runWithProgress(java.lang.String strNotice, IRunnableWithProgress task, boolean bHideAbortBtn)
static ProgressFeedback	runWithProgress(java.lang.String strNotice, IRunnableWithProgress task, boolean bHideAbortBtn, boolean bShowInStudioGlassPane)
private void	setCurrentMessage(java.lang.String strMessage, java.lang.String[] args)
void	setLength(int iLength)	How long is this operation in units? For a StagedProgressFeedback, this moves to the next stage
private static boolean	shortWait(long delay, boolean[] done)
private void	startTimer()
private void	stopTimer()
boolean	updateProgress(int iProgress, java.lang.String strMessage, java.lang.String... args)	Call this when a unit of progress completes.
boolean	updateProgress(java.lang.String strMessage, java.lang.String... args)	Call this to update the progress message without modifying the amount of progress completed.
private static void	waitForProgress(boolean[] done)

Methods inherited from class java.lang.Object

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

Field Detail

UPDATE_DELAY

private static final int UPDATE_DELAY

See Also:

Constant Field Values

_strNotice

private java.lang.String _strNotice

_pp

private ProgressPanel _pp

_pw

private ProgressWindow _pw

_bAbort

private boolean _bAbort

_bHideAbortButton

private boolean _bHideAbortButton

_bShowInStudioGlassPane

private boolean _bShowInStudioGlassPane

_currentMessage

private java.lang.String _currentMessage

_currentValue

private int _currentValue

_length

private int _length

_changeLength

private boolean _changeLength

_timer

private javax.swing.Timer _timer

Constructor Detail

ProgressFeedback

protected ProgressFeedback(java.lang.String strNotice,
                           boolean bHideAbortButton,
                           boolean bShowInStudioGlassPane)

Construct a ProgressFeedback with a given text notice.

Parameters:

strNotice - The text notice to display in the ProgressWindow.

bHideAbortButton - will hide abort button

bShowInStudioGlassPane - will show in studio pane

Method Detail

runWithProgress

public static ProgressFeedback runWithProgress(java.lang.String strNotice,
                                               IRunnableWithProgress task)

A helper method that executes a task in a worker thread and displays feedback in a progress windows.

Parameters:

strNotice - The text notice to display in the ProgressWindow.

task - The task to execute in a separate (worker) thread.

runWithProgress

public static ProgressFeedback runWithProgress(java.lang.String strNotice,
                                               IRunnableWithProgress task,
                                               boolean bHideAbortBtn)

runWithProgress

public static ProgressFeedback runWithProgress(java.lang.String strNotice,
                                               IRunnableWithProgress task,
                                               boolean bHideAbortBtn,
                                               boolean bShowInStudioGlassPane)

runWithProgress

protected static ProgressFeedback runWithProgress(IRunnableWithProgress task,
                                                  ProgressFeedback progressFeedback)

runWithPossibleDialog

public static <T> T runWithPossibleDialog(java.util.concurrent.Callable<T> callable,
                                          java.lang.String message)

shortWait

private static boolean shortWait(long delay,
                                 boolean[] done)

waitForProgress

private static void waitForProgress(boolean[] done)

dispose

void dispose()

Hides and disposes the ProgressWindow.

startTimer

private void startTimer()

stopTimer

private void stopTimer()

setLength

public void setLength(int iLength)

Description copied from interface: IProgressCallback

How long is this operation in units? For a StagedProgressFeedback, this moves to the next stage

Specified by:

setLength in interface IProgressCallback

Parameters:

iLength - The number of units the operation is expected to execute.

updateProgress

public boolean updateProgress(int iProgress,
                              java.lang.String strMessage,
                              java.lang.String... args)

Description copied from interface: IProgressCallback

Call this when a unit of progress completes.

Specified by:

updateProgress in interface IProgressCallback

Parameters:

iProgress - The unit of progress completed.

strMessage - A short message describing the progress.

Returns:

Whether or not the operation should abort. True to abort operation.

incrementProgress

public boolean incrementProgress(java.lang.String strMessage,
                                 java.lang.String... args)

Specified by:

incrementProgress in interface IProgressCallback

setCurrentMessage

private void setCurrentMessage(java.lang.String strMessage,
                               java.lang.String[] args)

updateProgress

public boolean updateProgress(java.lang.String strMessage,
                              java.lang.String... args)

Description copied from interface: IProgressCallback

Call this to update the progress message without modifying the amount of progress completed.

Specified by:

updateProgress in interface IProgressCallback

getProgress

public int getProgress()

Specified by:

getProgress in interface IProgressCallback

isAbort

public boolean isAbort()

Description copied from interface: IProgressCallback

Should the operation abort?

Specified by:

isAbort in interface IProgressCallback

Returns:

True if the operation should abort.

actionPerformed

public void actionPerformed(java.awt.event.ActionEvent e)

Specified by:

actionPerformed in interface java.awt.event.ActionListener

operationComplete

public void operationComplete()

Description copied from interface: IProgressCallback

Signals that the operation is complete

Specified by:

operationComplete in interface IProgressCallback