+++ /dev/null
-/*\r
- * Copyright (c) 2000 World Wide Web Consortium,\r
- * (Massachusetts Institute of Technology, Institut National de\r
- * Recherche en Informatique et en Automatique, Keio University). All\r
- * Rights Reserved. This program is distributed under the W3C's Software\r
- * Intellectual Property License. This program is distributed in the\r
- * hope that it will be useful, but WITHOUT ANY WARRANTY; without even\r
- * the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR\r
- * PURPOSE.\r
- * See W3C License http://www.w3.org/Consortium/Legal/ for more details.\r
- */\r
-\r
-package org.w3c.dom;\r
-\r
-/**\r
- * The <code>CharacterData</code> interface extends Node with a set of \r
- * attributes and methods for accessing character data in the DOM. For \r
- * clarity this set is defined here rather than on each object that uses \r
- * these attributes and methods. No DOM objects correspond directly to \r
- * <code>CharacterData</code>, though <code>Text</code> and others do \r
- * inherit the interface from it. All <code>offsets</code> in this interface \r
- * start from <code>0</code>.\r
- * <p>As explained in the <code>DOMString</code> interface, text strings in \r
- * the DOM are represented in UTF-16, i.e. as a sequence of 16-bit units. In \r
- * the following, the term 16-bit units is used whenever necessary to \r
- * indicate that indexing on CharacterData is done in 16-bit units.\r
- * <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>.\r
- */\r
-public interface CharacterData extends Node {\r
- /**\r
- * The character data of the node that implements this interface. The DOM \r
- * implementation may not put arbitrary limits on the amount of data \r
- * that may be stored in a <code>CharacterData</code> node. However, \r
- * implementation limits may mean that the entirety of a node's data may \r
- * not fit into a single <code>DOMString</code>. In such cases, the user \r
- * may call <code>substringData</code> to retrieve the data in \r
- * appropriately sized pieces.\r
- * @exception DOMException\r
- * NO_MODIFICATION_ALLOWED_ERR: Raised when the node is readonly.\r
- * @exception DOMException\r
- * DOMSTRING_SIZE_ERR: Raised when it would return more characters than \r
- * fit in a <code>DOMString</code> variable on the implementation \r
- * platform.\r
- */\r
- public String getData()\r
- throws DOMException;\r
- public void setData(String data)\r
- throws DOMException;\r
-\r
- /**\r
- * The number of 16-bit units that are available through <code>data</code> \r
- * and the <code>substringData</code> method below. This may have the \r
- * value zero, i.e., <code>CharacterData</code> nodes may be empty.\r
- */\r
- public int getLength();\r
-\r
- /**\r
- * Extracts a range of data from the node.\r
- * @param offsetStart offset of substring to extract.\r
- * @param countThe number of 16-bit units to extract.\r
- * @return The specified substring. If the sum of <code>offset</code> and \r
- * <code>count</code> exceeds the <code>length</code>, then all 16-bit \r
- * units to the end of the data are returned.\r
- * @exception DOMException\r
- * INDEX_SIZE_ERR: Raised if the specified <code>offset</code> is \r
- * negative or greater than the number of 16-bit units in \r
- * <code>data</code>, or if the specified <code>count</code> is \r
- * negative.\r
- * <br>DOMSTRING_SIZE_ERR: Raised if the specified range of text does \r
- * not fit into a <code>DOMString</code>.\r
- */\r
- public String substringData(int offset, \r
- int count)\r
- throws DOMException;\r
-\r
- /**\r
- * Append the string to the end of the character data of the node. Upon \r
- * success, <code>data</code> provides access to the concatenation of \r
- * <code>data</code> and the <code>DOMString</code> specified.\r
- * @param argThe <code>DOMString</code> to append.\r
- * @exception DOMException\r
- * NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.\r
- */\r
- public void appendData(String arg)\r
- throws DOMException;\r
-\r
- /**\r
- * Insert a string at the specified 16-bit unit offset.\r
- * @param offsetThe character offset at which to insert.\r
- * @param argThe <code>DOMString</code> to insert.\r
- * @exception DOMException\r
- * INDEX_SIZE_ERR: Raised if the specified <code>offset</code> is \r
- * negative or greater than the number of 16-bit units in \r
- * <code>data</code>.\r
- * <br>NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.\r
- */\r
- public void insertData(int offset, \r
- String arg)\r
- throws DOMException;\r
-\r
- /**\r
- * Remove a range of 16-bit units from the node. Upon success, \r
- * <code>data</code> and <code>length</code> reflect the change.\r
- * @param offsetThe offset from which to start removing.\r
- * @param countThe number of 16-bit units to delete. If the sum of \r
- * <code>offset</code> and <code>count</code> exceeds \r
- * <code>length</code> then all 16-bit units from <code>offset</code> \r
- * to the end of the data are deleted.\r
- * @exception DOMException\r
- * INDEX_SIZE_ERR: Raised if the specified <code>offset</code> is \r
- * negative or greater than the number of 16-bit units in \r
- * <code>data</code>, or if the specified <code>count</code> is \r
- * negative.\r
- * <br>NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.\r
- */\r
- public void deleteData(int offset, \r
- int count)\r
- throws DOMException;\r
-\r
- /**\r
- * Replace the characters starting at the specified 16-bit unit offset \r
- * with the specified string.\r
- * @param offsetThe offset from which to start replacing.\r
- * @param countThe number of 16-bit units to replace. If the sum of \r
- * <code>offset</code> and <code>count</code> exceeds \r
- * <code>length</code>, then all 16-bit units to the end of the data \r
- * are replaced; (i.e., the effect is the same as a <code>remove</code>\r
- * method call with the same range, followed by an <code>append</code>\r
- * method invocation).\r
- * @param argThe <code>DOMString</code> with which the range must be \r
- * replaced.\r
- * @exception DOMException\r
- * INDEX_SIZE_ERR: Raised if the specified <code>offset</code> is \r
- * negative or greater than the number of 16-bit units in \r
- * <code>data</code>, or if the specified <code>count</code> is \r
- * negative.\r
- * <br>NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.\r
- */\r
- public void replaceData(int offset, \r
- int count, \r
- String arg)\r
- throws DOMException;\r
-\r
-}\r