org.vectomatic.dom.svg

Class OMSVGAnimationElement

java.lang.Object

org.vectomatic.dom.svg.OMNode

org.vectomatic.dom.svg.OMElement

org.vectomatic.dom.svg.OMSVGElement

org.vectomatic.dom.svg.OMSVGAnimationElement

All Implemented Interfaces:

com.google.gwt.event.dom.client.HasAllDragAndDropHandlers, com.google.gwt.event.dom.client.HasAllTouchHandlers, com.google.gwt.event.dom.client.HasClickHandlers, com.google.gwt.event.dom.client.HasDragEndHandlers, com.google.gwt.event.dom.client.HasDragEnterHandlers, com.google.gwt.event.dom.client.HasDragHandlers, com.google.gwt.event.dom.client.HasDragLeaveHandlers, com.google.gwt.event.dom.client.HasDragOverHandlers, com.google.gwt.event.dom.client.HasDragStartHandlers, com.google.gwt.event.dom.client.HasDropHandlers, com.google.gwt.event.dom.client.HasLoadHandlers, com.google.gwt.event.dom.client.HasMouseDownHandlers, com.google.gwt.event.dom.client.HasMouseMoveHandlers, com.google.gwt.event.dom.client.HasMouseOutHandlers, com.google.gwt.event.dom.client.HasMouseOverHandlers, com.google.gwt.event.dom.client.HasMouseUpHandlers, com.google.gwt.event.dom.client.HasTouchCancelHandlers, com.google.gwt.event.dom.client.HasTouchEndHandlers, com.google.gwt.event.dom.client.HasTouchMoveHandlers, com.google.gwt.event.dom.client.HasTouchStartHandlers, com.google.gwt.event.shared.HasHandlers, HasActivateHandlers, HasAnimationHandlers, HasBeginHandlers, HasEndHandlers, HasFocusInHandlers, HasFocusOutHandlers, HasGraphicalHandlers, HasRepeatHandlers, ISVGExternalResourcesRequired, ISVGTests

Direct Known Subclasses:

OMSVGAnimateColorElement, OMSVGAnimateElement, OMSVGAnimateMotionElement, OMSVGAnimateTransformElement, OMSVGSetElement

public abstract class OMSVGAnimationElement
extends OMSVGElement
implements HasGraphicalHandlers, HasAnimationHandlers, ISVGTests, ISVGExternalResourcesRequired

The OMSVGAnimationElement interface is the base interface for all of the animation element interfaces: OMSVGAnimateElement, OMSVGSetElement, OMSVGAnimateColorElement, OMSVGAnimateMotionElement and OMSVGAnimateTransformElement.

Unlike other SVG DOM interfaces, the SVG DOM does not specify convenience DOM properties corresponding to the various language attributes on SVG's animation elements. Specification of these convenience properties in a way that will be compatible with future versions of SMIL Animation is expected in a future version of SVG. The current method for accessing and modifying the attributes on the animation elements is to use the standard getAttribute, setAttribute, getAttributeNS and setAttributeNS defined in DOM Level 2 Core [DOM2].

Field Summary

Fields inherited from class org.vectomatic.dom.svg.OMNode

eventBus, ot

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	OMSVGAnimationElement(SVGAnimationElement ot)

Method Summary

