org.apache.batik.anim.timing

Class TimedDocumentRoot

public abstract class TimedDocumentRoot extends TimeContainer

An abstract base class for the root time container element for a document.

Field Summary
protected Calendar	documentBeginTime The wallclock time that the document began.
protected boolean	isHyperlinking Whether the document is currently being sampled for a hyperlink.
protected boolean	isSampling Whether the document is currently being sampled.
protected LinkedList	listeners List of {link TimegraphListener}s to be notified of changes to the timed elements in this document.
protected DoublyIndexedSet	propagationFlags A set to determine when propagation of new Instance times should be stopped.
protected boolean	useSVG11AccessKeys Allows the use of accessKey() timing specifiers with a single character, as specified in SVG 1.1.
protected boolean	useSVG12AccessKeys Allows the use of accessKey() timing specifiers with a DOM 3 key name, as specified in SVG 1.2.

Constructor Summary
	TimedDocumentRoot(boolean useSVG11AccessKeys, boolean useSVG12AccessKeys) Creates a new TimedDocumentRoot.

Method Summary
void	addTimegraphListener(TimegraphListener l) Adds a TimegraphListener to the document.
float	convertEpochTime(long t) Converts an epoch time to document time.
float	convertWallclockTime(Calendar time) Converts a wallclock time to document time.
protected void	currentIntervalWillUpdate() Invoked by timed elements in this document to indicate that the current interval will be re-evaluated at the next sample.
float	getCurrentTime() Returns the last sampled document time.
float	getDefaultBegin(TimedElement child) Returns the default begin time for the given child timed element.
Calendar	getDocumentBeginTime() Returns the wallclock time that the document began.
protected abstract String	getEventNamespaceURI(String eventName) Returns the namespace URI of the event that corresponds to the given animation event name.
protected abstract String	getEventType(String eventName) Returns the type of the event that corresponds to the given animation event name.
protected float	getImplicitDur() Returns the implicit duration of the element.
protected abstract String	getRepeatEventName() Returns the name of the repeat event.
boolean	isHyperlinking() Returns whether the document is currently being sampled for a hyperlink.
boolean	isSampling() Returns whether the document is currently being sampled.
void	removeTimegraphListener(TimegraphListener l) Removes a TimegraphListener from the document.
void	resetDocument(Calendar documentBeginTime) Resets the entire timegraph.
float	seekTo(float time, boolean hyperlinking) Samples the entire timegraph at the given time.

Field Detail

documentBeginTime

protected Calendar documentBeginTime

The wallclock time that the document began.

isHyperlinking

protected boolean isHyperlinking

Whether the document is currently being sampled for a hyperlink.

isSampling

protected boolean isSampling

Whether the document is currently being sampled.

listeners

protected LinkedList listeners

List of {link TimegraphListener}s to be notified of changes to the timed elements in this document.

propagationFlags

protected DoublyIndexedSet propagationFlags

A set to determine when propagation of new Instance times should be stopped.

useSVG11AccessKeys

protected boolean useSVG11AccessKeys

Allows the use of accessKey() timing specifiers with a single character, as specified in SVG 1.1.

useSVG12AccessKeys

protected boolean useSVG12AccessKeys

Allows the use of accessKey() timing specifiers with a DOM 3 key name, as specified in SVG 1.2.

Constructor Detail

TimedDocumentRoot

public TimedDocumentRoot(boolean useSVG11AccessKeys, boolean useSVG12AccessKeys)

Creates a new TimedDocumentRoot.

Parameters: useSVG11AccessKeys allows the use of accessKey() timing specifiers with a single character useSVG12AccessKeys allows the use of accessKey() with a DOM 3 key name

Method Detail

addTimegraphListener

public void addTimegraphListener(TimegraphListener l)

Adds a TimegraphListener to the document.

convertEpochTime

public float convertEpochTime(long t)

Converts an epoch time to document time.

convertWallclockTime

public float convertWallclockTime(Calendar time)

Converts a wallclock time to document time.

currentIntervalWillUpdate

protected void currentIntervalWillUpdate()

Invoked by timed elements in this document to indicate that the current interval will be re-evaluated at the next sample. This should be overridden in a concrete class so that ticks can be scheduled immediately if they are currently paused due to no animations being active.

getCurrentTime

public float getCurrentTime()

Returns the last sampled document time.

getDefaultBegin

public float getDefaultBegin(TimedElement child)

Returns the default begin time for the given child timed element. In SVG, this is always 0, since the only time container is the root SVG element, which acts like a 'par'.

getDocumentBeginTime

public Calendar getDocumentBeginTime()

Returns the wallclock time that the document began.

getEventNamespaceURI

protected abstract String getEventNamespaceURI(String eventName)

Returns the namespace URI of the event that corresponds to the given animation event name.

getEventType

protected abstract String getEventType(String eventName)

Returns the type of the event that corresponds to the given animation event name.

getImplicitDur

protected float getImplicitDur()

Returns the implicit duration of the element. The document root has an TimedDocumentRoot implicit duration.

getRepeatEventName

protected abstract String getRepeatEventName()

Returns the name of the repeat event.

Returns: either "repeat" or "repeatEvent"