org.w3c.dom.smil.TimeEvent Maven / Gradle / Ivy
/*
* Copyright (c) 2001 World Wide Web Consortium,
* (Massachusetts Institute of Technology, Institut National de
* Recherche en Informatique et en Automatique, Keio University). All
* Rights Reserved. This program is distributed under the W3C's Software
* Intellectual Property License. This program is distributed in the
* hope that it will be useful, but WITHOUT ANY WARRANTY; without even
* the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
* PURPOSE.
* See W3C License http://www.w3.org/Consortium/Legal/ for more details.
*/
package org.w3c.dom.smil;
import org.w3c.dom.events.Event;
import org.w3c.dom.views.AbstractView;
/**
* The TimeEvent
interface provides specific contextual
* information associated with Time events.
*
* @see SMIL Animation.
*/
public interface TimeEvent extends Event {
/**
* The view
attribute identifies the AbstractView
* from which the event was generated.
*/
public AbstractView getView();
/**
* Specifies some detail information about the Event
,
* depending on the type of event.
*/
public int getDetail();
/**
* The initTimeEvent
method is used to initialize the value of
* a TimeEvent
created through the DocumentEvent
* interface. This method may only be called before the
* TimeEvent
has been dispatched via the
* dispatchEvent
method, though it may be called multiple
* times during that phase if necessary. If called multiple times, the
* final invocation takes precedence.
*
* The different types of events that can occur are:
*
*
* - begin
* - This event is raised when the element local timeline begins to play.
* It will be raised each time the element begins the active duration (i.e.
* when it restarts, but not when it repeats). It may be raised both in the
* course of normal (i.e. scheduled or interactive) timeline play, as well
* as in the case that the element was begun with the
* beginElement()
or beginElementAt()
methods. Note
* that if an element is restarted while it is currently playing, the
* element will raise an end event and another begin event, as the element
* restarts.
*
* - Bubbles: No
* - Cancelable: No
* - Context Info: None
*
*
* - end
* - This event is raised at the active end of the element. Note that
* this event is not raised at the simple end of each repeat. This event
* may be raised both in the course of normal (i.e. scheduled or
* interactive) timeline play, as well as in the case that the element was
* ended with the
endElement()
or
* endElementAt()
methods. Note that if an element is restarted
* while it is currently playing, the element will raise an end event and
* another begin event, as the element restarts.
*
* - Bubbles: No
* - Cancelable: No
* - Context Info: None
*
*
* - repeat
* - This event is raised when the element local timeline repeats. It
* will be raised each time the element repeats, after the first
* iteration.
The event provides a numerical indication of which repeat
* iteration is beginning. The value is a 0-based integer, but the repeat
* event is not raised for the first iteration and so the observed values
* of the detail attribute will be >= 1.
*
* - Bubbles: No
* - Cancelable: No
* - Context Info: detail (current iteration)
*
*
*
*
* @param typeArg Specifies the event type.
* @param viewArg Specifies the Event
's
* AbstractView
.
* @param detailArg Specifies the Event
's detail. */
public void initTimeEvent(String typeArg,
AbstractView viewArg,
int detailArg);
}