Modifier and Type	Method and Description
com.google.gwt.event.shared.HandlerRegistration	addActivateHandler(ActivateHandler handler) Adds a ActivateHandler handler.
com.google.gwt.event.shared.HandlerRegistration	addBeginHandler(BeginHandler handler) Adds a BeginHandler handler.
com.google.gwt.event.shared.HandlerRegistration	addClickHandler(com.google.gwt.event.dom.client.ClickHandler handler)
com.google.gwt.event.shared.HandlerRegistration	addDragEndHandler(com.google.gwt.event.dom.client.DragEndHandler handler)
com.google.gwt.event.shared.HandlerRegistration	addDragEnterHandler(com.google.gwt.event.dom.client.DragEnterHandler handler)
com.google.gwt.event.shared.HandlerRegistration	addDragHandler(com.google.gwt.event.dom.client.DragHandler handler)
com.google.gwt.event.shared.HandlerRegistration	addDragLeaveHandler(com.google.gwt.event.dom.client.DragLeaveHandler handler)
com.google.gwt.event.shared.HandlerRegistration	addDragOverHandler(com.google.gwt.event.dom.client.DragOverHandler handler)
com.google.gwt.event.shared.HandlerRegistration	addDragStartHandler(com.google.gwt.event.dom.client.DragStartHandler handler)
com.google.gwt.event.shared.HandlerRegistration	addDropHandler(com.google.gwt.event.dom.client.DropHandler handler)
com.google.gwt.event.shared.HandlerRegistration	addEndHandler(EndHandler handler) Adds a EndHandler handler.
com.google.gwt.event.shared.HandlerRegistration	addFocusInHandler(FocusInHandler handler) Adds a FocusInHandler handler.
com.google.gwt.event.shared.HandlerRegistration	addFocusOutHandler(FocusOutHandler handler) Adds a FocusOutHandler handler.
com.google.gwt.event.shared.HandlerRegistration	addLoadHandler(com.google.gwt.event.dom.client.LoadHandler handler)
com.google.gwt.event.shared.HandlerRegistration	addMouseDownHandler(com.google.gwt.event.dom.client.MouseDownHandler handler)
com.google.gwt.event.shared.HandlerRegistration	addMouseMoveHandler(com.google.gwt.event.dom.client.MouseMoveHandler handler)
com.google.gwt.event.shared.HandlerRegistration	addMouseOutHandler(com.google.gwt.event.dom.client.MouseOutHandler handler)
com.google.gwt.event.shared.HandlerRegistration	addMouseOverHandler(com.google.gwt.event.dom.client.MouseOverHandler handler)
com.google.gwt.event.shared.HandlerRegistration	addMouseUpHandler(com.google.gwt.event.dom.client.MouseUpHandler handler)
com.google.gwt.event.shared.HandlerRegistration	addRepeatHandler(RepeatHandler handler) Adds a RepeatHandler handler.
com.google.gwt.event.shared.HandlerRegistration	addTouchCancelHandler(com.google.gwt.event.dom.client.TouchCancelHandler handler)
com.google.gwt.event.shared.HandlerRegistration	addTouchEndHandler(com.google.gwt.event.dom.client.TouchEndHandler handler)
com.google.gwt.event.shared.HandlerRegistration	addTouchMoveHandler(com.google.gwt.event.dom.client.TouchMoveHandler handler)
com.google.gwt.event.shared.HandlerRegistration	addTouchStartHandler(com.google.gwt.event.dom.client.TouchStartHandler handler)
void	beginElement() Creates a begin instance time for the current time.
void	beginElementAt(float offset) Creates a begin instance time for the current time plus the specified offset.
void	endElement() Creates an end instance time for the current time.
void	endElementAt(float offset) Creates a end instance time for the current time plus the specified offset.
float	getCurrentTime() Returns the current time in seconds relative to time zero for the given time container.
OMSVGAnimatedBoolean	getExternalResourcesRequired() Corresponds to attribute ISVGExternalResourcesRequired.getExternalResourcesRequired() on the given element.
OMSVGStringList	getRequiredExtensions() Corresponds to attribute ISVGTests.getRequiredExtensions() on the given element.
OMSVGStringList	getRequiredFeatures() Corresponds to attribute ISVGTests.getRequiredFeatures() on the given element.
float	getSimpleDuration() Returns the number of seconds for the simple duration for this animation.
float	getStartTime() Returns the begin time, in seconds, for this animation element's current interval, if it exists, regardless of whether the interval has begun yet.
OMSVGStringList	getSystemLanguage() Corresponds to attribute ISVGTests.getSystemLanguage() on the given element.
OMSVGElement	getTargetElement() The element which is being animated.
boolean	hasExtension(String extension) Returns true if the user agent supports the given extension, specified by a URI.

Methods inherited from class org.vectomatic.dom.svg.OMSVGElement

