org.apache.batik.bridge

Class SVGAnimationEngine.AnimationRoot

protected class SVGAnimationEngine.AnimationRoot extends TimedDocumentRoot

A class for the root time container.
Constructor Summary
AnimationRoot()
Creates a new AnimationRoot object.
Method Summary
protected voidcurrentIntervalWillUpdate()
Invoked by timed elements in this document to indicate that the current interval will be re-evaluated at the next sample.
protected voidfireTimeEvent(String eventType, Calendar time, int detail)
Fires a TimeEvent of the given type on this element.
protected EventTargetgetAnimationEventTarget()
Returns the target of this animation as an EventTarget.
ElementgetElement()
Returns the DOM element that corresponds to this timed element, if such a DOM element exists.
protected StringgetEventNamespaceURI(String eventName)
Returns the namespace URI of the event that corresponds to the given animation event name.
protected EventTargetgetEventTargetById(String id)
Returns the event target with the given ID.
protected StringgetEventType(String eventName)
Returns the type of the event that corresponds to the given animation event name.
protected StringgetRepeatEventName()
Returns the name of the repeat event.
protected EventTargetgetRootEventTarget()
Returns the event target that should be listened to for access key events.
protected TimedElementgetTimedElementById(String id)
Returns the timed element with the given ID.
booleanisBefore(TimedElement other)
Returns whether this timed element comes before the given timed element in document order.
protected voidremoveFill()
Invoked to indicate that this timed element has had its fill removed.
protected voidsampledAt(float simpleTime, float simpleDur, int repeatIteration)
Invoked to indicate that this timed element has been sampled at the given time.
protected voidsampledLastValue(int repeatIteration)
Invoked to indicate that this timed element has been sampled at the end of its active time, at an integer multiple of the simple duration.
protected voidtoActive(float begin)
Invoked to indicate this timed element became active at the specified time.
protected voidtoInactive(boolean stillActive, boolean isFrozen)
Invoked to indicate that this timed element became inactive.

Constructor Detail

AnimationRoot

public AnimationRoot()
Creates a new AnimationRoot object.

Method Detail

currentIntervalWillUpdate

protected void currentIntervalWillUpdate()
Invoked by timed elements in this document to indicate that the current interval will be re-evaluated at the next sample.

fireTimeEvent

protected void fireTimeEvent(String eventType, Calendar time, int detail)
Fires a TimeEvent of the given type on this element.

Parameters: eventType the type of TimeEvent ("beginEvent", "endEvent" or "repeatEvent"/"repeat"). time the timestamp of the event object

getAnimationEventTarget

protected EventTarget getAnimationEventTarget()
Returns the target of this animation as an EventTarget. Used for eventbase timing specifiers where the element ID is omitted.

getElement

public Element getElement()
Returns the DOM element that corresponds to this timed element, if such a DOM element exists.

getEventNamespaceURI

protected String getEventNamespaceURI(String eventName)
Returns the namespace URI of the event that corresponds to the given animation event name.

getEventTargetById

protected EventTarget getEventTargetById(String id)
Returns the event target with the given ID.

getEventType

protected String getEventType(String eventName)
Returns the type of the event that corresponds to the given animation event name.

getRepeatEventName

protected String getRepeatEventName()
Returns the name of the repeat event.

Returns: "repeatEvent" for SVG

getRootEventTarget

protected EventTarget getRootEventTarget()
Returns the event target that should be listened to for access key events.

getTimedElementById

protected TimedElement getTimedElementById(String id)
Returns the timed element with the given ID.

isBefore

public boolean isBefore(TimedElement other)
Returns whether this timed element comes before the given timed element in document order.

removeFill

protected void removeFill()
Invoked to indicate that this timed element has had its fill removed.

sampledAt

protected void sampledAt(float simpleTime, float simpleDur, int repeatIteration)
Invoked to indicate that this timed element has been sampled at the given time.

Parameters: simpleTime the sample time in local simple time simpleDur the simple duration of the element repeatIteration the repeat iteration during which the element was sampled

sampledLastValue

protected void sampledLastValue(int repeatIteration)
Invoked to indicate that this timed element has been sampled at the end of its active time, at an integer multiple of the simple duration. This is the "last" value that will be used for filling, which cannot be sampled normally.

toActive

protected void toActive(float begin)
Invoked to indicate this timed element became active at the specified time.

Parameters: begin the time the element became active, in document simple time

toInactive

protected void toInactive(boolean stillActive, boolean isFrozen)
Invoked to indicate that this timed element became inactive.

Parameters: stillActive if true, indicates that the element is still actually active, but between the end of the computed repeat duration and the end of the interval isFrozen whether the element is frozen or not

Copyright B) 2008 Apache Software Foundation. All Rights Reserved.