01 /*
02 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
03 *
04 * This code is free software; you can redistribute it and/or modify it
05 * under the terms of the GNU General Public License version 2 only, as
06 * published by the Free Software Foundation. Sun designates this
07 * particular file as subject to the "Classpath" exception as provided
08 * by Sun in the LICENSE file that accompanied this code.
09 *
10 * This code is distributed in the hope that it will be useful, but WITHOUT
11 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
12 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
13 * version 2 for more details (a copy is included in the LICENSE file that
14 * accompanied this code).
15 *
16 * You should have received a copy of the GNU General Public License version
17 * 2 along with this work; if not, write to the Free Software Foundation,
18 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
19 *
20 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
21 * CA 95054 USA or visit www.sun.com if you need additional information or
22 * have any questions.
23 */
24
25 /*
26 * This file is available under and governed by the GNU General Public
27 * License version 2 only, as published by the Free Software Foundation.
28 * However, the following notice accompanied the original version of this
29 * file and, per its terms, should not be removed:
30 *
31 * Copyright (c) 2000 World Wide Web Consortium,
32 * (Massachusetts Institute of Technology, Institut National de
33 * Recherche en Informatique et en Automatique, Keio University). All
34 * Rights Reserved. This program is distributed under the W3C's Software
35 * Intellectual Property License. This program is distributed in the
36 * hope that it will be useful, but WITHOUT ANY WARRANTY; without even
37 * the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
38 * PURPOSE.
39 * See W3C License http://www.w3.org/Consortium/Legal/ for more details.
40 */
41
42 package org.w3c.dom.events;
43
44 import org.w3c.dom.views.AbstractView;
45
46 /**
47 * The <code>UIEvent</code> interface provides specific contextual information
48 * associated with User Interface events.
49 * <p>See also the <a href='http://www.w3.org/TR/2000/REC-DOM-Level-2-Events-20001113'>Document Object Model (DOM) Level 2 Events Specification</a>.
50 * @since DOM Level 2
51 */
52 public interface UIEvent extends Event {
53 /**
54 * The <code>view</code> attribute identifies the <code>AbstractView</code>
55 * from which the event was generated.
56 */
57 public AbstractView getView();
58
59 /**
60 * Specifies some detail information about the <code>Event</code>,
61 * depending on the type of event.
62 */
63 public int getDetail();
64
65 /**
66 * The <code>initUIEvent</code> method is used to initialize the value of
67 * a <code>UIEvent</code> created through the <code>DocumentEvent</code>
68 * interface. This method may only be called before the
69 * <code>UIEvent</code> has been dispatched via the
70 * <code>dispatchEvent</code> method, though it may be called multiple
71 * times during that phase if necessary. If called multiple times, the
72 * final invocation takes precedence.
73 * @param typeArg Specifies the event type.
74 * @param canBubbleArg Specifies whether or not the event can bubble.
75 * @param cancelableArg Specifies whether or not the event's default
76 * action can be prevented.
77 * @param viewArg Specifies the <code>Event</code>'s
78 * <code>AbstractView</code>.
79 * @param detailArg Specifies the <code>Event</code>'s detail.
80 */
81 public void initUIEvent(String typeArg, boolean canBubbleArg,
82 boolean cancelableArg, AbstractView viewArg, int detailArg);
83
84 }
|