addClassNameBaseVal, getClassName, getMarkup, getOwnerSVGElement, getStyle, getViewportElement, getXmlbase, removeClassNameBaseVal, replaceClassNameBaseVal, setClassNameBaseVal, setId, setXmlbase

Methods inherited from class org.vectomatic.dom.svg.OMElement

getAttribute, getAttributeNode, getAttributeNS, getAttributes, getElement, getElementsByTagName, getElementsByTagNameNS, getId, getTagName, hasAttribute, hasAttributeNS, removeAttribute, setAttribute, setAttributeNode, setAttributeNS

Methods inherited from class org.vectomatic.dom.svg.OMNode

addDomHandler, addHandler, appendChild, cleanup, cloneNode, convert, convertList, dispatch, fireEvent, getChildNodes, getEventBus, getFirstChild, getLastChild, getLocalName, getNamespaceURI, getNextSibling, getNode, getNodeName, getNodeType, getNodeValue, getOwnerDocument, getParentNode, getPreviousSibling, hasChildNodes, insertBefore, normalize, removeChild, replaceChild, setNodeValue, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.google.gwt.event.shared.HasHandlers

fireEvent

Constructor Detail

OMSVGAnimationElement

protected OMSVGAnimationElement(SVGAnimationElement ot)

Method Detail

getTargetElement

public final OMSVGElement getTargetElement()

The element which is being animated.

getStartTime

public final float getStartTime()
                         throws com.google.gwt.core.client.JavaScriptException

Returns the begin time, in seconds, for this animation element's current interval, if it exists, regardless of whether the interval has begun yet. If there is no current interval, then a DOMException with code INVALID_STATE_ERR is thrown.

Returns:

The start time, in seconds, of this animation element's current interval.

Throws:

DOMException(INVALID_STATE_ERR) - The animation element does not have a current interval.

com.google.gwt.core.client.JavaScriptException

getCurrentTime

public final float getCurrentTime()

Returns the current time in seconds relative to time zero for the given time container.

Returns:

The current time in seconds relative to time zero for the given time container.

getSimpleDuration

public final float getSimpleDuration()
                              throws com.google.gwt.core.client.JavaScriptException

Returns the number of seconds for the simple duration for this animation. If the simple duration is undefined (e.g., the end time is indefinite), then an exception is raised.

Returns:

number of seconds for the simple duration for this animation.

Throws:

DOMException(NOT_SUPPORTED_ERR) - The simple duration is not determined on the given element.

com.google.gwt.core.client.JavaScriptException

beginElement

public final void beginElement()

Creates a begin instance time for the current time. The new instance time is added to the begin instance times list. The behavior of this method is equivalent to beginElementAt(0).

beginElementAt

public final void beginElementAt(float offset)

Creates a begin instance time for the current time plus the specified offset. The new instance time is added to the begin instance times list.

Parameters:

offset - The offset from the current document time, in seconds, at which to begin the element.

endElement

public final void endElement()

Creates an end instance time for the current time. The new instance time is added to the end instance times list. The behavior of this method is equivalent to endElementAt(0).

endElementAt

public final void endElementAt(float offset)

Creates a end instance time for the current time plus the specified offset. The new instance time is added to the end instance times list.

Parameters:

offset - offset from the current document time, in seconds, at which to end the element.

getExternalResourcesRequired

public final OMSVGAnimatedBoolean getExternalResourcesRequired()

Corresponds to attribute ISVGExternalResourcesRequired.getExternalResourcesRequired() on the given element. Note that the SVG DOM defines the attribute ISVGExternalResourcesRequired.getExternalResourcesRequired() as being of type OMSVGAnimatedBoolean, whereas the SVG language definition says that ISVGExternalResourcesRequired.getExternalResourcesRequired() is not animated. Because the SVG language definition states that ISVGExternalResourcesRequired.getExternalResourcesRequired() cannot be animated, the OMSVGAnimatedBoolean.getAnimVal() will always be the same as the OMSVGAnimatedBoolean.getBaseVal().

Specified by:

getExternalResourcesRequired in interface ISVGExternalResourcesRequired

getRequiredFeatures

public final OMSVGStringList getRequiredFeatures()

