org.w3c.dom.smil20
Interface XElementBasicTime

All Superinterfaces:

ElementTimeControl

All Known Subinterfaces:

ElementExclusiveTimeContainer, ElementParallelTimeContainer, ElementSequentialTimeContainer, ElementTime, ElementTimeContainer, SMILAnimateColorElement, SMILAnimateElement, SMILAnimateMotionElement, SMILAnimation, SMILMediaElement, SMILRefElement, SMILSetElement, XSMILAElement, XSMILAreaElement, XSMILBodyElement, XSMILBrushElement, XSMILExclElement, XSMILForeignElement, XSMILParElement, XSMILPrefetchElement, XSMILSeqElement

All Known Implementing Classes:

ElementBasicTimeImpl, ElementExclusiveTimeContainerImpl, ElementParallelTimeContainerImpl, ElementSequentialTimeContainerImpl, ElementTimeContainerImpl, ElementTimeImpl, SMILAElementImpl, SMILAnimateColorElementImpl, SMILAnimateElementImpl, SMILAnimateMotionElementImpl, SMILAnimationImpl, SMILAreaElementImpl, SMILBodyElementImpl, SMILBrushElementImpl, SMILMediaElementImpl, SMILParElementImpl, SMILRefElementImpl, SMILSeqElementImpl, SMILSetElementImpl

public interface XElementBasicTime

extends ElementTimeControl

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

Field Summary

static short	RESTART_ALWAYS
static short	RESTART_NEVER
static short	RESTART_WHEN_NOT_ACTIVE

Method Summary

void	activate() ACTIVE TIME - playing an interval.
void	closedown() This closes this element.
void	deactivate() END OF AN INTERVAL This is called to deactivate the element - after the end time has been reached.
void	destroy() This uninitializes the element.
void	freeze() This is called to freeze the element
java.lang.String	getBegin() The desired value (as a list of times) of the begin instant of this node.
Time	getCurrentIntervalBegin() Get the current interval begin time.
Time	getDur() The desired simple duration value of this node in seconds.
java.lang.String	getEnd() The list of active ends for this node.
Time	getMax() The minimum play time for this element in milliseconds.
Time	getMin() The minimum play time for this element in milliseconds.
MyFloat	getRepeat() The repeat causes the element to play repeatedly (loop) for the specified duration in milliseconds.
java.lang.String	getRepeatCount() The repeatCount attribute causes the element to play repeatedly (loop) for the specified number of times.
Time	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.
long	getTimeInBodyTime(long t) Returns time in body time space,
boolean	hasStarted()
boolean	isActive()
void	prefetch() PREFETCH - prefetching the media This prefetches the element for playing.
void	setBegin(TimeList begin)
void	setDur(java.lang.String dur)
void	setEnd(TimeList end)
void	setMax(Time max)
void	setMin(Time min)
void	setRepeat(MyFloat repeatDur)
void	setRepeatCount(java.lang.String repeatCount)
void	setRepeatDur(MyFloat repeatDur)
void	setRestart(short restart)
void	startup() STARTUP - getting the first interval This initializes the element for playing.

Methods inherited from interface org.w3c.dom.smil20.ElementTimeControl

beginElement, beginElementAt, endElement, endElementAt, pauseElement, resumeElement, seekElement

Field Detail

RESTART_ALWAYS

public static final short RESTART_ALWAYS

See Also:

Constant Field Values

RESTART_NEVER

public static final short RESTART_NEVER

See Also:

Constant Field Values

RESTART_WHEN_NOT_ACTIVE

public static final short RESTART_WHEN_NOT_ACTIVE

See Also:

Constant Field Values

Method Detail

getBegin

public java.lang.String getBegin()

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

Throws:

org.w3c.dom.DOMException - NO_MODIFICATION_ALLOWED_ERR: Raised if this attribute is readonly.

setBegin

public void setBegin(TimeList begin)
              throws org.w3c.dom.DOMException

Throws:

org.w3c.dom.DOMException

getEnd

public java.lang.String getEnd()

The list of active ends for this node.

Throws:

