Package ghidra.util.task
Class CancelOnlyWrappingTaskMonitor
- java.lang.Object
-
- ghidra.util.task.WrappingTaskMonitor
-
- ghidra.util.task.CancelOnlyWrappingTaskMonitor
-
- All Implemented Interfaces:
TaskMonitor
public class CancelOnlyWrappingTaskMonitor extends WrappingTaskMonitor
A monitor that is designed for sub-tasks, where the outer task handles reporting messages and progress. This class is really just for checking cancelled.This class wants the following methods related to cancelling to work normally:
- isCancelled()
- checkCanceled()
- cancel()
- addCancelledListener(CancelledListener)
- removeCancelledListener(CancelledListener)
- addIssueListener(IssueListener)
- removeIssueListener(IssueListener)
- isCancelEnabled()
The rest of TaskMonitor should be stubbed out. This means that if any methods are added to the TaskMonitor interface, and subsequently implemented in this class's parent, then this class needs to override them.
-
-
Field Summary
-
Fields inherited from class ghidra.util.task.WrappingTaskMonitor
delegate
-
Fields inherited from interface ghidra.util.task.TaskMonitor
DUMMY, NO_PROGRESS_VALUE
-
-
Constructor Summary
Constructors Constructor Description CancelOnlyWrappingTaskMonitor(TaskMonitor delegate)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description voidclearCanceled()Clear the cancellation so that this TaskMonitor may be reusedlonggetMaximum()Returns the current maximum value for progresslonggetProgress()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.voidsetCancelEnabled(boolean enable)Set the enablement of the Cancel buttonvoidsetIndeterminate(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 message)Sets the message displayed on the task monitorvoidsetProgress(long value)Sets the current progress valuevoidsetShowProgressValue(boolean showProgressValue)True (the default) signals to paint the progress information inside of the progress bar-
Methods inherited from class ghidra.util.task.WrappingTaskMonitor
addCancelledListener, cancel, checkCanceled, getMessage, isCancelEnabled, isCancelled, isIndeterminate, removeCancelledListener, setDelegate
-
-
-
-
Constructor Detail
-
CancelOnlyWrappingTaskMonitor
public CancelOnlyWrappingTaskMonitor(TaskMonitor delegate)
-
-
Method Detail
-
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- Overrides:
setShowProgressValuein classWrappingTaskMonitor- Parameters:
showProgressValue- true to paint the progress value; false to not
-
setMessage
public void setMessage(java.lang.String message)
Description copied from interface:TaskMonitorSets the message displayed on the task monitor- Specified by:
setMessagein interfaceTaskMonitor- Overrides:
setMessagein classWrappingTaskMonitor- Parameters:
message- the message to display
-
setProgress
public void setProgress(long value)
Description copied from interface:TaskMonitorSets the current progress value- Specified by:
setProgressin interfaceTaskMonitor- Overrides:
setProgressin classWrappingTaskMonitor- Parameters:
value- 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- Overrides:
initializein classWrappingTaskMonitor- 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- Overrides:
setMaximumin classWrappingTaskMonitor- 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- Overrides:
getMaximumin classWrappingTaskMonitor- 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- Overrides:
setIndeterminatein classWrappingTaskMonitor- Parameters:
indeterminate- true if indeterminate
-
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- Overrides:
incrementProgressin classWrappingTaskMonitor- 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- Overrides:
getProgressin classWrappingTaskMonitor- Returns:
- the current progress value or
TaskMonitor.NO_PROGRESS_VALUEif there is no value set
-
setCancelEnabled
public void setCancelEnabled(boolean enable)
Description copied from interface:TaskMonitorSet the enablement of the Cancel button- Specified by:
setCancelEnabledin interfaceTaskMonitor- Overrides:
setCancelEnabledin classWrappingTaskMonitor- Parameters:
enable- true means to enable the cancel button
-
clearCanceled
public void clearCanceled()
Description copied from interface:TaskMonitorClear the cancellation so that this TaskMonitor may be reused- Specified by:
clearCanceledin interfaceTaskMonitor- Overrides:
clearCanceledin classWrappingTaskMonitor
-
-