public interface

ElementTime

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

Class Overview

This interface defines the set of timing attributes that are common to all timed elements.

Summary

Constants
short FILL_AUTO
short FILL_FREEZE
short FILL_REMOVE
short RESTART_ALWAYS
short RESTART_NEVER
short RESTART_WHEN_NOT_ACTIVE
Public Methods
abstract boolean beginElement()
Causes this element to begin the local timeline (subject to sync constraints).
abstract boolean endElement()
Causes this element to end the local timeline (subject to sync constraints).
abstract TimeList getBegin()
The desired value (as a list of times) of the begin instant of this node.
abstract float getDur()
The desired simple duration value of this node in seconds.
abstract TimeList getEnd()
The list of active ends for this node.
abstract short getFill()
A code representing the value of the fill attribute, as defined above.
abstract short getFillDefault()
abstract float getRepeatCount()
The repeatCount attribute causes the element to play repeatedly (loop) for the specified number of times.
abstract float getRepeatDur()
The repeatDur causes the element to play repeatedly (loop) for the specified duration in milliseconds.
abstract short getRestart()
A code representing the value of the restart attribute, as defined above.
abstract void pauseElement()
Causes this element to pause the local timeline (subject to sync constraints).
abstract void resumeElement()
Causes this element to resume a paused local timeline.
abstract void seekElement(float seekTo)
Seeks this element to the specified point on the local timeline (subject to sync constraints).
abstract void setBegin(TimeList begin)
abstract void setDur(float dur)
abstract void setEnd(TimeList end)
abstract void setFill(short fill)
abstract void setFillDefault(short fillDefault)
abstract void setRepeatCount(float repeatCount)
abstract void setRepeatDur(float repeatDur)
abstract void setRestart(short restart)

Constants

public static final short FILL_AUTO

Constant Value: 2 (0x00000002)

public static final short FILL_FREEZE

Constant Value: 1 (0x00000001)

public static final short FILL_REMOVE

Constant Value: 0 (0x00000000)

public static final short RESTART_ALWAYS

Constant Value: 0 (0x00000000)

public static final short RESTART_NEVER

Constant Value: 1 (0x00000001)

public static final short RESTART_WHEN_NOT_ACTIVE

Constant Value: 2 (0x00000002)

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 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" ).

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 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.

public abstract TimeList getBegin ()

The desired value (as a list of times) of the begin instant of this node.

Throws
DOMException NO_MODIFICATION_ALLOWED_ERR: Raised if this attribute is readonly.

public abstract float getDur ()

The desired simple duration value of this node in seconds. Negative value means "indefinite".

Throws
DOMException NO_MODIFICATION_ALLOWED_ERR: Raised if this attribute is readonly.

public abstract TimeList getEnd ()

The list of active ends for this node.

Throws
DOMException NO_MODIFICATION_ALLOWED_ERR: Raised if this attribute is readonly.

public abstract short getFill ()

A code representing the value of the fill attribute, as defined above. Default value is FILL_REMOVE .

Throws
DOMException NO_MODIFICATION_ALLOWED_ERR: Raised if this attribute is readonly.

public abstract short getFillDefault ()

public abstract float getRepeatCount ()

The repeatCount attribute causes the element to play repeatedly (loop) for the specified number of times. A negative value repeat the element indefinitely. Default value is 0 (unspecified).

Throws
DOMException NO_MODIFICATION_ALLOWED_ERR: Raised if this attribute is readonly.

public abstract float getRepeatDur ()

The repeatDur causes the element to play repeatedly (loop) for the specified duration in milliseconds. Negative means "indefinite".

Throws
DOMException NO_MODIFICATION_ALLOWED_ERR: Raised if this attribute is readonly.

public abstract short getRestart ()

A code representing the value of the restart attribute, as defined above. Default value is RESTART_ALWAYS .

Throws
DOMException NO_MODIFICATION_ALLOWED_ERR: Raised if this attribute is readonly.

public abstract void pauseElement ()

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

public abstract void resumeElement ()

Causes this element to resume a paused local timeline.

public abstract void seekElement (float 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.

public abstract void setBegin (TimeList begin)

Throws
DOMException

public abstract void setDur (float dur)

Throws
DOMException

public abstract void setEnd (TimeList end)

Throws
DOMException

public abstract void setFill (short fill)

Throws
DOMException

public abstract void setFillDefault (short fillDefault)

Throws
DOMException

public abstract void setRepeatCount (float repeatCount)

Throws
DOMException

public abstract void setRepeatDur (float repeatDur)

Throws
DOMException

public abstract void setRestart (short restart)

Throws
DOMException