Package ghidra.util.task

Class TaskDialog

java.lang.Object

docking.DialogComponentProvider

ghidra.util.task.TaskDialog

All Implemented Interfaces:

ActionContextProvider, StatusListener, TaskListener, TaskMonitor

public class TaskDialog
extends DialogComponentProvider
implements TaskMonitor

Dialog that is displayed to show activity for a Task that is running outside of the Swing Thread.

Field Summary

Fields

Modifier and Type	Field	Description
static int	DEFAULT_WIDTH

Fields inherited from class docking.DialogComponentProvider

applyButton, cancelButton, dismissButton, okButton, rootPanel

Fields inherited from interface ghidra.util.task.TaskMonitor

DUMMY, NO_PROGRESS_VALUE

Constructor Summary

Constructors

Constructor	Description
TaskDialog(Task task)	Creates a new TaskDialog.
TaskDialog(java.awt.Component centerOnComp, Task task)	Creates new TaskDialog
TaskDialog(java.lang.String title, boolean canCancel, boolean isModal, boolean hasProgress)	Construct new TaskDialog.

Method Summary

Modifier and Type	Method	Description
void	addCancelledListener(CancelledListener listener)	Add cancelled listener.
void	addIssueListener(IssueListener listener)	Add an issue listener to this monitor.
void	cancel()	Cancel the task.
protected void	cancelCallback()	Called if the user presses the cancel button on the dialog
void	checkCanceled()	Check to see if this monitor has been canceled.
void	clearCanceled()	Clear the cancellation so that this TaskMonitor may be reused.
protected void	dialogClosed()	Override this method if you want to do something when the dialog is made invisible
protected void	dialogShown()	Override this method if you want to do something when the dialog is made visible
void	dispose()
protected void	doShow()
long	getMaximum()	Returns the current maximum value for progress.
long	getProgress()	Returns the current progress value or TaskMonitor.NO_PROGRESS_VALUE if there is no value set.
void	incrementProgress(long incrementAmount)	A convenience method to increment the current progress by the given value.
void	initialize(long max)	Initialized this TaskMonitor to the given max values.
boolean	isCancelEnabled()	Returns true if the cancel button is enabled
boolean	isCancelled()	Returns true if the user has cancelled the operation.
boolean	isCompleted()
protected boolean	promptToVerifyCancel()
void	removeCancelledListener(CancelledListener listener)	Remove cancelled listener.
void	removeIssueListener(IssueListener listener)	Removes an issue listener to this monitor.
void	reportIssue(Issue issue)	Notify that an issue occurred while processing.
void	reset()
void	setCancelEnabled(boolean enable)	Set the enable state of the Cancel button.
void	setIndeterminate(boolean indeterminate)	Sets the indeterminate property of the progress bar, which determines whether the progress bar is in determinate or indeterminate mode.
void	setMaximum(long max)	Set the progress maximum value.
void	setMessage(java.lang.String str)	Sets the message in the TaskDialog dialog
void	setProgress(long param)	Sets the percentage done.
void	setShowProgressValue(boolean showProgressValue)	True (the default) signals to paint the progress information inside of the progress bar.
void	show(int delay)	Shows the dialog window centered on the parent window.
void	taskProcessed()

Methods inherited from class docking.DialogComponentProvider

