Class AbstractAnimatorJob

    • Field Summary

      Fields 
      Modifier and Type Field Description
      protected org.jdesktop.animation.timing.Animator animator  
      protected boolean isShortcut  
      protected org.apache.logging.log4j.Logger log  
      static int TOO_BIG_TO_ANIMATE
      A somewhat arbitrary vertex count past which not to animate actions that are intensive.
    • Method Summary

      All Methods Instance Methods Abstract Methods Concrete Methods 
      Modifier and Type Method Description
      boolean canShortcut()
      Returns true if the job can be told to stop running, but to still perform any final work before being done.
      protected abstract org.jdesktop.animation.timing.Animator createAnimator()  
      void dispose()
      Call to immediately stop this job, ignoring any exceptions or state issues that arise.
      void execute​(GraphJobListener listener)
      Tells this job to do its work.
      protected abstract void finished()
      A callback given when this animator has run to completion.
      boolean isFinished()
      Returns true if this job has finished its work
      void setBusyListener​(BusyListener listener)  
      void shortcut()
      Tells this job to stop running, but to still perform any final work before being done.
      protected void stop()  
      java.lang.String toString()  
      protected void trace​(java.lang.String message)  
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
    • Field Detail

      • TOO_BIG_TO_ANIMATE

        public static final int TOO_BIG_TO_ANIMATE
        A somewhat arbitrary vertex count past which not to animate actions that are intensive.
        See Also:
        Constant Field Values
      • log

        protected org.apache.logging.log4j.Logger log
      • animator

        protected org.jdesktop.animation.timing.Animator animator
      • isShortcut

        protected boolean isShortcut
    • Constructor Detail

      • AbstractAnimatorJob

        public AbstractAnimatorJob()
    • Method Detail

      • createAnimator

        protected abstract org.jdesktop.animation.timing.Animator createAnimator()
      • finished

        protected abstract void finished()
        A callback given when this animator has run to completion. This will be called whether the animator is stopped prematurely or ends naturally.
      • setBusyListener

        public void setBusyListener​(BusyListener listener)
      • canShortcut

        public boolean canShortcut()
        Description copied from interface: GraphJob
        Returns true if the job can be told to stop running, but to still perform any final work before being done.
        Specified by:
        canShortcut in interface GraphJob
        Returns:
        true if the job can be shortcut
      • shortcut

        public void shortcut()
        Description copied from interface: GraphJob
        Tells this job to stop running, but to still perform any final work before being done.

        Note: if your job is multi-threaded, then you must make sure to end your thread and work before returning from this method. If that cannot be done in a timely manner, then your GraphJob.canShortcut() should return false.

        Specified by:
        shortcut in interface GraphJob
      • execute

        public void execute​(GraphJobListener listener)
        Description copied from interface: GraphJob
        Tells this job to do its work. This call will be on the Swing thread. It is required that the given listener be called on the Swing thread when the job is finished.
        Specified by:
        execute in interface GraphJob
        Parameters:
        listener - the listener this job is expected to call when its work is finished
      • isFinished

        public boolean isFinished()
        Description copied from interface: GraphJob
        Returns true if this job has finished its work
        Specified by:
        isFinished in interface GraphJob
        Returns:
        true if this job has finished its work
      • dispose

        public void dispose()
        Description copied from interface: GraphJob
        Call to immediately stop this job, ignoring any exceptions or state issues that arise.
        Specified by:
        dispose in interface GraphJob
      • trace

        protected void trace​(java.lang.String message)
      • stop

        protected void stop()
      • toString

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