public class

TimeImpl

extends Object
implements Time
java.lang.Object
   ↳ com.android.mms.dom.smil.TimeImpl

Summary

[Expand]
Inherited Constants
From interface org.w3c.dom.smil.Time
Public Methods
boolean getBaseBegin()
If true , indicates that a sync-based time is relative to the begin of the baseElement.
Element getBaseElement()
The base element for a sync-based or event-based time.
String getEvent()
The name of the event for an event-based time.
String getMarker()
The name of the marker from the media element, for media marker times.
double 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.
double getResolvedOffset()
The clock value in seconds relative to the parent time container begin.
short getTimeType()
A code representing the type of the underlying object, as defined above.
static float parseClockValue(String clockValue)
Converts a String representation of a clock value into the float representation used in this API.
void setBaseBegin(boolean baseBegin)
void setBaseElement(Element baseElement)
void setEvent(String event)
void setMarker(String marker)
void setOffset(double offset)
[Expand]
Inherited Methods
From class java.lang.Object
From interface org.w3c.dom.smil.Time

Public Methods

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.

public Element getBaseElement ()

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

public String getEvent ()

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

public String getMarker ()

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

public double getOffset ()

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

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

public 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 short getTimeType ()

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

public static float parseClockValue (String clockValue)

Converts a String representation of a clock value into the float representation used in this API.

Clock values have the following syntax: 

 Clock-val         ::= ( Full-clock-val | Partial-clock-val | Timecount-val )
 Full-clock-val    ::= Hours ":" Minutes ":" Seconds ("." Fraction)?
 Partial-clock-val ::= Minutes ":" Seconds ("." Fraction)?
 Timecount-val     ::= Timecount ("." Fraction)? (Metric)?
 Metric            ::= "h" | "min" | "s" | "ms"
 Hours             ::= DIGIT+; any positive number
 Minutes           ::= 2DIGIT; range from 00 to 59
 Seconds           ::= 2DIGIT; range from 00 to 59
 Fraction          ::= DIGIT+
 Timecount         ::= DIGIT+
 2DIGIT            ::= DIGIT DIGIT
 DIGIT             ::= [0-9]

Parameters
clockValue A String in the representation specified above
Returns
  • A float value in milliseconds that matches the string representation given as the parameter
Throws
IllegalArgumentException if the clockValue input parameter does not comply with the defined syntax
NullPointerException if the clockValue string is null

public void setBaseBegin (boolean baseBegin)

Throws
DOMException

public void setBaseElement (Element baseElement)

Throws
DOMException

public void setEvent (String event)

Throws
DOMException

public void setMarker (String marker)

Throws
DOMException

public void setOffset (double offset)

Throws
DOMException