com.steema.teechart.tools
Class SeriesAnimation

java.lang.Object
  com.steema.teechart.TeeBase
      com.steema.teechart.tools.Tool
          com.steema.teechart.tools.ToolSeries
              com.steema.teechart.tools.SeriesAnimation

All Implemented Interfaces:

java.io.Serializable

public class SeriesAnimation
extends ToolSeries

Title: SeriesAnimation class

Description: Series Animation tool.

Copyright (c) 2005-2008 by Steema Software SL. All Rights Reserved.

Company: Steema Software SL

See Also:

Serialized Form

Field Summary

protected NumberResolver

customStep

Fields inherited from class com.steema.teechart.tools.ToolSeries

iSeries

Fields inherited from class com.steema.teechart.tools.Tool

bBrush, clickTolerance, listenerList, pPen

Fields inherited from class com.steema.teechart.TeeBase

chart

Constructor Summary

SeriesAnimation()

SeriesAnimation(IBaseChart c)

SeriesAnimation(Series s)

Method Summary

void	execute()
java.lang.String	getDescription() Gets descriptive text.
int	getDrawEvery() Determines the points to perform animation on.
boolean	getStartAtMin() Changes all series point values to the lowest series value.
double	getStartValue() All series points from when the animation starts.
int	getSteps() Number of animation steps.
java.lang.String	getSummary() Gets detailed descriptive text.
protected java.lang.Object	readResolve()
void	removeStepResolver()
void	setDrawEvery(int value) Determines the points to perform animation on.
void	setStartAtMin(boolean value) Changes all series point values to the lowest series value.
void	setStartValue(double value) Sets all series points from when the animation starts.
void	setStepResolver(NumberResolver resolver)
void	setSteps(int value) Number of animation steps.

Methods inherited from class com.steema.teechart.tools.ToolSeries

getHorizAxis, getSeries, getVertAxis, setSeries

Methods inherited from class com.steema.teechart.tools.Tool

addMouseMotionListener, chartEvent, fireChanged, fireClicked, fireDragged, fireDragging, fireMouse, fireResized, getActive, getBitmapEditor, mouseEvent, removeMouseMotionListener, setActive, setChart, toString

Methods inherited from class com.steema.teechart.TeeBase

getChart, invalidate, setBooleanProperty, setColorProperty, setDoubleProperty, setIntegerProperty, setStringProperty

Methods inherited from class java.lang.Object

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

Field Detail

customStep

protected transient NumberResolver customStep

Constructor Detail

SeriesAnimation

public SeriesAnimation(Series s)

SeriesAnimation

public SeriesAnimation()

SeriesAnimation

public SeriesAnimation(IBaseChart c)

Method Detail

setStepResolver

public void setStepResolver(NumberResolver resolver)

removeStepResolver

public void removeStepResolver()

readResolve

protected java.lang.Object readResolve()

Overrides:

readResolve in class Tool

getDescription

public java.lang.String getDescription()

Gets descriptive text.

Overrides:

getDescription in class Tool

Returns:

String

getSummary

public java.lang.String getSummary()

Gets detailed descriptive text.

Overrides:

getSummary in class Tool

Returns:

String

execute

public void execute()
             throws java.lang.InstantiationException,
                    java.lang.IllegalAccessException

Throws:

java.lang.InstantiationException

java.lang.IllegalAccessException

getDrawEvery

public int getDrawEvery()

Determines the points to perform animation on.
By default, DrawEvery is zero.
This means the animation will be performed using all series points at once.
Setting DrawEvery to, for example, one, means the animation will be performed on each series point individually.
Default value: 0

Returns:

int

setDrawEvery

public void setDrawEvery(int value)

Determines the points to perform animation on.
Default value: 0

Parameters:

value - int

getStartAtMin

public boolean getStartAtMin()

Changes all series point values to the lowest series value.
Setting StartAtMin to false, and setting the StartValue method, makes the animation start at that value.
Default value: true

Returns:

boolean

setStartAtMin

public void setStartAtMin(boolean value)

Changes all series point values to the lowest series value.
Default value: true

Parameters:

value - boolean

getStartValue

public double getStartValue()

All series points from when the animation starts.
Default value: 0

Returns:

double

setStartValue

public void setStartValue(double value)

Sets all series points from when the animation starts.
Default value: 0

Parameters:

value - double

getSteps

public int getSteps()

Number of animation steps.
When the number of steps is bigger, the animation is slower.
Default alue: 100

Returns:

int

setSteps

public void setSteps(int value)

Number of animation steps.
When the number of steps is bigger, the animation is slower.
Default alue: 100

Parameters:

value - int