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>TextEvent</code> interface provides specific contextual
19: * information associated with Text Events.
20: * <p> To create an instance of the <code>TextEvent</code> interface, use the
21: * <code>DocumentEvent.createEvent("TextEvent")</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 3
26: */
27: public interface TextEvent extends UIEvent {
28: /**
29: * <code>data</code> holds the value of the characters generated by the
30: * character device. This may be a single Unicode character or a
31: * non-empty sequence of Unicode characters [Unicode]. Characters should be normalized as defined by the Unicode
32: * normalization form NFC, defined in [<a href='http://www.unicode.org/reports/tr15/'>UAX #15</a>]. This attribute
33: * cannot be null or contain the empty string.
34: */
35: public String getData();
36:
37: /**
38: * The <code>initTextEvent</code> method is used to initialize the value
39: * of a <code>TextEvent</code> object and has the same behavior as
40: * <code>UIEvent.initUIEvent()</code>. The value of
41: * <code>UIEvent.detail</code> remains undefined.
42: * @param typeArg Refer to the <code>UIEvent.initUIEvent()</code> method
43: * for a description of this parameter.
44: * @param canBubbleArg Refer to the <code>UIEvent.initUIEvent()</code>
45: * method for a description of this parameter.
46: * @param cancelableArg Refer to the <code>UIEvent.initUIEvent()</code>
47: * method for a description of this parameter.
48: * @param viewArg Refer to the <code>UIEvent.initUIEvent()</code> method
49: * for a description of this parameter.
50: * @param dataArg Specifies <code>TextEvent.data</code>.
51: */
52: public void initTextEvent(String typeArg, boolean canBubbleArg,
53: boolean cancelableArg, AbstractView viewArg, String dataArg);
54:
55: /**
56: * The <code>initTextEventNS</code> method is used to initialize the
57: * value of a <code>TextEvent</code> object and has the same behavior as
58: * <code>UIEvent.initUIEventNS()</code>. The value of
59: * <code>UIEvent.detail</code> remains undefined.
60: * @param namespaceURI Refer to the <code>UIEvent.initUIEventNS()</code>
61: * method for a description of this parameter.
62: * @param type Refer to the <code>UIEvent.initUIEventNS()</code> method
63: * for a description of this parameter.
64: * @param canBubbleArg Refer to the <code>UIEvent.initUIEventNS()</code>
65: * method for a description of this parameter.
66: * @param cancelableArg Refer to the <code>UIEvent.initUIEventNS()</code>
67: * method for a description of this parameter.
68: * @param viewArg Refer to the <code>UIEvent.initUIEventNS()</code>
69: * method for a description of this parameter.
70: * @param dataArg Refer to the <code>TextEvent.initTextEvent()</code>
71: * method for a description of this parameter.
72: */
73: public void initTextEventNS(String namespaceURI, String type,
74: boolean canBubbleArg, boolean cancelableArg,
75: AbstractView viewArg, String dataArg);
76:
77: }
|