Package ghidra.util.task

Class TaskMonitorComponent

  • All Implemented Interfaces:
    TaskMonitor, java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, javax.accessibility.Accessible
    public class TaskMonitorComponent
extends javax.swing.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:
    Serialized Form

    • Nested Class Summary

      • Nested classes/interfaces inherited from class javax.swing.JPanel

        javax.swing.JPanel.AccessibleJPanel

      • Nested classes/interfaces inherited from class javax.swing.JComponent

        javax.swing.JComponent.AccessibleJComponent

      • Nested classes/interfaces inherited from class java.awt.Container

        java.awt.Container.AccessibleAWTContainer

      • Nested classes/interfaces inherited from class java.awt.Component

        java.awt.Component.AccessibleAWTComponent, java.awt.Component.BaselineResizeBehavior, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy

    • Field Summary

      • Fields inherited from class javax.swing.JComponent

        listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW

      • Fields inherited from class java.awt.Component

        accessibleContext, BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

      • Fields inherited from interface java.awt.image.ImageObserver

        ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

    • Constructor Summary

      Constructors 
      Constructor Description
      TaskMonitorComponent()
      Construct a new TaskMonitorComponent.
      TaskMonitorComponent​(boolean includeTextField, boolean includeCancelButton)  

    • Method Summary

      All Methods Static 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 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.
      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 maxValue)
      Initialized this TaskMonitor to the given max values.
      boolean isCancelEnabled()
      Returns true if cancel ability is enabled
      boolean isCancelled()
      Returns true if the user has cancelled the operation.
      boolean isIndeterminate()
      Returns true if setIndeterminate(boolean) with a value of true has been called.
      static void main​(java.lang.String[] args)
      Simple test for the TaskMonitorComponent class.
      protected void notifyChangeListeners()  
      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 reset()
      Reset this monitor so that it can be reused.
      void setCancelEnabled​(boolean enable)
      Set the enablement 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 message)
      Sets a message giving additional information about the current progress.
      void setProgress​(long value)
      Sets the current progress value.
      void setShowProgressValue​(boolean showProgressValue)
      True (the default) signals to paint the progress information inside of the progress bar.
      void setTaskName​(java.lang.String name)
      Set the name of the task; the name shows up in the tool tip for the cancel button.
      void showCancelButton​(boolean showCancel)
      Show or not show the cancel button according to the showCancel param.
      void showProgress​(boolean b)
      Set whether the progress bar should be visible.
      void showProgressIcon​(boolean showIcon)
      Show or not show the progress icon (spinning globe) according to the showIcon param.

      • Methods inherited from class javax.swing.JPanel

        getAccessibleContext, getUI, getUIClassID, paramString, setUI, updateUI

      • Methods inherited from class javax.swing.JComponent

        addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentGraphics, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update

      • Methods inherited from class java.awt.Container

        add, add, add, add, add, addContainerListener, addImpl, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, transferFocusDownCycle, validate, validateTree

      • Methods inherited from class java.awt.Component

        action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, createImage, createImage, createVolatileImage, createVolatileImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, requestFocus, requestFocus, requestFocusInWindow, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setMixingCutoutShape, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • TaskMonitorComponent

        public TaskMonitorComponent()
        Construct a new TaskMonitorComponent.
        Parameters:
        l - listener that is notified when the task completes or the user cancels the task

      • TaskMonitorComponent

        public TaskMonitorComponent​(boolean includeTextField,
                            boolean includeCancelButton)

    • Method Detail

      • reset

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

      • isCancelled

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

      • 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 interface TaskMonitor
        Parameters:
        message - more information

      • 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
        See Also:
        JProgressBar

      • 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

      • 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

      • showProgress

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

      • setTaskName

        public void setTaskName​(java.lang.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

      • showCancelButton

        public void showCancelButton​(boolean showCancel)
        Show or not show the cancel button according to the showCancel param.

      • showProgressIcon

        public void showProgressIcon​(boolean showIcon)
        Show or not show the progress icon (spinning globe) according to the showIcon param.

      • 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:

      • main

        public static void main​(java.lang.String[] args)
        Simple test for the TaskMonitorComponent class.
        Parameters:
        args - not used

      • 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.

      • notifyChangeListeners

        protected void notifyChangeListeners()

      • 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