01: /*
02: * Copyright (c) 2006 World Wide Web Consortium,
03: *
04: * (Massachusetts Institute of Technology, European Research Consortium for
05: * Informatics and Mathematics, Keio University). All Rights Reserved. This
06: * work is distributed under the W3C(r) Software License [1] in the hope that
07: * it will be useful, but WITHOUT ANY WARRANTY; without even the implied
08: * warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
09: *
10: * [1] http://www.w3.org/Consortium/Legal/2002/copyright-software-20021231
11: */
12:
13: package org.w3c.dom.events;
14:
15: import org.w3c.dom.views.AbstractView;
16:
17: /**
18: * The <code>UIEvent</code> interface provides specific contextual
19: * information associated with User Interface events.
20: * <p> To create an instance of the <code>UIEvent</code> interface, use the
21: * <code>DocumentEvent.createEvent("UIEvent")</code> method call.
22: * <p>See also the <a href='http://www.w3.org/TR/2006/WD-DOM-Level-3-Events-20060413'>
23: Document Object Model (DOM) Level 3 Events Specification
24: </a>.
25: * @since DOM Level 2
26: */
27: public interface UIEvent extends Event {
28: /**
29: * The <code>view</code> attribute identifies the
30: * <code>AbstractView</code> from which the event was generated.
31: */
32: public AbstractView getView();
33:
34: /**
35: * Specifies some detail information about the <code>Event</code>,
36: * depending on the type of event.
37: */
38: public int getDetail();
39:
40: /**
41: * The <code>initUIEvent</code> method is used to initialize the value of
42: * a <code>UIEvent</code> object and has the same behavior as
43: * <code>Event.initEvent()</code>.
44: * @param typeArg Refer to the <code>Event.initEvent()</code> method for
45: * a description of this parameter.
46: * @param canBubbleArg Refer to the <code>Event.initEvent()</code>
47: * method for a description of this parameter.
48: * @param cancelableArg Refer to the <code>Event.initEvent()</code>
49: * method for a description of this parameter.
50: * @param viewArg Specifies <code>UIEvent.view</code>. This value may be
51: * <code>null</code>.
52: * @param detailArg Specifies <code>UIEvent.detail</code>.
53: */
54: public void initUIEvent(String typeArg, boolean canBubbleArg,
55: boolean cancelableArg, AbstractView viewArg, int detailArg);
56:
57: /**
58: * The <code>initUIEventNS</code> method is used to initialize the value
59: * of a <code>UIEvent</code> object and has the same behavior as
60: * <code>Event.initEventNS()</code>.
61: * @param namespaceURI Refer to the <code>Event.initEventNS()</code>
62: * method for a description of this parameter.
63: * @param typeArg Refer to the <code>Event.initEventNS()</code> method
64: * for a description of this parameter.
65: * @param canBubbleArg Refer to the <code>Event.initEventNS()</code>
66: * method for a description of this parameter.
67: * @param cancelableArg Refer to the <code>Event.initEventNS()</code>
68: * method for a description of this parameter.
69: * @param viewArg Refer to the <code>UIEvent.initUIEvent()</code> method
70: * for a description of this parameter.
71: * @param detailArg Refer to the <code>UIEvent.initUIEvent()</code>
72: * method for a description of this parameter.
73: * @since DOM Level 3
74: */
75: public void initUIEventNS(String namespaceURI, String typeArg,
76: boolean canBubbleArg, boolean cancelableArg,
77: AbstractView viewArg, int detailArg);
78:
79: }
|