Package ghidra.util.task

Class TaskMonitorComponent

java.lang.Object
java.awt.Component
java.awt.Container
javax.swing.JComponent
javax.swing.JPanel
ghidra.util.task.TaskMonitorComponent
All Implemented Interfaces:
TaskMonitor, ImageObserver, MenuContainer, Serializable, Accessible
public class TaskMonitorComponent extends JPanel implements TaskMonitor
Component that contains a progress bar, a progress icon, and a cancel button to cancel the task that is associated with this task monitor.

By default the progress bar and progress icon (spinning globe) are visible.

See Also:

  • Constructor Details

    • TaskMonitorComponent

      public TaskMonitorComponent()
      Constructor

    • TaskMonitorComponent

      public TaskMonitorComponent(boolean includeTextField, boolean includeCancelButton)
      Constructor
      Parameters:
      includeTextField - if true, the dialog can display a status progressMessage with progress details
      includeCancelButton - if true, a cancel button will be displayed

  • Method Details

    • addCancelledListener

      public void addCancelledListener(CancelledListener mcl)
      Description copied from interface: TaskMonitor
      Add cancelled listener
      Specified by:
      addCancelledListener in interface TaskMonitor
      Parameters:
      mcl - the cancel listener

    • removeCancelledListener

      public void removeCancelledListener(CancelledListener mcl)
      Description copied from interface: TaskMonitor
      Remove cancelled listener
      Specified by:
      removeCancelledListener in interface TaskMonitor
      Parameters:
      mcl - the cancel listener

    • incrementProgress

      public void incrementProgress(long incrementAmount)
      Description copied from interface: TaskMonitor
      Changes the progress value by the specified amount.
      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

    • isCancelled

      public boolean isCancelled()
      Description copied from interface: TaskMonitor
      Returns true if the user has cancelled the operation
      Specified by:
      isCancelled in interface TaskMonitor
      Returns:
      true if the user has cancelled the operation

    • checkCanceled

      public void checkCanceled() throws CancelledException
      Description copied from interface: TaskMonitor
      Check to see if this monitor has been cancelled
      Specified by:
      checkCanceled in interface TaskMonitor
      Throws:
      CancelledException - if monitor has been cancelled

    • setMessage

      public void setMessage(String message)
      Description copied from interface: TaskMonitor
      Sets the message displayed on the task monitor
      Specified by:
      setMessage in interface TaskMonitor
      Parameters:
      message - the message to display

    • getMessage

      public String getMessage()
      Description copied from interface: TaskMonitor
      Gets the last set message of this monitor
      Specified by:
      getMessage in interface TaskMonitor
      Returns:
      the message

    • setProgress

      public void setProgress(long value)
      Description copied from interface: TaskMonitor
      Sets the current progress value
      Specified by:
      setProgress in interface TaskMonitor
      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 interface TaskMonitor
      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 interface TaskMonitor
      Parameters:
      max - maximum value for progress

    • 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
      Parameters:
      indeterminate - true if indeterminate
      See Also:

    • setCancelEnabled

      public void setCancelEnabled(boolean enable)
      Description copied from interface: TaskMonitor
      Set the enablement of the Cancel button
      Specified by:
      setCancelEnabled in interface TaskMonitor
      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 interface TaskMonitor
      Returns:
      true if cancel ability is enabled

    • 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

    • 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

    • getMaximum

      public long getMaximum()
      Description copied from interface: TaskMonitor
      Returns the current maximum value for progress
      Specified by:
      getMaximum in interface TaskMonitor
      Returns:
      the maximum progress value

    • reset

      public void reset()
      Reset this monitor so that it can be reused

    • isIndeterminate

      public boolean isIndeterminate()
      Returns true if setIndeterminate(boolean) with a value of true has been called.
      Specified by:
      isIndeterminate in interface TaskMonitor
      Returns:
      true if setIndeterminate(boolean) with a value of true has been called.

    • showProgress

      public void showProgress(boolean show)
      Set whether the progress bar should be visible
      Parameters:
      show - true if the progress bar should be visible

    • setTaskName

      public void setTaskName(String name)
      Set the name of the task; the name shows up in the tool tip for the cancel button.
      Parameters:
      name - the name of the task

    • setCancelButtonVisibility

      public void setCancelButtonVisibility(boolean visible)
      Set the visibility of the cancel button
      Parameters:
      visible - if true, show the cancel button; false otherwise

    • showProgressIcon

      public void showProgressIcon(boolean visible)
      Sets the visibility of the progress icon
      Parameters:
      visible - if true, display the progress icon

    • notifyCancelListeners

      protected void notifyCancelListeners()