public interface

Time

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

Class Overview

The Time interface is a datatype that represents times within the timegraph. A Time has a type, key values to describe the time, and a boolean to indicate whether the values are currently unresolved. Still need to address the wallclock values.

Summary

Constants
short SMIL_TIME_EVENT_BASED
short SMIL_TIME_INDEFINITE
short SMIL_TIME_MEDIA_MARKER
short SMIL_TIME_OFFSET
short SMIL_TIME_SYNC_BASED
short SMIL_TIME_WALLCLOCK
Public Methods
abstract boolean getBaseBegin()
If true , indicates that a sync-based time is relative to the begin of the baseElement.
abstract Element getBaseElement()
The base element for a sync-based or event-based time.
abstract String getEvent()
The name of the event for an event-based time.
abstract String getMarker()
The name of the marker from the media element, for media marker times.
abstract double getOffset()
The clock value in seconds relative to the syncbase or eventbase.
abstract boolean getResolved()
A boolean indicating whether the current Time has been fully resolved to the document schedule.
abstract double getResolvedOffset()
The clock value in seconds relative to the parent time container begin.
abstract short getTimeType()
A code representing the type of the underlying object, as defined above.
abstract void setBaseBegin(boolean baseBegin)
abstract void setBaseElement(Element baseElement)
abstract void setEvent(String event)
abstract void setMarker(String marker)
abstract void setOffset(double offset)

Constants

public static final short SMIL_TIME_EVENT_BASED

Constant Value: 3 (0x00000003)

public static final short SMIL_TIME_INDEFINITE

Constant Value: 0 (0x00000000)

public static final short SMIL_TIME_MEDIA_MARKER

Constant Value: 5 (0x00000005)

public static final short SMIL_TIME_OFFSET

Constant Value: 1 (0x00000001)

public static final short SMIL_TIME_SYNC_BASED

Constant Value: 2 (0x00000002)

public static final short SMIL_TIME_WALLCLOCK

Constant Value: 4 (0x00000004)

Public Methods

public abstract boolean getBaseBegin ()

If true , indicates that a sync-based time is relative to the begin of the baseElement. If false , indicates that a sync-based time is relative to the active end of the baseElement.

Throws
DOMException NO_MODIFICATION_ALLOWED_ERR: Raised on attempts to modify this readonly attribute.

public abstract Element getBaseElement ()

The base element for a sync-based or event-based time.

Throws
DOMException NO_MODIFICATION_ALLOWED_ERR: Raised on attempts to modify this readonly attribute.

public abstract String getEvent ()

The name of the event for an event-based time. Default value is null .

Throws
DOMException NO_MODIFICATION_ALLOWED_ERR: Raised on attempts to modify this readonly attribute.

public abstract String getMarker ()

The name of the marker from the media element, for media marker times. Default value is null .

Throws
DOMException NO_MODIFICATION_ALLOWED_ERR: Raised on attempts to modify this readonly attribute.

public abstract double getOffset ()

The clock value in seconds relative to the syncbase or eventbase. Default value is 0 .

Throws
DOMException NO_MODIFICATION_ALLOWED_ERR: Raised on attempts to modify this readonly attribute.

public abstract boolean getResolved ()

A boolean indicating whether the current Time has been fully resolved to the document schedule. Note that for this to be true, the current Time must be defined (not indefinite), the syncbase and all Time 's that the syncbase depends on must be defined (not indefinite), and the begin Time of all ascendent time containers of this element and all Time elements that this depends upon must be defined (not indefinite).
If this Time is based upon an event, this Time will only be resolved once the specified event has happened, subject to the constraints of the time container.
Note that this may change from true to false when the parent time container ends its simple duration (including when it repeats or restarts).

public abstract double getResolvedOffset ()

The clock value in seconds relative to the parent time container begin. This indicates the resolved time relationship to the parent time container. This is only valid if resolved is true.

public abstract short getTimeType ()

A code representing the type of the underlying object, as defined above.

public abstract void setBaseBegin (boolean baseBegin)

Throws
DOMException

public abstract void setBaseElement (Element baseElement)

Throws
DOMException

public abstract void setEvent (String event)

Throws
DOMException

public abstract void setMarker (String marker)

Throws
DOMException

public abstract void setOffset (double offset)

Throws
DOMException