org.w3c.dom.DOMException - NO_MODIFICATION_ALLOWED_ERR: Raised if this attribute is readonly.

setEnd

public void setEnd(TimeList end)
            throws org.w3c.dom.DOMException

Throws:

org.w3c.dom.DOMException

getDur

public Time getDur()

The desired simple duration value of this node in seconds.

Returns:

String (eg. 2s, media or indefinite)

Throws:

org.w3c.dom.DOMException - NO_MODIFICATION_ALLOWED_ERR: Raised if this attribute is readonly.

setDur

public void setDur(java.lang.String dur)
            throws org.w3c.dom.DOMException

Throws:

org.w3c.dom.DOMException

getRestart

public short getRestart()

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

Throws:

org.w3c.dom.DOMException - NO_MODIFICATION_ALLOWED_ERR: Raised if this attribute is readonly.

setRestart

public void setRestart(short restart)
                throws org.w3c.dom.DOMException

Throws:

org.w3c.dom.DOMException

getRepeatCount

public java.lang.String 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:

org.w3c.dom.DOMException - NO_MODIFICATION_ALLOWED_ERR: Raised if this attribute is readonly.

setRepeatCount

public void setRepeatCount(java.lang.String repeatCount)
                    throws org.w3c.dom.DOMException

Throws:

org.w3c.dom.DOMException

getRepeatDur

public Time getRepeatDur()

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

Throws:

org.w3c.dom.DOMException - NO_MODIFICATION_ALLOWED_ERR: Raised if this attribute is readonly.

setRepeatDur

public void setRepeatDur(MyFloat repeatDur)
                  throws org.w3c.dom.DOMException

Throws:

org.w3c.dom.DOMException

getRepeat

public MyFloat getRepeat()

The repeat causes the element to play repeatedly (loop) for the specified duration in milliseconds.

Throws:

org.w3c.dom.DOMException - NO_MODIFICATION_ALLOWED_ERR: Raised if this attribute is readonly.

setRepeat

public void setRepeat(MyFloat repeatDur)
               throws org.w3c.dom.DOMException

Throws:

org.w3c.dom.DOMException

getMin

public Time getMin()

The minimum play time for this element in milliseconds. Negative means "indefinite".

Throws:

org.w3c.dom.DOMException - NO_MODIFICATION_ALLOWED_ERR: Raised if this attribute is readonly.

setMin

public void setMin(Time min)
            throws org.w3c.dom.DOMException

Throws:

org.w3c.dom.DOMException

getMax

public Time getMax()

The minimum play time for this element in milliseconds. Negative means "indefinite".

Throws:

org.w3c.dom.DOMException - NO_MODIFICATION_ALLOWED_ERR: Raised if this attribute is readonly.

setMax

public void setMax(Time max)
            throws org.w3c.dom.DOMException

Throws:

org.w3c.dom.DOMException

prefetch

public void prefetch()

PREFETCH - prefetching the media This prefetches the element for playing. It set's the element to 'prefetched' state.

startup

public void startup()

STARTUP - getting the first interval This initializes the element for playing. It set's the element to 'wait' state.

activate

public void activate()

ACTIVE TIME - playing an interval. This is called to activate the element - after begin time has been reached. This sets the element to 'play' state.

freeze

public void freeze()

This is called to freeze the element

deactivate

public void deactivate()

END OF AN INTERVAL This is called to deactivate the element - after the end time has been reached. This will search for the next interval and call activate, or set the element to 'fill' state.

closedown

public void closedown()

This closes this element. The element will not be active or show fill behaviour. It will be in 'idle' state.

destroy

public void destroy()

This uninitializes the element. All memory should be freed and the element cannot be used anymore after calling this method.

getCurrentIntervalBegin

public Time getCurrentIntervalBegin()

Get the current interval begin time. This is used to calculate the parent time.

getTimeInBodyTime

public long getTimeInBodyTime(long t)

Returns time in body time space,

Parameters:

t - Time to convert, in millisecs

Returns:

time in body time, in millisecs

isActive

public boolean isActive()

Returns:

true if this node is active.

hasStarted

public boolean hasStarted()

Returns:

true if this node has ever started.