org.w3c.dom.smil20
Interface ElementTimeControl

All Known Subinterfaces:

ElementExclusiveTimeContainer, ElementParallelTimeContainer, ElementSequentialTimeContainer, ElementTime, ElementTimeContainer, SMILAnimateColorElement, SMILAnimateElement, SMILAnimateMotionElement, SMILAnimation, SMILMediaElement, SMILRefElement, SMILSetElement, XElementBasicTime, XSMILAElement, XSMILAreaElement, XSMILBodyElement, XSMILBrushElement, XSMILExclElement, XSMILForeignElement, XSMILParElement, XSMILPrefetchElement, XSMILSeqElement

All Known Implementing Classes:

ElementBasicTimeImpl, ElementExclusiveTimeContainerImpl, ElementParallelTimeContainerImpl, ElementSequentialTimeContainerImpl, ElementTimeContainerImpl, ElementTimeControlImpl, ElementTimeImpl, SMILAElementImpl, SMILAnimateColorElementImpl, SMILAnimateElementImpl, SMILAnimateMotionElementImpl, SMILAnimationImpl, SMILAreaElementImpl, SMILBodyElementImpl, SMILBrushElementImpl, SMILMediaElementImpl, SMILParElementImpl, SMILRefElementImpl, SMILSeqElementImpl, SMILSetElementImpl

public interface ElementTimeControl

Defines methods to begin, pause, resume or end timed elements.

Method Summary

boolean	beginElement() Causes this element to begin the local timeline (subject to sync constraints).
boolean	beginElementAt(int 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.
boolean	endElement() Causes this element to end the local timeline (subject to sync constraints).
boolean	endElementAt(int 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.
void	pauseElement() Causes this element to pause the local timeline (subject to sync constraints).
void	resumeElement() Causes this element to resume a paused local timeline.
void	seekElement(int seekTo) Seeks this element to the specified point on the local timeline (subject to sync constraints).

Method Detail

beginElement

public boolean beginElement()
                     throws org.w3c.dom.DOMException

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 beginEvent attribute is not set to "undefinite" ) 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:

org.w3c.dom.DOMException - SYNTAX_ERR: The element was not defined with the appropriate syntax to allow beginElement calls.

endElement

public boolean endElement()
                   throws org.w3c.dom.DOMException

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

Returns:

true if the method call was successful and the element was endeed. false if method call failed. Possible reasons for failure include: The element doesn't support the endElement method. (the endEvent attribute is not set to "undefinite" ) The element is not active.

Throws:

org.w3c.dom.DOMException - SYNTAX_ERR: The element was not defined with the appropriate syntax to allow endElement calls.

pauseElement

public void pauseElement()

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

resumeElement

public void resumeElement()

Causes this element to resume a paused local timeline.

seekElement

public void seekElement(int seekTo)

Seeks this element to the specified point on the local timeline (subject to sync constraints). If this is a timeline, this must seek the entire timeline (i.e. propagate to all timeChildren).

Parameters:

seekTo - The desired position on the local timeline in milliseconds.

beginElementAt

public boolean beginElementAt(int offset)
                       throws org.w3c.dom.DOMException

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:

org.w3c.dom.DOMException - SYNTAX_ERR: The element was not defined with the appropriate syntax to allow beginElementAt calls.

endElementAt

public boolean endElementAt(int offset)
                     throws org.w3c.dom.DOMException

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:

org.w3c.dom.DOMException - SYNTAX_ERR: The element was not defined with the appropriate syntax to allow endElementAt calls.