info.aduna.clustermap.export
Class AnimationFrameExporter

java.lang.Object
  info.aduna.clustermap.export.AnimationFrameExporter

public class AnimationFrameExporter
extends Object

AnimationFrameExporter is capable of exporting a transition between two or more Graphs to a number of frames that can be used for an animated image (e.g. an animated GIF).

Field Summary

static int	DEFAULT_FRAME_RATE
static int	DEFAULT_TRANSITION_DURATION

Constructor Summary

AnimationFrameExporter(ClusterMap map)

Method Summary

void	addListener(AnimationFrameExporterListener l) Adds an AnimationFrameExporterListener to the list of AnimationFrameExporterListeners.
void	export(List<Graph> graphs) Exports the specified list of graphs to an animation.
String	getDirectory()
String	getFileBaseName()
int	getFrameRate()
int	getTransitionDuration()
void	removeListener(AnimationFrameExporterListener l) Removes an AnimationFrameExporterListener from the list of AnimationFrameExporterListeners.
void	setDirectory(String directory) Sets the directory where the animation files will be stored.
void	setFileBaseName(String fileBaseName) Sets the file base name property.
void	setFrameRate(int frameRate) Sets the frame rate property.
void	setTransitionDuration(int duration) Sets the value of the transition duration property.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_TRANSITION_DURATION

public static final int DEFAULT_TRANSITION_DURATION

See Also:

Constant Field Values

DEFAULT_FRAME_RATE

public static final int DEFAULT_FRAME_RATE

See Also:

Constant Field Values

Constructor Detail

AnimationFrameExporter

public AnimationFrameExporter(ClusterMap map)

Method Detail

setTransitionDuration

public void setTransitionDuration(int duration)
                           throws IllegalArgumentException

Sets the value of the transition duration property.

Throws:

IllegalArgumentException - when the specified value is less than zero.

getTransitionDuration

public int getTransitionDuration()

setFrameRate

public void setFrameRate(int frameRate)
                  throws IllegalArgumentException

Sets the frame rate property.

Throws:

IllegalArgumentException - when the specified value is less than zero.

getFrameRate

public int getFrameRate()

setDirectory

public void setDirectory(String directory)
                  throws IllegalArgumentException

Sets the directory where the animation files will be stored.

Throws:

IllegalArgumentException - when the specified String is 'null'.

getDirectory

public String getDirectory()

setFileBaseName

public void setFileBaseName(String fileBaseName)
                     throws IllegalArgumentException

Sets the file base name property.

Throws:

IllegalArgumentException - when the specified String is 'null'.

getFileBaseName

public String getFileBaseName()

addListener

public void addListener(AnimationFrameExporterListener l)

Adds an AnimationFrameExporterListener to the list of AnimationFrameExporterListeners.

removeListener

public void removeListener(AnimationFrameExporterListener l)

Removes an AnimationFrameExporterListener from the list of AnimationFrameExporterListeners.

export

public void export(List<Graph> graphs)
            throws IllegalArgumentException

Exports the specified list of graphs to an animation.

Throws:

IllegalArgumentException - when the specified List contains less than two graphs.