org.apache.batik.anim.values
Class AnimatableNumberOrPercentageValue

java.lang.Object
  extended by org.apache.batik.anim.values.AnimatableValue
      extended by org.apache.batik.anim.values.AnimatableNumberValue
          extended by org.apache.batik.anim.values.AnimatableNumberOrPercentageValue

public class AnimatableNumberOrPercentageValue
extends AnimatableNumberValue

A number-or-percentage value in the animation system.


Field Summary
protected  boolean isPercentage
          Whether the number is a percentage.
 
Fields inherited from class org.apache.batik.anim.values.AnimatableNumberValue
value
 
Fields inherited from class org.apache.batik.anim.values.AnimatableValue
decimalFormat, hasChanged, target
 
Constructor Summary
protected AnimatableNumberOrPercentageValue(AnimationTarget target)
          Creates a new, uninitialized AnimatableNumberOrPercentageValue.
  AnimatableNumberOrPercentageValue(AnimationTarget target, float n)
          Creates a new AnimatableNumberOrPercentageValue with a number.
  AnimatableNumberOrPercentageValue(AnimationTarget target, float n, boolean isPercentage)
          Creates a new AnimatableNumberOrPercentageValue with either a number or a percentage.
 
Method Summary
 boolean canPace()
          Returns whether two values of this type can have their distance computed, as needed by paced animation.
 float distanceTo(AnimatableValue other)
          Returns the absolute distance between this value and the specified other value.
 String getCssText()
          Returns the CSS text representation of the value.
 AnimatableValue getZeroValue()
          Returns a zero value of this AnimatableValue's type.
 AnimatableValue interpolate(AnimatableValue result, AnimatableValue to, float interpolation, AnimatableValue accumulation, int multiplier)
          Performs interpolation to the given value.
 boolean isPercentage()
          Returns whether the value is a percentage.
 
Methods inherited from class org.apache.batik.anim.values.AnimatableNumberValue
getValue
 
Methods inherited from class org.apache.batik.anim.values.AnimatableValue
formatNumber, hasChanged, toString, toStringRep
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

isPercentage

protected boolean isPercentage
Whether the number is a percentage.

Constructor Detail

AnimatableNumberOrPercentageValue

protected AnimatableNumberOrPercentageValue(AnimationTarget target)
Creates a new, uninitialized AnimatableNumberOrPercentageValue.


AnimatableNumberOrPercentageValue

public AnimatableNumberOrPercentageValue(AnimationTarget target,
                                         float n)
Creates a new AnimatableNumberOrPercentageValue with a number.


AnimatableNumberOrPercentageValue

public AnimatableNumberOrPercentageValue(AnimationTarget target,
                                         float n,
                                         boolean isPercentage)
Creates a new AnimatableNumberOrPercentageValue with either a number or a percentage.

Method Detail

interpolate

public AnimatableValue interpolate(AnimatableValue result,
                                   AnimatableValue to,
                                   float interpolation,
                                   AnimatableValue accumulation,
                                   int multiplier)
Performs interpolation to the given value.

Overrides:
interpolate in class AnimatableNumberValue
Parameters:
result - the object in which to store the result of the interpolation, or null if a new object should be created
to - the value this value should be interpolated towards, or null if no actual interpolation should be performed
interpolation - the interpolation distance, 0 <= interpolation <= 1
accumulation - an accumulation to add to the interpolated value
multiplier - an amount the accumulation values should be multiplied by before being added to the interpolated value

isPercentage

public boolean isPercentage()
Returns whether the value is a percentage.


canPace

public boolean canPace()
Returns whether two values of this type can have their distance computed, as needed by paced animation.

Overrides:
canPace in class AnimatableNumberValue

distanceTo

public float distanceTo(AnimatableValue other)
Returns the absolute distance between this value and the specified other value.

Overrides:
distanceTo in class AnimatableNumberValue

getZeroValue

public AnimatableValue getZeroValue()
Returns a zero value of this AnimatableValue's type.

Overrides:
getZeroValue in class AnimatableNumberValue

getCssText

public String getCssText()
Returns the CSS text representation of the value.

Overrides:
getCssText in class AnimatableNumberValue


Copyright © 2008 Apache Software Foundation. All Rights Reserved.