public class

SmilDocumentImpl

extends DocumentImpl
implements DocumentEvent SMILDocument
java.lang.Object
   ↳ com.android.mms.dom.NodeImpl
     ↳ com.android.mms.dom.DocumentImpl
       ↳ com.android.mms.dom.smil.SmilDocumentImpl

Summary

Constants
String SMIL_DOCUMENT_END_EVENT
String SMIL_DOCUMENT_START_EVENT
[Expand]
Inherited Constants
From interface org.w3c.dom.Node
From interface org.w3c.dom.smil.ElementTime
Public Constructors
SmilDocumentImpl()
Public Methods
boolean beginElement()
Causes this element to begin the local timeline (subject to sync constraints).
Element createElement(String tagName)
Event createEvent(String eventType)
boolean endElement()
Causes this element to end the local timeline (subject to sync constraints).
NodeList getActiveChildrenAt(float instant)
Returns a list of child elements active at the specified invocation.
TimeList getBegin()
The desired value (as a list of times) of the begin instant of this node.
SMILElement getBody()
Returns the element that contains the par's of the document, i.e.
SMILElement getDocumentElement()
float getDur()
The desired simple duration value of this node in seconds.
TimeList getEnd()
The list of active ends for this node.
short getFill()
A code representing the value of the fill attribute, as defined above.
short getFillDefault()
SMILElement getHead()
Returns the element that contains the layout node of this document, i.e.
SMILLayoutElement getLayout()
Returns the element that contains the layout information of the presentation, i.e.
float getRepeatCount()
The repeatCount attribute causes the element to play repeatedly (loop) for the specified number of times.
float getRepeatDur()
The repeatDur causes the element to play repeatedly (loop) for the specified duration in milliseconds.
short getRestart()
A code representing the value of the restart attribute, as defined above.
NodeList getTimeChildren()
A NodeList that contains all timed childrens of this node.
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(float seekTo)
Seeks this element to the specified point on the local timeline (subject to sync constraints).
void setBegin(TimeList begin)
void setDur(float dur)
void setEnd(TimeList end)
void setFill(short fill)
void setFillDefault(short fillDefault)
void setRepeatCount(float repeatCount)
void setRepeatDur(float repeatDur)
void setRestart(short restart)
[Expand]
Inherited Methods
From class com.android.mms.dom.DocumentImpl
From class com.android.mms.dom.NodeImpl
From class java.lang.Object
From interface org.w3c.dom.Document
From interface org.w3c.dom.Node
From interface org.w3c.dom.events.DocumentEvent
From interface org.w3c.dom.events.EventTarget
From interface org.w3c.dom.smil.ElementTime
From interface org.w3c.dom.smil.ElementTimeContainer
From interface org.w3c.dom.smil.SMILDocument

Constants

public static final String SMIL_DOCUMENT_END_EVENT

Constant Value: "SimlDocumentEnd"

public static final String SMIL_DOCUMENT_START_EVENT

Constant Value: "SmilDocumentStart"

Public Constructors

public SmilDocumentImpl ()

Public Methods

public 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 Element createElement (String tagName)

Throws
DOMException

public Event createEvent (String eventType)

Throws
DOMException

public 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 NodeList getActiveChildrenAt (float instant)

Returns a list of child elements active at the specified invocation.

Parameters
instant The desired position on the local timeline in milliseconds.
Returns
  • List of timed child-elements active at instant.

public TimeList getBegin ()

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

public SMILElement getBody ()

Returns the element that contains the par's of the document, i.e. the BODY element.

public SMILElement getDocumentElement ()

public float getDur ()

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

public TimeList getEnd ()

The list of active ends for this node.

public short getFill ()

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

public short getFillDefault ()

public SMILElement getHead ()

Returns the element that contains the layout node of this document, i.e. the HEAD element.

public SMILLayoutElement getLayout ()

Returns the element that contains the layout information of the presentation, i.e. the LAYOUT element.

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

public float getRepeatDur ()

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

public short getRestart ()

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

public NodeList getTimeChildren ()

A NodeList that contains all timed childrens of this node. If there are no timed children, the Nodelist is empty. An iterator is more appropriate here than a node list but it requires Traversal module support.

public void pauseElement ()

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

public void resumeElement ()

Causes this element to resume a paused local timeline.

public 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 void setBegin (TimeList begin)

Throws
DOMException

public void setDur (float dur)

Throws
DOMException

public void setEnd (TimeList end)

Throws
DOMException

public void setFill (short fill)

Throws
DOMException

public void setFillDefault (short fillDefault)

Throws
DOMException

public void setRepeatCount (float repeatCount)

Throws
DOMException

public void setRepeatDur (float repeatDur)

Throws
DOMException

public void setRestart (short restart)

Throws
DOMException