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 intDEFAULT_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)ConstructorTaskDialog(java.awt.Component centerOnComp, Task task)ConstructorTaskDialog(java.lang.String title, boolean canCancel, boolean isModal, boolean hasProgress)Constructor
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description voidaddCancelledListener(CancelledListener listener)Add cancelled listenervoidcancel()Cancel the taskprotected voidcancelCallback()The callback method for when the "Cancel" button is pressed.voidcheckCanceled()Check to see if this monitor has been canceledvoidclearCanceled()Clear the cancellation so that this TaskMonitor may be reusedprotected voiddialogClosed()Override this method if you want to do something when the dialog is made invisibleprotected voiddialogShown()Override this method if you want to do something when the dialog is made visiblevoiddispose()protected voiddoShow()longgetMaximum()Returns the current maximum value for progressjava.lang.StringgetMessage()Gets the last set message of this monitorlonggetProgress()Returns the current progress value orTaskMonitor.NO_PROGRESS_VALUEif there is no value setvoidincrementProgress(long incrementAmount)A convenience method to increment the current progress by the given valuevoidinitialize(long max)Initialized this TaskMonitor to the given max values.booleanisCancelEnabled()Returns true if the cancel button is enabledbooleanisCancelled()Returns true if the user has cancelled the operationbooleanisCompleted()booleanisIndeterminate()Returns true if this monitor shows no progressvoidremoveCancelledListener(CancelledListener listener)Remove cancelled listenervoidreset()voidsetCancelEnabled(boolean enable)Sets the enablement state of the "CANCEL" button.voidsetIndeterminate(boolean indeterminate)An indeterminate task monitor may choose to show an animation instead of updating progressvoidsetMaximum(long max)Set the progress maximum valuevoidsetMessage(java.lang.String str)Sets the message displayed on the task monitorvoidsetProgress(long progress)Sets the current progress valuevoidsetShowProgressValue(boolean showProgressValue)True (the default) signals to paint the progress information inside of the progress barvoidshow(int delay)Shows the dialog window centered on the parent window.voidtaskProcessed()-
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, getHelpLocatdion, 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
-
-
-
-
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)Constructor- 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)
Constructor- Parameters:
task- the Task that this dialog will be associated with
-
TaskDialog
public TaskDialog(java.lang.String title, boolean canCancel, boolean isModal, boolean hasProgress)Constructor- Parameters:
title- title for the dialogcanCancel- true if the task can be canceledisModal- true if the dialog should be modalhasProgress- true if the dialog should show a progress bar
-
-
Method Detail
-
dialogShown
protected void dialogShown()
Description copied from class:DialogComponentProviderOverride this method if you want to do something when the dialog is made visible- Overrides:
dialogShownin classDialogComponentProvider
-
dialogClosed
protected void dialogClosed()
Description copied from class:DialogComponentProviderOverride this method if you want to do something when the dialog is made invisible- Overrides:
dialogClosedin classDialogComponentProvider
-
cancelCallback
protected void cancelCallback()
Description copied from class:DialogComponentProviderThe callback method for when the "Cancel" button is pressed. The default behavior is to call setVisible(false) and dispose() on the dialog.- Overrides:
cancelCallbackin classDialogComponentProvider
-
setCancelEnabled
public void setCancelEnabled(boolean enable)
Description copied from class:DialogComponentProviderSets the enablement state of the "CANCEL" button.- Specified by:
setCancelEnabledin interfaceTaskMonitor- Overrides:
setCancelEnabledin classDialogComponentProvider- Parameters:
enable- true to enable the button, false to disable the button.
-
isCancelEnabled
public boolean isCancelEnabled()
Description copied from class:DialogComponentProviderReturns true if the cancel button is enabled- Specified by:
isCancelEnabledin interfaceTaskMonitor- Overrides:
isCancelEnabledin classDialogComponentProvider- Returns:
- true if the cancel button is enabled
-
taskProcessed
public void taskProcessed()
-
reset
public void reset()
-
isCompleted
public boolean isCompleted()
-
show
public void show(int delay)
Shows the dialog window centered on the parent window. Dialog display is delayed if delay greater than zero.
-
doShow
protected void doShow()
-
dispose
public void dispose()
-
setMessage
public void setMessage(java.lang.String str)
Description copied from interface:TaskMonitorSets the message displayed on the task monitor- Specified by:
setMessagein interfaceTaskMonitor- Parameters:
str- the message to display
-
getMessage
public java.lang.String getMessage()
Description copied from interface:TaskMonitorGets the last set message of this monitor- Specified by:
getMessagein interfaceTaskMonitor- Returns:
- the message
-
setShowProgressValue
public void setShowProgressValue(boolean showProgressValue)
Description copied from interface:TaskMonitorTrue (the default) signals to paint the progress information inside of the progress bar- Specified by:
setShowProgressValuein interfaceTaskMonitor- Parameters:
showProgressValue- true to paint the progress value; false to not
-
setProgress
public void setProgress(long progress)
Description copied from interface:TaskMonitorSets the current progress value- Specified by:
setProgressin interfaceTaskMonitor- Parameters:
progress- progress value
-
initialize
public void initialize(long max)
Description copied from interface:TaskMonitorInitialized this TaskMonitor to the given max values. The current value of this monitor will be set to zero.- Specified by:
initializein interfaceTaskMonitor- Parameters:
max- maximum value for progress
-
setMaximum
public void setMaximum(long max)
Description copied from interface:TaskMonitorSet the progress maximum valueNote: 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:
setMaximumin interfaceTaskMonitor- Parameters:
max- maximum value for progress
-
getMaximum
public long getMaximum()
Description copied from interface:TaskMonitorReturns the current maximum value for progress- Specified by:
getMaximumin interfaceTaskMonitor- Returns:
- the maximum progress value
-
setIndeterminate
public void setIndeterminate(boolean indeterminate)
Description copied from interface:TaskMonitorAn indeterminate task monitor may choose to show an animation instead of updating progress- Specified by:
setIndeterminatein interfaceTaskMonitor- Parameters:
indeterminate- true if indeterminate
-
isIndeterminate
public boolean isIndeterminate()
Description copied from interface:TaskMonitorReturns true if this monitor shows no progress- Specified by:
isIndeterminatein interfaceTaskMonitor- Returns:
- true if this monitor shows no progress
-
isCancelled
public boolean isCancelled()
Description copied from interface:TaskMonitorReturns true if the user has cancelled the operation- Specified by:
isCancelledin interfaceTaskMonitor- Returns:
- true if the user has cancelled the operation
-
cancel
public void cancel()
Description copied from interface:TaskMonitorCancel the task- Specified by:
cancelin interfaceTaskMonitor
-
clearCanceled
public void clearCanceled()
Description copied from interface:TaskMonitorClear the cancellation so that this TaskMonitor may be reused- Specified by:
clearCanceledin interfaceTaskMonitor
-
checkCanceled
public void checkCanceled() throws CancelledExceptionDescription copied from interface:TaskMonitorCheck to see if this monitor has been canceled- Specified by:
checkCanceledin interfaceTaskMonitor- Throws:
CancelledException- if monitor has been cancelled
-
incrementProgress
public void incrementProgress(long incrementAmount)
Description copied from interface:TaskMonitorA convenience method to increment the current progress by the given value- Specified by:
incrementProgressin interfaceTaskMonitor- Parameters:
incrementAmount- The amount by which to increment the progress
-
getProgress
public long getProgress()
Description copied from interface:TaskMonitorReturns the current progress value orTaskMonitor.NO_PROGRESS_VALUEif there is no value set- Specified by:
getProgressin interfaceTaskMonitor- Returns:
- the current progress value or
TaskMonitor.NO_PROGRESS_VALUEif there is no value set
-
addCancelledListener
public void addCancelledListener(CancelledListener listener)
Description copied from interface:TaskMonitorAdd cancelled listener- Specified by:
addCancelledListenerin interfaceTaskMonitor- Parameters:
listener- the cancel listener
-
removeCancelledListener
public void removeCancelledListener(CancelledListener listener)
Description copied from interface:TaskMonitorRemove cancelled listener- Specified by:
removeCancelledListenerin interfaceTaskMonitor- Parameters:
listener- the cancel listener
-
-