Corresponds to attribute ISVGTests.getRequiredFeatures() on the given element.

Specified by:

getRequiredFeatures in interface ISVGTests

getRequiredExtensions

public final OMSVGStringList getRequiredExtensions()

Corresponds to attribute ISVGTests.getRequiredExtensions() on the given element.

Specified by:

getRequiredExtensions in interface ISVGTests

getSystemLanguage

public final OMSVGStringList getSystemLanguage()

Corresponds to attribute ISVGTests.getSystemLanguage() on the given element.

Specified by:

getSystemLanguage in interface ISVGTests

hasExtension

public final boolean hasExtension(String extension)

Returns true if the user agent supports the given extension, specified by a URI.

Specified by:

hasExtension in interface ISVGTests

Parameters:

extension - The name of the extension, expressed as a URI.

Returns:

True or false, depending on whether the given extension is supported.

addClickHandler

public final com.google.gwt.event.shared.HandlerRegistration addClickHandler(com.google.gwt.event.dom.client.ClickHandler handler)

Specified by:

addClickHandler in interface com.google.gwt.event.dom.client.HasClickHandlers

addDragEndHandler

public final com.google.gwt.event.shared.HandlerRegistration addDragEndHandler(com.google.gwt.event.dom.client.DragEndHandler handler)

Specified by:

addDragEndHandler in interface com.google.gwt.event.dom.client.HasDragEndHandlers

addDragEnterHandler

public final com.google.gwt.event.shared.HandlerRegistration addDragEnterHandler(com.google.gwt.event.dom.client.DragEnterHandler handler)

Specified by:

addDragEnterHandler in interface com.google.gwt.event.dom.client.HasDragEnterHandlers

addDragHandler

public final com.google.gwt.event.shared.HandlerRegistration addDragHandler(com.google.gwt.event.dom.client.DragHandler handler)

Specified by:

addDragHandler in interface com.google.gwt.event.dom.client.HasDragHandlers

addDragLeaveHandler

public final com.google.gwt.event.shared.HandlerRegistration addDragLeaveHandler(com.google.gwt.event.dom.client.DragLeaveHandler handler)

Specified by:

addDragLeaveHandler in interface com.google.gwt.event.dom.client.HasDragLeaveHandlers

addDragOverHandler

public final com.google.gwt.event.shared.HandlerRegistration addDragOverHandler(com.google.gwt.event.dom.client.DragOverHandler handler)

Specified by:

addDragOverHandler in interface com.google.gwt.event.dom.client.HasDragOverHandlers

addDragStartHandler

public final com.google.gwt.event.shared.HandlerRegistration addDragStartHandler(com.google.gwt.event.dom.client.DragStartHandler handler)

Specified by:

addDragStartHandler in interface com.google.gwt.event.dom.client.HasDragStartHandlers

addDropHandler

public final com.google.gwt.event.shared.HandlerRegistration addDropHandler(com.google.gwt.event.dom.client.DropHandler handler)

Specified by:

addDropHandler in interface com.google.gwt.event.dom.client.HasDropHandlers

addLoadHandler

public final com.google.gwt.event.shared.HandlerRegistration addLoadHandler(com.google.gwt.event.dom.client.LoadHandler handler)

Specified by:

addLoadHandler in interface com.google.gwt.event.dom.client.HasLoadHandlers

addMouseDownHandler

public final com.google.gwt.event.shared.HandlerRegistration addMouseDownHandler(com.google.gwt.event.dom.client.MouseDownHandler handler)

Specified by:

addMouseDownHandler in interface com.google.gwt.event.dom.client.HasMouseDownHandlers

addMouseMoveHandler

public final com.google.gwt.event.shared.HandlerRegistration addMouseMoveHandler(com.google.gwt.event.dom.client.MouseMoveHandler handler)

Specified by:

addMouseMoveHandler in interface com.google.gwt.event.dom.client.HasMouseMoveHandlers

addMouseOutHandler

public final com.google.gwt.event.shared.HandlerRegistration addMouseOutHandler(com.google.gwt.event.dom.client.MouseOutHandler handler)

