Class mxAnimation

java.lang.Object
com.mxgraph.util.mxEventSource
com.mxgraph.swing.util.mxAnimation
Direct Known Subclasses:
mxMorphing

public class mxAnimation extends mxEventSource
Baseclass for all timer-based animations. Fires mxEvent.DONE when the stopAnimation method is called. Implement updateAnimation for the actual animation or listen to mxEvent.EXECUTE.
  • Field Details

    • DEFAULT_DELAY

      public static int DEFAULT_DELAY
      Specifies the default delay for animations in ms. Default is 20.
    • delay

      protected int delay
      Default is DEFAULT_DELAY.
    • timer

      protected Timer timer
      Time instance that is used for timing the animation.
  • Constructor Details

    • mxAnimation

      public mxAnimation()
      Constructs a new animation instance with the given repaint delay.
    • mxAnimation

      public mxAnimation(int delay)
      Constructs a new animation instance with the given repaint delay.
  • Method Details

    • getDelay

      public int getDelay()
      Returns the delay for the animation.
    • setDelay

      public void setDelay(int value)
      Sets the delay for the animation.
    • isRunning

      public boolean isRunning()
      Returns true if the animation is running.
    • startAnimation

      public void startAnimation()
      Starts the animation by repeatedly invoking updateAnimation.
    • updateAnimation

      public void updateAnimation()
      Hook for subclassers to implement the animation. Invoke stopAnimation when finished, startAnimation to resume. This is called whenever the timer fires and fires an mxEvent.EXECUTE event with no properties.
    • stopAnimation

      public void stopAnimation()
      Stops the animation by deleting the timer and fires mxEvent.DONE.