org.apache.batik.bridge

Class SVGAnimationElementBridge

public abstract class SVGAnimationElementBridge extends AbstractSVGBridge implements GenericBridge, BridgeUpdateHandler, SVGAnimationContext, AnimatableElement

An abstract base class for the SVG animation element bridges.

Nested Class Summary
protected class	SVGAnimationElementBridge.SVGTimedElement A TimedElement class for SVG animation elements.

Field Summary
protected AbstractAnimation	animation The animation object that provides the values for the animation.
protected AnimationTarget	animationTarget The AnimationTarget the provides a context to the animation engine.
protected short	animationType The animation type.
protected String	attributeLocalName The local name of the attribute or the name of the property being animated.
protected String	attributeNamespaceURI The namespace URI of the attribute being animated.
protected BridgeContext	ctx The BridgeContext to be used.
protected SVGOMElement	element The animation element.
protected SVGAnimationEngine	eng The AnimationEngine that manages all of the animations in the document.
protected SVGOMElement	targetElement The target element of the animation.
protected TimedElement	timedElement The TimedElement object that provides the timing for the animation.

Method Summary
void	addTargetListener(String pn, AnimationTargetListener l) Adds a listener for changes to the given attribute value.
boolean	beginElement() DOM: Implements org.w3c.dom.smil.ElementTimeControl#beginElement().
boolean	beginElementAt(float offset) DOM: Implements org.w3c.dom.smil.ElementTimeControl#beginElementAt(float).
protected abstract boolean	canAnimateType(int type) Returns whether the animation element being handled by this bridge can animate attributes of the specified type.
protected boolean	checkValueType(AnimatableValue v) Returns whether the specified AnimatableValue is of a type allowed by this animation.
protected abstract AbstractAnimation	createAnimation(AnimationTarget t) Creates the animation object for the animation element.
protected TimedElement	createTimedElement() Creates a TimedElement for the animation element.
void	dispose() Disposes this BridgeUpdateHandler and releases all resources.
boolean	endElement() DOM: Implements org.w3c.dom.smil.ElementTimeControl#endElement().
boolean	endElementAt(float offset) DOM: Implements org.w3c.dom.smil.ElementTimeControl#endElementAt(float).
Rectangle2D	getBBox()
AffineTransform	getCTM()
float	getCurrentTime() DOM: Implements org.w3c.dom.svg.SVGAnimationElement#getCurrentTime().
float	getFontSize()
AffineTransform	getGlobalTransform()
float	getHyperlinkBeginTime() Returns the time that the document would seek to if this animation element were hyperlinked to, or `NaN` if there is no such begin time.
float	getPixelToMM() Returns the size of a px CSS unit in millimeters.
float	getPixelUnitToMillimeter() Returns the size of a px CSS unit in millimeters.
AffineTransform	getScreenTransform()
float	getSimpleDuration() DOM: Implements org.w3c.dom.svg.SVGAnimationElement#getSimpleDuration().
float	getStartTime() DOM: Implements org.w3c.dom.svg.SVGAnimationElement#getStartTime().
SVGElement	getTargetElement() DOM: Implements org.w3c.dom.svg.SVGAnimationElement#getTargetElement().
TimedElement	getTimedElement() Returns the TimedElement for the animation.
AnimatableValue	getUnderlyingValue() Returns the underlying value of the animated attribute.
float	getViewportHeight()
float	getViewportWidth()
void	handleAnimatedAttributeChanged(AnimatedLiveAttributeValue alav) Invoked when the animated value of an animatable attribute has changed.
void	handleCSSEngineEvent(CSSEngineEvent evt) Invoked when an CSSEngineEvent is fired.
void	handleDOMAttrModifiedEvent(MutationEvent evt) Invoked when an MutationEvent of type 'DOMAttrModified' is fired.
void	handleDOMCharacterDataModified(MutationEvent evt) Invoked when an MutationEvent of type 'DOMCharacterDataModified' is fired.
void	handleDOMNodeInsertedEvent(MutationEvent evt) Invoked when an MutationEvent of type 'DOMNodeInserted' is fired.
void	handleDOMNodeRemovedEvent(MutationEvent evt) Invoked when an MutationEvent of type 'DOMNodeRemoved' is fired.
void	handleElement(BridgeContext ctx, Element e) Handles this animation element.
void	handleOtherAnimationChanged(String type) Invoked when an 'other' animation value has changed.
protected void	initializeAnimation() Parses the animation element's target attributes and adds it to the document's AnimationEngine.
protected void	initializeTimedElement() Parses the animation element's timing attributes and initializes the TimedElement object.
protected void	initializeTimedElement(TimedElement timedElement) Initializes the timing attributes of the timed element.
protected boolean	isConstantAnimation() Returns whether this is a constant animation (i.e., a 'set' animation).
protected AnimatableValue	parseAnimatableValue(String an) Parses an attribute as an AnimatableValue.
void	removeTargetListener(String pn, AnimationTargetListener l) Removes a listener for changes to the given attribute value.
void	setScreenTransform(AffineTransform at)
float	svgToUserSpace(float v, int type, int pcInterp)

