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: /**
16: * The CustomEvent interface is the recommended interface for
17: * application-specific event types. Unlike the <code>Event</code>
18: * interface, it allows applications to provide contextual information about
19: * the event type. Application-specific event types should have an
20: * associated namespace to avoid clashes with future general-purpose event
21: * types.
22: * <p> To create an instance of the <code>CustomEvent</code> interface, use
23: * the <code>DocumentEvent.createEvent("CustomEvent")</code> method call.
24: * <p>See also the <a href='http://www.w3.org/TR/2006/WD-DOM-Level-3-Events-20060413'>
25: Document Object Model (DOM) Level 3 Events Specification
26: </a>.
27: * @since DOM Level 3
28: */
29: public interface CustomEvent extends Event {
30: /**
31: * Specifies some detail information about the <code>Event</code>.
32: */
33: public Object getDetail();
34:
35: /**
36: * The <code>initCustomEventNS</code> method is used to initialize the
37: * value of a <code>CustomEvent</code> object and has the same behavior
38: * as <code>Event.initEventNS()</code>.
39: * @param namespaceURI Refer to the <code>Event.initEventNS()</code>
40: * method for a description of this parameter.
41: * @param typeArg Refer to the <code>Event.initEventNS()</code> method
42: * for a description of this parameter.
43: * @param canBubbleArg Refer to the <code>Event.initEventNS()</code>
44: * method for a description of this parameter.
45: * @param cancelableArg Refer to the <code>Event.initEventNS()</code>
46: * method for a description of this parameter.
47: * @param detailArg Specifies <code>CustomEvent.detail</code>. This
48: * value may be <code>null</code>.
49: */
50: public void initCustomEventNS(String namespaceURI, String typeArg,
51: boolean canBubbleArg, boolean cancelableArg,
52: Object detailArg);
53:
54: }
|