Package ghidra.framework.task
Class GTaskMonitor
- java.lang.Object
-
- ghidra.framework.task.GTaskMonitor
-
- All Implemented Interfaces:
CancelledListener
,TaskMonitor
public class GTaskMonitor extends java.lang.Object implements TaskMonitor, CancelledListener
Implementation of a TaskMontor that can be "attached" to a GProgressBar. The GTaskMonitor is a non-gui object for tracking the progress of a GTaskGroup or GTask. It is created by the GTaskManager as tasks are scheduled. GUIs that wish to display the progress of the groups and tasks can set a GProgressBar into a GTaskMonitor and it will display the progress.
-
-
Field Summary
-
Fields inherited from interface ghidra.util.task.TaskMonitor
DUMMY, NO_PROGRESS_VALUE
-
-
Constructor Summary
Constructors Constructor Description GTaskMonitor()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
addCancelledListener(CancelledListener mcl)
Add cancelled listener.void
addIssueListener(IssueListener listener)
Add an issue listener to this monitor.void
cancel()
Cancel the task.void
cancelled()
Provides notification when a task is cancelled.void
checkCanceled()
Check to see if this monitor has been canceled.void
clearCanceled()
Clear the cancellation so that this TaskMonitor may be reused.long
getMaximum()
Returns the current maximum value for progress.java.lang.String
getMessage()
long
getProgress()
Returns the current progress value orTaskMonitor.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 maxValue)
Initialized this TaskMonitor to the given max values.boolean
isCancelEnabled()
Returns true if cancel ability is enabledboolean
isCancelled()
Returns true if the user has cancelled the operation.boolean
isInderminate()
boolean
isShowingProgressValue()
void
removeCancelledListener(CancelledListener mcl)
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
setCancelEnabled(boolean enable)
Set the enablement of the Cancel button.void
setIndeterminate(boolean indeterminate)
An indeterminate task monitor may choose to show an animation instead of updating progress.void
setMaximum(long max)
Set the progress maximum value.void
setMessage(java.lang.String message)
Sets a message giving additional information about the current progress.void
setProgress(long value)
Sets the current progress value.void
setProgressBar(GProgressBar gProgressBar)
Set the GProgressBar to use to display the progress.void
setShowProgressValue(boolean showProgressValue)
True (the default) signals to paint the progress information inside of the progress bar.
-
-
-
Method Detail
-
isCancelled
public boolean isCancelled()
Description copied from interface:TaskMonitor
Returns true if the user has cancelled the operation.- Specified by:
isCancelled
in interfaceTaskMonitor
-
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 interfaceTaskMonitor
- Parameters:
showProgressValue
- true to paint the progress value; false to not
-
setMessage
public void setMessage(java.lang.String message)
Description copied from interface:TaskMonitor
Sets a message giving additional information about the current progress.- Specified by:
setMessage
in interfaceTaskMonitor
- Parameters:
message
- more information
-
setProgress
public void setProgress(long value)
Description copied from interface:TaskMonitor
Sets the current progress value.- Specified by:
setProgress
in interfaceTaskMonitor
- Parameters:
value
- progress value
-
initialize
public void initialize(long maxValue)
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 interfaceTaskMonitor
- Parameters:
maxValue
- 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 interfaceTaskMonitor
- 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 interfaceTaskMonitor
- Returns:
-
setIndeterminate
public void setIndeterminate(boolean indeterminate)
Description copied from interface:TaskMonitor
An indeterminate task monitor may choose to show an animation instead of updating progress.- Specified by:
setIndeterminate
in interfaceTaskMonitor
-
checkCanceled
public void checkCanceled() throws CancelledException
Description copied from interface:TaskMonitor
Check to see if this monitor has been canceled.- Specified by:
checkCanceled
in interfaceTaskMonitor
- 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 interfaceTaskMonitor
- Parameters:
incrementAmount
- The amount by which to increment the progress.
-
getProgress
public long getProgress()
Description copied from interface:TaskMonitor
Returns the current progress value orTaskMonitor.NO_PROGRESS_VALUE
if there is no value set.- Specified by:
getProgress
in interfaceTaskMonitor
- Returns:
- the current progress value or
TaskMonitor.NO_PROGRESS_VALUE
if there is no value set.
-
reportIssue
public void reportIssue(Issue issue)
Description copied from interface:TaskMonitor
Notify that an issue occurred while processing.- Specified by:
reportIssue
in interfaceTaskMonitor
- Parameters:
issue
- the issue that was encountered
-
cancel
public void cancel()
Description copied from interface:TaskMonitor
Cancel the task.- Specified by:
cancel
in interfaceTaskMonitor
-
addCancelledListener
public void addCancelledListener(CancelledListener mcl)
Description copied from interface:TaskMonitor
Add cancelled listener.- Specified by:
addCancelledListener
in interfaceTaskMonitor
-
removeCancelledListener
public void removeCancelledListener(CancelledListener mcl)
Description copied from interface:TaskMonitor
Remove cancelled listener.- Specified by:
removeCancelledListener
in interfaceTaskMonitor
-
addIssueListener
public void addIssueListener(IssueListener listener)
Description copied from interface:TaskMonitor
Add an issue listener to this monitor.- Specified by:
addIssueListener
in interfaceTaskMonitor
- 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 interfaceTaskMonitor
- Parameters:
listener
- the listener
-
setCancelEnabled
public void setCancelEnabled(boolean enable)
Description copied from interface:TaskMonitor
Set the enablement of the Cancel button.- Specified by:
setCancelEnabled
in interfaceTaskMonitor
- Parameters:
enable
- true means to enable the cancel button
-
isCancelEnabled
public boolean isCancelEnabled()
Description copied from interface:TaskMonitor
Returns true if cancel ability is enabled- Specified by:
isCancelEnabled
in interfaceTaskMonitor
-
clearCanceled
public void clearCanceled()
Description copied from interface:TaskMonitor
Clear the cancellation so that this TaskMonitor may be reused.- Specified by:
clearCanceled
in interfaceTaskMonitor
-
isInderminate
public boolean isInderminate()
-
isShowingProgressValue
public boolean isShowingProgressValue()
-
getMessage
public java.lang.String getMessage()
-
cancelled
public void cancelled()
Description copied from interface:CancelledListener
Provides notification when a task is cancelled.- Specified by:
cancelled
in interfaceCancelledListener
-
setProgressBar
public void setProgressBar(GProgressBar gProgressBar)
Set the GProgressBar to use to display the progress.- Parameters:
gProgressBar
- the GProgressBar to use.
-
-