net.refractions.udig.project.ui
Interface IAnimation

All Superinterfaces:

IDrawCommand

public interface IAnimation
extends IDrawCommand

This Commands manages the timing of a short animation being drawn on the ViewportPane.

Author:

jeichar

Method Summary

short	getFrameInterval() Gets time the interval between the frames in milliseconds.
boolean	hasNext() Returns true if the animation has more frames to display.
void	nextFrame() Increments the current frame.
void	run(IProgressMonitor monitor) This method draws the current frame and fires a FRAME event

Methods inherited from interface net.refractions.udig.project.ui.commands.IDrawCommand

dispose, getValidArea, isValid, setGraphics, setValid

Method Detail

getFrameInterval

short getFrameInterval()

Gets time the interval between the frames in milliseconds.

The time cannot be smaller than 100 milliseconds

Returns:

time the interval between the frames in milliseconds.

nextFrame

void nextFrame()

Increments the current frame. The next time run is called the frame should be drawn

hasNext

boolean hasNext()

Returns true if the animation has more frames to display.

Returns:

true if the animation has more frames to display.

run

void run(IProgressMonitor monitor)
         throws java.lang.Exception

This method draws the current frame and fires a FRAME event

Throws:

java.lang.Exception