Field Detail

animation

protected AbstractAnimation animation

The animation object that provides the values for the animation.

animationTarget

protected AnimationTarget animationTarget

The AnimationTarget the provides a context to the animation engine.

animationType

protected short animationType

The animation type. Must be one of the ANIM_TYPE_* constants defined in AnimationEngine.

attributeLocalName

protected String attributeLocalName

The local name of the attribute or the name of the property being animated.

attributeNamespaceURI

protected String attributeNamespaceURI

The namespace URI of the attribute being animated.

ctx

protected BridgeContext ctx

The BridgeContext to be used.

element

protected SVGOMElement element

The animation element.

eng

protected SVGAnimationEngine eng

The AnimationEngine that manages all of the animations in the document.

targetElement

protected SVGOMElement targetElement

The target element of the animation.

timedElement

protected TimedElement timedElement

The TimedElement object that provides the timing for the animation.

Method Detail

addTargetListener

public void addTargetListener(String pn, AnimationTargetListener l)

Adds a listener for changes to the given attribute value.

beginElement

public boolean beginElement()

DOM: Implements org.w3c.dom.smil.ElementTimeControl#beginElement().

beginElementAt

public boolean beginElementAt(float offset)

DOM: Implements org.w3c.dom.smil.ElementTimeControl#beginElementAt(float).

canAnimateType

protected abstract boolean canAnimateType(int type)

Returns whether the animation element being handled by this bridge can animate attributes of the specified type.

Parameters: type one of the TYPE_ constants defined in SVGTypes.

checkValueType

protected boolean checkValueType(AnimatableValue v)

Returns whether the specified AnimatableValue is of a type allowed by this animation.

createAnimation

protected abstract AbstractAnimation createAnimation(AnimationTarget t)

Creates the animation object for the animation element.

createTimedElement

protected TimedElement createTimedElement()

Creates a TimedElement for the animation element.

dispose

public void dispose()

Disposes this BridgeUpdateHandler and releases all resources.

endElement

public boolean endElement()

DOM: Implements org.w3c.dom.smil.ElementTimeControl#endElement().

endElementAt

public boolean endElementAt(float offset)

DOM: Implements org.w3c.dom.smil.ElementTimeControl#endElementAt(float).

getBBox

public Rectangle2D getBBox()

getCTM

public AffineTransform getCTM()

getCurrentTime

public float getCurrentTime()

DOM: Implements org.w3c.dom.svg.SVGAnimationElement#getCurrentTime().

getFontSize

public float getFontSize()

getGlobalTransform

public AffineTransform getGlobalTransform()

getHyperlinkBeginTime

public float getHyperlinkBeginTime()

Returns the time that the document would seek to if this animation element were hyperlinked to, or NaN if there is no such begin time.

getPixelToMM

public float getPixelToMM()

Returns the size of a px CSS unit in millimeters. This will be removed after next release.

getPixelUnitToMillimeter

public float getPixelUnitToMillimeter()

Returns the size of a px CSS unit in millimeters.

getScreenTransform

public AffineTransform getScreenTransform()

getSimpleDuration

public float getSimpleDuration()

DOM: Implements org.w3c.dom.svg.SVGAnimationElement#getSimpleDuration(). With the difference that an indefinite simple duration is returned as INDEFINITE, rather than throwing an exception.

getStartTime

public float getStartTime()

DOM: Implements org.w3c.dom.svg.SVGAnimationElement#getStartTime().

getTargetElement

public SVGElement getTargetElement()

DOM: Implements org.w3c.dom.svg.SVGAnimationElement#getTargetElement().

getTimedElement

public TimedElement getTimedElement()

Returns the TimedElement for the animation.

getUnderlyingValue

public AnimatableValue getUnderlyingValue()

Returns the underlying value of the animated attribute. Used for composition of additive animations. This should be overridden in descendant classes that are for 'other' animations.