addAction, addApplyButton, addButton, addCancelButton, addDismissButton, addOKButton, addWorkPanel, alertMessage, alertMessage, applyCallback, cancelCurrentTask, clearScheduledTask, clearStatusText, close, dismissCallback, doInitialize, escapeCallback, executeProgressTask, getActionContext, getActions, getBackground, getBounds, getComponent, getDefaultButton, getDefaultSize, getDialogSize, getFocusComponent, getGlassPane, getIntialLocation, getLocationOnScreen, getPreferredSize, getRemberSize, getRememberLocation, getStatusLabel, getStatusText, getTaskMonitorComponent, getTaskScheduler, getTitle, getUseSharedLocation, hideTaskMonitorComponent, isApplyEnabled, isModal, isOKEnabled, isResizeable, isRunningTask, isShowing, isTransient, isVisible, main, notifyContextChanged, okCallback, removeAction, removeButton, removeWorkPanel, repack, setApplyEnabled, setApplyToolTip, setBackground, setCancelButtonText, setCancelToolTip, setCursor, setDefaultButton, setDefaultSize, setDialogSize, setDismissToolTip, setFocusComponent, setGlassPane, setHelpLocation, setInitialLocation, setMinimumSize, setMinimumSize, setOkButtonText, setOkEnabled, setOkToolTip, setPreferredSize, setRememberLocation, setRememberSize, setResizable, setStatusJustification, setStatusText, setStatusText, setStatusText, setTitle, setTransient, setUseSharedLocation, showProgressBar, showTaskMonitorComponent, stopProgressTimer, taskCancelled, taskCompleted, toFront, toString, waitForCurrentTask

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_WIDTH

public static final int DEFAULT_WIDTH

See Also:

Constant Field Values

Constructor Detail

TaskDialog

public TaskDialog(java.awt.Component centerOnComp,
                  Task task)

Creates new TaskDialog

Parameters:

centerOnComp - component to be centered over when shown, otherwise center over parent. If both centerOnComp and parent are null, dialog will be centered on screen.

task - the Task that this dialog will be associated with

TaskDialog

public TaskDialog(Task task)

Creates a new TaskDialog.

Parameters:

task - the Task that this dialog will be associated with

TaskDialog

public TaskDialog(java.lang.String title,
                  boolean canCancel,
                  boolean isModal,
                  boolean hasProgress)

Construct new TaskDialog.

Parameters:

title - title for the dialog

canCancel - true if the task can be canceled

isModal - true if the dialog should be modal

hasProgress - true if the dialog should show a progress bar

Method Detail

promptToVerifyCancel

protected boolean promptToVerifyCancel()

dialogShown

protected void dialogShown()

Description copied from class: DialogComponentProvider

Override this method if you want to do something when the dialog is made visible

Overrides:

dialogShown in class DialogComponentProvider

dialogClosed

protected void dialogClosed()

Description copied from class: DialogComponentProvider

Override this method if you want to do something when the dialog is made invisible

Overrides:

dialogClosed in class DialogComponentProvider

setShowProgressValue

public void setShowProgressValue(boolean showProgressValue)

Description copied from interface: TaskMonitor

True (the default) signals to paint the progress information inside of the progress bar.

Specified by:

setShowProgressValue in interface TaskMonitor

Parameters:

showProgressValue - true to paint the progress value; false to not

setProgress

public void setProgress(long param)

Sets the percentage done.

Specified by:

setProgress in interface TaskMonitor

Parameters:

param - The percentage of the task completed.

initialize

public void initialize(long max)

Description copied from interface: TaskMonitor

Initialized this TaskMonitor to the given max values. The current value of this monitor will be set to zero.

Specified by:

initialize in interface TaskMonitor

Parameters:

max - maximum value for progress

setMaximum

public void setMaximum(long max)

Description copied from interface: TaskMonitor

Set the progress maximum value.

Note: setting this value will reset the progress to be the max if the progress is currently greater than the new new max value.

Specified by:

setMaximum in interface TaskMonitor

Parameters:

max - maximum value for progress

getMaximum

public long getMaximum()

Description copied from interface: TaskMonitor

Returns the current maximum value for progress.

Specified by:

getMaximum in interface TaskMonitor

Returns:

setIndeterminate

public void setIndeterminate(boolean indeterminate)

Sets the indeterminate property of the progress bar, which determines whether the progress bar is in determinate or indeterminate mode. An indeterminate progress bar continuously displays animation indicating that an operation of unknown length is occurring. By default, this property is false. Some look and feels might not support indeterminate progress bars; they will ignore this property.

Specified by:

