Package ghidra.util.task

Class SwingUpdateManager

  • public class SwingUpdateManager
extends java.lang.Object
    A class to allow clients to buffer events. UI components may receive numbers events to make changes to their underlying data model. Further, for many of these clients, it is sufficient to perform one update to capture all of the changes. In this scenario, the client can use this class to keep pushing off internal updates until: 1) the flurry of events has settled down, or 2) some specified amount of time has expired.

    The various methods dictate when the client will get a callback:

    • update() - if this is the first call to update, then do the work immediately; otherwise, buffer the update request until the timeout has expired.
    • updateNow() - perform the callback now.
    • updateLater() - buffer the update request until the timeout has expired.
    • Non-blocking update now - this is a conceptual use-case, where the client wishes to perform an immediate update, but not during the current Swing event. To achieve this, you could call something like: 
                                      SwingUtilities.invokeLater(() -> updateManager.updateNow());

    This class is safe to use in a multi-threaded environment. State variables are guarded via synchronization on this object. The Swing thread is used to perform updates, which guarantees that only one update will happen at a time. There is one state variable, the workCount, that is changed both in the synchronized blocks and the Swing thread which is an atomic variable. This variable must be updated/incremented when the synchronized variables are cleared to prevent isBusy() from returning false when there is a gap between 'work posted' and 'work execution'.

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static int DEFAULT_MAX_DELAY  

    • Constructor Summary

      Constructors 
      Constructor Description
      SwingUpdateManager​(int minDelay, int maxDelay, java.lang.Runnable r)
      Constructs a new SwingUpdateManager
      SwingUpdateManager​(int minDelay, int maxDelay, java.lang.String name, java.lang.Runnable r)
      Constructs a new SwingUpdateManager
      SwingUpdateManager​(int minDelay, java.lang.Runnable r)
      Constructs a new SwingUpdateManager
      SwingUpdateManager​(java.lang.Runnable r)
      Constructs a new SwingUpdateManager.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void dispose()  
      boolean hasPendingUpdates()
      Returns true if there is a pending request that hasn't started yet.
      boolean isBusy()
      Returns true if any work is being performed or if there is buffered work.
      boolean isDisposed()  
      void stop()
      Signals to stop any buffered work.
      java.lang.String toString()  
      java.lang.String toStringDebug()  
      void update()
      Signals to perform an update.
      void updateLater()
      Signals to perform an update.
      void updateNow()
      Signals to perform an update.

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • SwingUpdateManager

        public SwingUpdateManager​(java.lang.Runnable r)
        Constructs a new SwingUpdateManager.
        Parameters:
        r - the runnable that performs the client work.

      • SwingUpdateManager

        public SwingUpdateManager​(int minDelay,
                          java.lang.Runnable r)
        Constructs a new SwingUpdateManager

        Note: The minDelay will always be at least MIN_DELAY_FLOOR, regardless of the given value.

        Parameters:
        minDelay - the minimum number of milliseconds to wait once the event stream stops coming in before actually updating the screen.
        r - the runnable that performs the client work.

      • SwingUpdateManager

        public SwingUpdateManager​(int minDelay,
                          int maxDelay,
                          java.lang.Runnable r)
        Constructs a new SwingUpdateManager

        Note: The minDelay will always be at least MIN_DELAY_FLOOR, regardless of the given value.

        Parameters:
        minDelay - the minimum number of milliseconds to wait once the event stream stops coming in before actually updating the screen.
        maxDelay - the maximum amount of time to wait between gui updates.
        r - the runnable that performs the client work.

      • SwingUpdateManager

        public SwingUpdateManager​(int minDelay,
                          int maxDelay,
                          java.lang.String name,
                          java.lang.Runnable r)
        Constructs a new SwingUpdateManager

        Note: The minDelay will always be at least MIN_DELAY_FLOOR, regardless of the given value.

        Parameters:
        minDelay - the minimum number of milliseconds to wait once the event stream stops coming in before actually updating the screen.
        maxDelay - the maximum amount of time to wait between gui updates.
        name - The name of this update manager; this allows for selective trace logging
        r - the runnable that performs the client work.

    • Method Detail

      • update

        public void update()
        Signals to perform an update. See the class header for the usage of the various update methods.

      • updateLater

        public void updateLater()
        Signals to perform an update. See the class header for the usage of the various update methods.

      • updateNow

        public void updateNow()
        Signals to perform an update. See the class header for the usage of the various update methods.

      • stop

        public void stop()
        Signals to stop any buffered work. This will not stop any in-progress work.

      • hasPendingUpdates

        public boolean hasPendingUpdates()
        Returns true if there is a pending request that hasn't started yet. Any currently executing requests will not affect this call.
        Returns:
        true if there is a pending request that hasn't started yet.

      • isBusy

        public boolean isBusy()
        Returns true if any work is being performed or if there is buffered work.
        Returns:
        true if any work is being performed or if there is buffered work.

      • dispose

        public void dispose()

      • isDisposed

        public boolean isDisposed()

      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object

      • toStringDebug

        public java.lang.String toStringDebug()