org.w3c.dom.smil20
Interface Time

All Known Implementing Classes:

TimeImpl

public interface Time

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.

Field Summary

static short	SMIL_TIME_ACCESSKEY
static short	SMIL_TIME_EVENT_BASED
static short	SMIL_TIME_INDEFINITE
static short	SMIL_TIME_MEDIA_MARKER
static short	SMIL_TIME_OFFSET
static short	SMIL_TIME_REPEAT
static short	SMIL_TIME_SYNC_BASED
static short	SMIL_TIME_WALLCLOCK

Method Summary

boolean	getBaseBegin() If true , indicates that a sync-based time is relative to the begin of the baseElement.
org.w3c.dom.Element	getBaseElement() The base element for a sync-based or event-based time.
java.lang.String	getEvent() The name of the event for an event-based time.
java.lang.String	getMarker() The name of the marker from the media element, for media marker times.
MyFloat	getOffset() The clock value in seconds relative to the syncbase or eventbase.
boolean	getResolved() A boolean indicating whether the current Time has been fully resolved to the document schedule.
MyFloat	getResolvedOffset() The clock value in seconds relative to the parent time container begin.
java.lang.String	getString() For debugging purposes
short	getTimeType() A code representing the type of the underlying object, as defined above.
long	getTimeValue()
boolean	isEqualTo(Time time) Is time equal to this.
boolean	isGreaterThan(Time time) Is time greater that this.
boolean	isInBeginList()
boolean	isIndefinite()
boolean	isNegative() Checks if the time is negative.
void	setBaseBegin(boolean baseBegin)
void	setBaseElement(org.w3c.dom.Element baseElement)
void	setEvent(java.lang.String event)
void	setMarker(java.lang.String marker)
void	setOffset(MyFloat offset)
void	setTimeValue(Time t)

Field Detail

SMIL_TIME_INDEFINITE

public static final short SMIL_TIME_INDEFINITE

See Also:

Constant Field Values

SMIL_TIME_OFFSET

public static final short SMIL_TIME_OFFSET

See Also:

Constant Field Values

SMIL_TIME_SYNC_BASED

public static final short SMIL_TIME_SYNC_BASED

See Also:

Constant Field Values

SMIL_TIME_EVENT_BASED

public static final short SMIL_TIME_EVENT_BASED

See Also:

Constant Field Values

SMIL_TIME_WALLCLOCK

public static final short SMIL_TIME_WALLCLOCK

See Also:

Constant Field Values

SMIL_TIME_MEDIA_MARKER

public static final short SMIL_TIME_MEDIA_MARKER

See Also:

Constant Field Values

SMIL_TIME_REPEAT

public static final short SMIL_TIME_REPEAT

See Also:

Constant Field Values

SMIL_TIME_ACCESSKEY

public static final short SMIL_TIME_ACCESSKEY

See Also:

Constant Field Values

Method Detail

getResolved

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

getResolvedOffset

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

getTimeType

public short getTimeType()

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

getOffset

public MyFloat getOffset()

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

Throws:

org.w3c.dom.DOMException - NO_MODIFICATION_ALLOWED_ERR: Raised on attempts to modify this readonly attribute.

setOffset

public void setOffset(MyFloat offset)
               throws org.w3c.dom.DOMException

Throws:

org.w3c.dom.DOMException

getBaseElement

public org.w3c.dom.Element getBaseElement()

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

Throws:

org.w3c.dom.DOMException - NO_MODIFICATION_ALLOWED_ERR: Raised on attempts to modify this readonly attribute.

setBaseElement

public void setBaseElement(org.w3c.dom.Element baseElement)
                    throws org.w3c.dom.DOMException

Throws:

org.w3c.dom.DOMException

getBaseBegin

public 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:

org.w3c.dom.DOMException - NO_MODIFICATION_ALLOWED_ERR: Raised on attempts to modify this readonly attribute.

setBaseBegin

public void setBaseBegin(boolean baseBegin)
                  throws org.w3c.dom.DOMException

Throws:

org.w3c.dom.DOMException

getEvent

public java.lang.String getEvent()

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

Throws:

org.w3c.dom.DOMException - NO_MODIFICATION_ALLOWED_ERR: Raised on attempts to modify this readonly attribute.

setEvent

public void setEvent(java.lang.String event)
              throws org.w3c.dom.DOMException

Throws:

org.w3c.dom.DOMException

getMarker

public java.lang.String getMarker()

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

Throws:

org.w3c.dom.DOMException - NO_MODIFICATION_ALLOWED_ERR: Raised on attempts to modify this readonly attribute.

setMarker

public void setMarker(java.lang.String marker)
               throws org.w3c.dom.DOMException

Throws:

org.w3c.dom.DOMException

isGreaterThan

public boolean isGreaterThan(Time time)

Is time greater that this.

Parameters:

time - Time value

Returns:

true if this is greater than time.

isEqualTo

public boolean isEqualTo(Time time)

Is time equal to this.

Parameters:

time - Time value

Returns:

true if this is equal.

isIndefinite

public boolean isIndefinite()

Returns:

true if time is indefinite

isNegative

public boolean isNegative()

Checks if the time is negative.

Returns:

true if time is negative.

getString

public java.lang.String getString()

For debugging purposes

setTimeValue

public void setTimeValue(Time t)

getTimeValue

public long getTimeValue()

isInBeginList

public boolean isInBeginList()