org.apache.batik.anim.timing

Class InstanceTime

public class InstanceTime extends Object implements Comparable

A class that represents an instance time created from a timing specification.
Field Summary
protected booleanclearOnReset
Whether this InstanceTime should be removed from an element's begin or end instance time lists upon reset.
protected TimingSpecifiercreator
The {@link TimingSpecifier} that created this InstanceTime.
protected floattime
The time.
protected Intervaltimebase
The Interval on which this InstanceTime is dependent, or null if the InstanceTime was not created from a syncbase value.
Constructor Summary
InstanceTime(TimingSpecifier creator, float time, Interval timebase, boolean clearOnReset)
Creates a new InstanceTime.
Method Summary
intcompareTo(Object o)
Compares this InstanceTime with another.
booleangetClearOnReset()
Returns whether the InstanceTime should be removed from the element's begin or end instance time list when it is reset.
floatgetTime()
Returns the time of this instance time.
StringtoString()
Returns a string representation of this InstanceTime.

Field Detail

clearOnReset

protected boolean clearOnReset
Whether this InstanceTime should be removed from an element's begin or end instance time lists upon reset.

creator

protected TimingSpecifier creator
The {@link TimingSpecifier} that created this InstanceTime.

time

protected float time
The time.

timebase

protected Interval timebase
The Interval on which this InstanceTime is dependent, or null if the InstanceTime was not created from a syncbase value.

Constructor Detail

InstanceTime

public InstanceTime(TimingSpecifier creator, float time, Interval timebase, boolean clearOnReset)
Creates a new InstanceTime.

Parameters: creator the TimingSpecifier that created this InstanceTime time the new time, in parent simple time timebase the interval from which this InstanceTime was created clearOnReset whether this InstanceTime should be removed from an instance time list upon element reset

Method Detail

compareTo

public int compareTo(Object o)
Compares this InstanceTime with another.

getClearOnReset

public boolean getClearOnReset()
Returns whether the InstanceTime should be removed from the element's begin or end instance time list when it is reset.

getTime

public float getTime()
Returns the time of this instance time.

toString

public String toString()
Returns a string representation of this InstanceTime.
Copyright B) 2007 Apache Software Foundation. All Rights Reserved.