public interface

ElementTimeControl

org.w3c.dom.smil.ElementTimeControl
Known Indirect Subclasses

Summary

Public Methods
abstract boolean beginElement()
Causes this element to begin the local timeline (subject to sync constraints).
abstract boolean beginElementAt(float offset)
Causes this element to begin the local timeline (subject to sync constraints), at the passed offset from the current time when the method is called.
abstract boolean endElement()
Causes this element to end the local timeline (subject to sync constraints).
abstract boolean endElementAt(float offset)
Causes this element to end the local timeline (subject to sync constraints) at the specified offset from the current time when the method is called.

Public Methods

public abstract boolean beginElement ()

Causes this element to begin the local timeline (subject to sync constraints).

Returns
  • true if the method call was successful and the element was begun. false if the method call failed. Possible reasons for failure include: The element doesn't support the beginElement method. (the begin attribute is not set to "indefinite" ) The element is already active and can't be restart when it is active. (the restart attribute is set to "whenNotActive" ) The element is active or has been active and can't be restart. (the restart attribute is set to "never" ).
Throws
DOMException SYNTAX_ERR: The element was not defined with the appropriate syntax to allow beginElement calls.

public abstract boolean beginElementAt (float offset)

Causes this element to begin the local timeline (subject to sync constraints), at the passed offset from the current time when the method is called. If the offset is >= 0, the semantics are equivalent to an event-base begin with the specified offset. If the offset is < 0, the semantics are equivalent to beginElement(), but the element active duration is evaluated as though the element had begun at the passed (negative) offset from the current time when the method is called.

Parameters
offset The offset in seconds at which to begin the element.
Returns
  • true if the method call was successful and the element was begun. false if the method call failed. Possible reasons for failure include: The element doesn't support the beginElementAt method. (the begin attribute is not set to "indefinite" ) The element is already active and can't be restart when it is active. (the restart attribute is set to "whenNotActive" ) The element is active or has been active and can't be restart. (the restart attribute is set to "never" ).
Throws
DOMException SYNTAX_ERR: The element was not defined with the appropriate syntax to allow beginElementAt calls.

public abstract boolean endElement ()

Causes this element to end the local timeline (subject to sync constraints).

Returns
  • true if the method call was successful and the element was ended. false if method call failed. Possible reasons for failure include: The element doesn't support the endElement method. (the end attribute is not set to "indefinite" ) The element is not active.
Throws
DOMException SYNTAX_ERR: The element was not defined with the appropriate syntax to allow endElement calls.

public abstract boolean endElementAt (float offset)

Causes this element to end the local timeline (subject to sync constraints) at the specified offset from the current time when the method is called.

Parameters
offset The offset in seconds at which to end the element. Must be >= 0.
Returns
  • true if the method call was successful and the element was ended. false if method call failed. Possible reasons for failure include: The element doesn't support the endElementAt method. (the end attribute is not set to "indefinite" ) The element is not active.
Throws
DOMException SYNTAX_ERR: The element was not defined with the appropriate syntax to allow endElementAt calls.