01: /*
02: * Copyright (c) 2000 World Wide Web Consortium,
03: * (Massachusetts Institute of Technology, Institut National de
04: * Recherche en Informatique et en Automatique, Keio University). All
05: * Rights Reserved. This program is distributed under the W3C's Software
06: * Intellectual Property License. This program is distributed in the
07: * hope that it will be useful, but WITHOUT ANY WARRANTY; without even
08: * the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
09: * PURPOSE.
10: * See W3C License http://www.w3.org/Consortium/Legal/ for more details.
11: */
12:
13: package org.w3c.dom;
14:
15: /**
16: * The <code>Text</code> interface inherits from <code>CharacterData</code>
17: * and represents the textual content (termed character data in XML) of an
18: * <code>Element</code> or <code>Attr</code>. If there is no markup inside
19: * an element's content, the text is contained in a single object
20: * implementing the <code>Text</code> interface that is the only child of
21: * the element. If there is markup, it is parsed into the information items
22: * (elements, comments, etc.) and <code>Text</code> nodes that form the list
23: * of children of the element.
24: * <p>When a document is first made available via the DOM, there is only one
25: * <code>Text</code> node for each block of text. Users may create adjacent
26: * <code>Text</code> nodes that represent the contents of a given element
27: * without any intervening markup, but should be aware that there is no way
28: * to represent the separations between these nodes in XML or HTML, so they
29: * will not (in general) persist between DOM editing sessions. The
30: * <code>normalize()</code> method on <code>Node</code> merges any such
31: * adjacent <code>Text</code> objects into a single node for each block of
32: * text.
33: * <p>See also the <a href='http://www.w3.org/TR/2000/REC-DOM-Level-2-Core-20001113'>Document Object Model (DOM) Level 2 Core Specification</a>.
34: */
35: public interface Text extends CharacterData {
36: /**
37: * Breaks this node into two nodes at the specified <code>offset</code>,
38: * keeping both in the tree as siblings. After being split, this node
39: * will contain all the content up to the <code>offset</code> point. A
40: * new node of the same type, which contains all the content at and
41: * after the <code>offset</code> point, is returned. If the original
42: * node had a parent node, the new node is inserted as the next sibling
43: * of the original node. When the <code>offset</code> is equal to the
44: * length of this node, the new node has no data.
45: * @param offset The 16-bit unit offset at which to split, starting from
46: * <code>0</code>.
47: * @return The new node, of the same type as this node.
48: * @exception DOMException
49: * INDEX_SIZE_ERR: Raised if the specified offset is negative or greater
50: * than the number of 16-bit units in <code>data</code>.
51: * <br>NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.
52: */
53: public Text splitText(int offset) throws DOMException;
54:
55: }
|