1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
|
<?xml version="1.0" encoding="UTF-8"?>
<!--[ Data interface description ]-->
<!-- $Date: 2001/11/26 22:34:22 $ $Revision: 1.1.1.1 $ -->
<interface name="CharacterData" inherits="Node" id="ID-FF21A306">
<descr><p>The <code>CharacterData</code> interface extends Node with a set of
attributes and methods for accessing character data in the DOM. For
clarity this set is defined here rather than on each object that uses
these attributes and methods. No DOM objects correspond directly to
<code>CharacterData</code>, though <code>Text</code> and others do
inherit the interface from it. All <code>offsets</code> in this
interface start from <code>0</code>.</p>
<p>As explained in the <code>DOMString</code> interface, text strings
in the DOM are represented in UTF-16, i.e. as a sequence of 16-bit
units. In the following, the term <termref
def='dt-16-bit-unit'>16-bit units</termref> is used whenever
necessary to indicate that indexing on CharacterData is done in
16-bit units.</p>
</descr>
<attribute type="DOMString" name="data" id="ID-72AB8359">
<descr><p>The character data of the node
that implements this interface. The DOM implementation may not
put arbitrary limits on the amount of data that may be stored in a
<code>CharacterData</code> node. However, implementation limits may
mean that the entirety of a node's data may not fit into a single
<code>DOMString</code>. In such cases, the user may call
<code>substringData</code> to retrieve the data in appropriately sized
pieces.</p>
</descr>
<setraises>
<exception name="DOMException">
<descr><p>NO_MODIFICATION_ALLOWED_ERR: Raised when the node is
readonly.</p></descr>
</exception>
</setraises>
<getraises>
<exception name="DOMException">
<descr><p>DOMSTRING_SIZE_ERR: Raised when it would return more
characters than fit in a <code>DOMString</code> variable on the
implementation platform.</p></descr>
</exception>
</getraises>
</attribute>
<attribute type="unsigned long" name="length" readonly="yes" id="ID-7D61178C">
<descr><p>The number of <termref def='dt-16-bit-unit'>16-bit
units</termref> that are available through <code>data</code> and the
<code>substringData</code> method below. This may have the value zero,
i.e., <code>CharacterData</code> nodes may be empty.</p>
</descr>
</attribute>
<method name="substringData" id="ID-6531BCCF">
<descr><p>Extracts a range of data from the node.</p></descr>
<parameters>
<param name="offset" type="unsigned long" attr="in">
<descr><p>Start offset of substring to extract.</p></descr>
</param>
<param name="count" type="unsigned long" attr="in">
<descr><p>The number of 16-bit units to extract.</p></descr>
</param>
</parameters>
<returns type="DOMString">
<descr><p>The specified substring. If the sum of <code>offset</code> and
<code>count</code> exceeds the <code>length</code>, then all 16-bit
units to the end of the data are returned.</p></descr>
</returns>
<raises>
<exception name="DOMException">
<descr><p>INDEX_SIZE_ERR: Raised if the specified <code>offset</code>
is negative or greater than the number of 16-bit units in
<code>data</code>, or if the specified <code>count</code> is
negative.</p>
<p>DOMSTRING_SIZE_ERR: Raised if the specified range of text does
not fit into a <code>DOMString</code>.</p>
</descr>
</exception>
</raises>
</method>
<method name="appendData" id="ID-32791A2F">
<descr>
<p>Append the string to the end of the character data of the node.
Upon success, <code>data</code> provides access to the concatenation of
<code>data</code> and the <code>DOMString</code> specified.</p>
</descr>
<parameters>
<param name="arg" type="DOMString" attr="in">
<descr><p>The <code>DOMString</code> to append.</p></descr>
</param>
</parameters>
<returns type="void">
<descr><p></p></descr>
</returns>
<raises>
<exception name="DOMException">
<descr><p>NO_MODIFICATION_ALLOWED_ERR: Raised if this node is
readonly.</p></descr>
</exception>
</raises>
</method>
<!-- NOTE -->
<method name="insertData" id="ID-3EDB695F">
<descr>
<p>Insert a string at the specified <termref def='dt-16-bit-unit'>16-bit
unit</termref> offset.</p>
</descr>
<parameters>
<param name="offset" type="unsigned long" attr="in">
<descr><p>The character offset at which to insert.</p></descr>
</param>
<param name="arg" type="DOMString" attr="in">
<descr><p>The <code>DOMString</code> to insert.</p></descr>
</param>
</parameters>
<returns type="void">
<descr><p></p></descr>
</returns>
<raises>
<exception name="DOMException">
<descr><p>INDEX_SIZE_ERR: Raised if the specified <code>offset</code>
is negative or greater than the number of 16-bit units in
<code>data</code>.</p>
<p>NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.</p>
</descr>
</exception>
</raises>
</method>
<method name="deleteData" id="ID-7C603781">
<descr>
<p>Remove a range of <termref def='dt-16-bit-unit'>16-bit units</termref>
from the node. Upon success, <code>data</code> and <code>length</code>
reflect the change.</p>
</descr>
<parameters>
<param name="offset" type="unsigned long" attr="in">
<descr><p>The offset from which to start removing.</p>
</descr>
</param>
<param name="count" type="unsigned long" attr="in">
<descr><p>The number of 16-bit units to delete. If the sum of
<code>offset</code> and <code>count</code> exceeds
<code>length</code> then all 16-bit units from <code>offset</code>
to the end of the data are deleted.</p></descr>
</param>
</parameters>
<returns type="void">
<descr><p></p></descr>
</returns>
<raises>
<exception name="DOMException">
<descr><p>INDEX_SIZE_ERR: Raised if the specified <code>offset</code>
is negative or greater than the number of 16-bit units in
<code>data</code>, or if the specified <code>count</code> is
negative.</p>
<p>NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.</p>
</descr>
</exception>
</raises>
</method>
<method name="replaceData" id="ID-E5CBA7FB">
<descr>
<p>Replace the characters starting at the specified <termref
def='dt-16-bit-unit'>16-bit unit</termref> offset with the specified
string.</p>
</descr>
<parameters>
<param name="offset" type="unsigned long" attr="in">
<descr><p>The offset from which to start replacing.</p></descr>
</param>
<param name="count" type="unsigned long" attr="in">
<descr><p>The number of 16-bit units to replace. If the sum of
<code>offset</code> and <code>count</code> exceeds
<code>length</code>, then all 16-bit units to the end of the data
are replaced; (i.e., the effect is the same as a
<code>remove</code> method call with the same range, followed
by an <code>append</code> method invocation).</p></descr>
</param>
<param name="arg" type="DOMString" attr="in">
<descr><p>The <code>DOMString</code> with which the range must
be replaced.</p></descr>
</param>
</parameters>
<returns type="void">
<descr><p></p></descr>
</returns>
<raises>
<exception name="DOMException">
<descr><p>INDEX_SIZE_ERR: Raised if the specified <code>offset</code>
is negative or greater than the number of 16-bit units in
<code>data</code>, or if the specified <code>count</code> is
negative.</p>
<p>NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.</p>
</descr>
</exception>
</raises>
</method>
</interface>
|
