1/*
2 * Copyright (c) 2000 World Wide Web Consortium,
3 * (Massachusetts Institute of Technology, Institut National de
4 * Recherche en Informatique et en Automatique, Keio University). All
5 * Rights Reserved. This program is distributed under the W3C's Software
6 * Intellectual Property License. This program is distributed in the
7 * hope that it will be useful, but WITHOUT ANY WARRANTY; without even
8 * the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
9 * PURPOSE. See W3C License http://www.w3.org/Consortium/Legal/ for more
10 * details.
11 */
12
13package org.w3c.dom.smil;
14
15import org.w3c.dom.events.Event;
16import org.w3c.dom.views.AbstractView;
17
18/**
19 *  The <code>TimeEvent</code> interface provides specific contextual
20 * information associated with Time events.
21 */
22public interface TimeEvent extends Event {
23    /**
24     *  The <code>view</code> attribute identifies the
25     * <code>AbstractView</code> from which the event was generated.
26     */
27    public AbstractView getView();
28
29    /**
30     *  Specifies some detail information about the <code>Event</code> ,
31     * depending on the type of event.
32     */
33    public int getDetail();
34
35    /**
36     *  The <code>initTimeEvent</code> method is used to initialize the value
37     * of a <code>TimeEvent</code> created through the
38     * <code>DocumentEvent</code> interface.  This method may only be called
39     * before the <code>TimeEvent</code> has been dispatched via the
40     * <code>dispatchEvent</code> method, though it may be called multiple
41     * times during that phase if necessary.  If called multiple times, the
42     * final invocation takes precedence.
43     * @param typeArg  Specifies the event type.
44     * @param viewArg  Specifies the <code>Event</code> 's
45     *   <code>AbstractView</code> .
46     * @param detailArg  Specifies the <code>Event</code> 's detail.
47     */
48    public void initTimeEvent(String typeArg,
49                              AbstractView viewArg,
50                              int detailArg);
51
52}
53
54