de.frag.umlplugin.anim
Class AbstractAnimationObject

java.lang.Object
  extended by de.frag.umlplugin.anim.AbstractAnimationObject
All Implemented Interfaces:
AnimationObject

public abstract class AbstractAnimationObject
extends java.lang.Object
implements AnimationObject

Abstract base class for animation objects.


Constructor Summary
AbstractAnimationObject(long preferredDuration)
           
 
Method Summary
 void disposeAnimation()
          Disposes the animation object.
 void initAnimation()
          Initializes the animation object.
 long preferredDuration()
          Returns the preferred animation length in milliseconds that the display of all provided animation frames should last.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface de.frag.umlplugin.anim.AnimationObject
calcFrame
 

Constructor Detail

AbstractAnimationObject

public AbstractAnimationObject(long preferredDuration)
Method Detail

initAnimation

public void initAnimation()
Description copied from interface: AnimationObject
Initializes the animation object. This method should be called prior to calling calcFrame.

Specified by:
initAnimation in interface AnimationObject

disposeAnimation

public void disposeAnimation()
Description copied from interface: AnimationObject
Disposes the animation object. This method is invoked by an animation player after the last invocation of calcFrame was performed or AnimationPlayer.stop() has been invoked.

Specified by:
disposeAnimation in interface AnimationObject

preferredDuration

public long preferredDuration()
Description copied from interface: AnimationObject
Returns the preferred animation length in milliseconds that the display of all provided animation frames should last. NOTE: The preferred duration of an animation has to be greater than 0!

Specified by:
preferredDuration in interface AnimationObject
Returns:
the preferred duration, which has to be greater than 0