Specified by:

addMouseOutHandler in interface com.google.gwt.event.dom.client.HasMouseOutHandlers

addMouseOverHandler

public final com.google.gwt.event.shared.HandlerRegistration addMouseOverHandler(com.google.gwt.event.dom.client.MouseOverHandler handler)

Specified by:

addMouseOverHandler in interface com.google.gwt.event.dom.client.HasMouseOverHandlers

addMouseUpHandler

public final com.google.gwt.event.shared.HandlerRegistration addMouseUpHandler(com.google.gwt.event.dom.client.MouseUpHandler handler)

Specified by:

addMouseUpHandler in interface com.google.gwt.event.dom.client.HasMouseUpHandlers

addTouchCancelHandler

public final com.google.gwt.event.shared.HandlerRegistration addTouchCancelHandler(com.google.gwt.event.dom.client.TouchCancelHandler handler)

Specified by:

addTouchCancelHandler in interface com.google.gwt.event.dom.client.HasTouchCancelHandlers

addTouchEndHandler

public final com.google.gwt.event.shared.HandlerRegistration addTouchEndHandler(com.google.gwt.event.dom.client.TouchEndHandler handler)

Specified by:

addTouchEndHandler in interface com.google.gwt.event.dom.client.HasTouchEndHandlers

addTouchMoveHandler

public final com.google.gwt.event.shared.HandlerRegistration addTouchMoveHandler(com.google.gwt.event.dom.client.TouchMoveHandler handler)

Specified by:

addTouchMoveHandler in interface com.google.gwt.event.dom.client.HasTouchMoveHandlers

addTouchStartHandler

public final com.google.gwt.event.shared.HandlerRegistration addTouchStartHandler(com.google.gwt.event.dom.client.TouchStartHandler handler)

Specified by:

addTouchStartHandler in interface com.google.gwt.event.dom.client.HasTouchStartHandlers

addActivateHandler

public final com.google.gwt.event.shared.HandlerRegistration addActivateHandler(ActivateHandler handler)

Description copied from interface: HasActivateHandlers

Adds a ActivateHandler handler.

Specified by:

addActivateHandler in interface HasActivateHandlers

Parameters:

handler - the activate handler

Returns:

HandlerRegistration used to remove this handler

addBeginHandler

public final com.google.gwt.event.shared.HandlerRegistration addBeginHandler(BeginHandler handler)

Description copied from interface: HasBeginHandlers

Adds a BeginHandler handler.

Specified by:

addBeginHandler in interface HasBeginHandlers

Parameters:

handler - the begin handler

Returns:

HandlerRegistration used to remove this handler

addEndHandler

public final com.google.gwt.event.shared.HandlerRegistration addEndHandler(EndHandler handler)

Description copied from interface: HasEndHandlers

Adds a EndHandler handler.

Specified by:

addEndHandler in interface HasEndHandlers

Parameters:

handler - the end handler

Returns:

HandlerRegistration used to remove this handler

addFocusInHandler

public final com.google.gwt.event.shared.HandlerRegistration addFocusInHandler(FocusInHandler handler)

Description copied from interface: HasFocusInHandlers

Adds a FocusInHandler handler.

Specified by:

addFocusInHandler in interface HasFocusInHandlers

Parameters:

handler - the focusin handler

Returns:

HandlerRegistration used to remove this handler

addFocusOutHandler

public final com.google.gwt.event.shared.HandlerRegistration addFocusOutHandler(FocusOutHandler handler)

Description copied from interface: HasFocusOutHandlers

Adds a FocusOutHandler handler.

Specified by:

addFocusOutHandler in interface HasFocusOutHandlers

Parameters:

handler - the focusout handler

Returns:

HandlerRegistration used to remove this handler

addRepeatHandler

public final com.google.gwt.event.shared.HandlerRegistration addRepeatHandler(RepeatHandler handler)

Description copied from interface: HasRepeatHandlers

Adds a RepeatHandler handler.

Specified by:

addRepeatHandler in interface HasRepeatHandlers

Parameters:

handler - the repeat handler

Returns:

HandlerRegistration used to remove this handler