setIndeterminate in interface TaskMonitor

See Also:

JProgressBar

cancelCallback

protected void cancelCallback()

Called if the user presses the cancel button on the dialog

Overrides:

cancelCallback in class DialogComponentProvider

setMessage

public void setMessage(java.lang.String str)

Sets the message in the TaskDialog dialog

Specified by:

setMessage in interface TaskMonitor

Parameters:

str - The message string to be displayed

setCancelEnabled

public void setCancelEnabled(boolean enable)

Set the enable state of the Cancel button.

Specified by:

setCancelEnabled in interface TaskMonitor

Overrides:

setCancelEnabled in class DialogComponentProvider

Parameters:

enable - the state to set the cancel button.

isCancelEnabled

public boolean isCancelEnabled()

Description copied from class: DialogComponentProvider

Returns true if the cancel button is enabled

Specified by:

isCancelEnabled in interface TaskMonitor

Overrides:

isCancelEnabled in class DialogComponentProvider

Returns:

true if the cancel button is enabled

taskProcessed

public void taskProcessed()

reset

public void reset()

isCompleted

public boolean isCompleted()

isCancelled

public boolean isCancelled()

Description copied from interface: TaskMonitor

Returns true if the user has cancelled the operation.

Specified by:

isCancelled in interface TaskMonitor

show

public void show(int delay)

Shows the dialog window centered on the parent window. Dialog display is delayed if delay greater than zero.

Parameters:

delay - number of milliseconds to delay displaying of the task dialog. If the delay is greater than MAX_DELAY, then the delay will be MAX_DELAY;

doShow

protected void doShow()

dispose

public void dispose()

cancel

public void cancel()

Description copied from interface: TaskMonitor

Cancel the task.

Specified by:

cancel in interface TaskMonitor

clearCanceled

public void clearCanceled()

Description copied from interface: TaskMonitor

Clear the cancellation so that this TaskMonitor may be reused.

Specified by:

clearCanceled in interface TaskMonitor

checkCanceled

public void checkCanceled()
                   throws CancelledException

Description copied from interface: TaskMonitor

Check to see if this monitor has been canceled.

Specified by:

checkCanceled in interface TaskMonitor

Throws:

CancelledException - if monitor has been cancelled.

incrementProgress

public void incrementProgress(long incrementAmount)

Description copied from interface: TaskMonitor

A convenience method to increment the current progress by the given value.

Specified by:

incrementProgress in interface TaskMonitor

Parameters:

incrementAmount - The amount by which to increment the progress.

getProgress

public long getProgress()

Description copied from interface: TaskMonitor

Returns the current progress value or TaskMonitor.NO_PROGRESS_VALUE if there is no value set.

Specified by:

getProgress in interface TaskMonitor

Returns:

the current progress value or TaskMonitor.NO_PROGRESS_VALUE if there is no value set.

addCancelledListener

public void addCancelledListener(CancelledListener listener)

Description copied from interface: TaskMonitor

Add cancelled listener.

Specified by:

addCancelledListener in interface TaskMonitor

removeCancelledListener

public void removeCancelledListener(CancelledListener listener)

Description copied from interface: TaskMonitor

Remove cancelled listener.

Specified by:

removeCancelledListener in interface TaskMonitor

addIssueListener

public void addIssueListener(IssueListener listener)

Description copied from interface: TaskMonitor

Add an issue listener to this monitor.

Specified by:

addIssueListener in interface TaskMonitor

Parameters:

listener - the listener

removeIssueListener

public void removeIssueListener(IssueListener listener)

Description copied from interface: TaskMonitor

Removes an issue listener to this monitor.

Specified by:

removeIssueListener in interface TaskMonitor

Parameters:

listener - the listener

reportIssue

public void reportIssue(Issue issue)

Description copied from interface: TaskMonitor

Notify that an issue occurred while processing.

Specified by:

reportIssue in interface TaskMonitor

Parameters:

issue - the issue that was encountered