<html> <head> <title>Interface XCharacterData</title> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> <link rel="stylesheet" type="text/css" href="../../../../../idl.css"> </head> <body> <div id="adc-idlref"> <a name="_top_"> </a><table class="navimain" border="0" cellpadding="3"> <tr> <td class="navimain"><a href="../../module-ix.html" class="navimain">Overview</a></td> <td class="navimain"><a href="module-ix.html" class="navimain">Module</a></td> <td class="navimain"><a href="XCharacterData-xref.html" class="navimain">Use</a></td> <td class="navimainnone">Devguide</td> <td class="navimain"><a href="../../../../../index-files/index-1.html" class="navimain">Index</a></td> </tr> </table> <table class="navisub" border="0" cellpadding="0"> <tr> <td class="navisub"><a href="#MethodsSummary" class="navisub">Methods' Summary</a></td> <td class="navisub"><a href="#MethodsDetails" class="navisub">Methods' Details</a></td> <td class="navisub">Attributes' Summary</td> <td class="navisub">Attributes' Details</td> </tr> </table> <hr> <table border="0" width="100%" cellpadding="5" cellspacing="3" class="title-table" style="margin-bottom:6pt;"> <tr> <td><p class="namechain"><a href="../../../../../module-ix.html" class="namechain">::</a> <a href="../../../../module-ix.html" class="namechain">com</a> :: <a href="../../../module-ix.html" class="namechain">sun</a> :: <a href="../../module-ix.html" class="namechain">star</a> :: <a href="../module-ix.html" class="namechain">xml</a> :: <a href="module-ix.html" class="namechain">dom</a> :: </p> </td> </tr> <tr> <td class="title">interface XCharacterData</td> </tr> <tr> <td><dl> <dt><b>Base Interfaces</b></dt> <dd><pre style="font-family:monospace;"><strong>XCharacterData</strong> ┗ <a href="XNode.html">XNode</a> </pre></dd> <dd><a name/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="crosstitle"> <tr> <td class="imsum_left"><a href="XNode.html">XNode</a></td> <td class="imsum_right"><dl> <dt>(referenced interface's summary:)</dt> <dd>The primary dom datatype </dd> </dl> </td> </tr> </table> </dd> </dl> </td> </tr> <tr> <td/></tr> </table> <hr> <a name="MethodsSummary"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle" colspan="2">Methods' Summary</td> </tr> <tr> <td class="imsum_left"><a href="#appendData">appendData</a></td> <td class="imsum_right">Append the string to the end of the character data of the node. Throws: DOMException - NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly. </td> </tr> <tr> <td class="imsum_left"><a href="#deleteData">deleteData</a></td> <td class="imsum_right">Remove a range of 16-bit units from the node. Throws: DOMException - INDEX_SIZE_ERR: Raised if the specified offset is negative or greater than the number of 16-bit units in data, or if the specified count is negative. NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly. </td> </tr> <tr> <td class="imsum_left"><a href="#getData">getData</a></td> <td class="imsum_right">Return the character data of the node that implements this interface. Throws: DOMException - NO_MODIFICATION_ALLOWED_ERR: Raised when the node is readonly. DOMException - DOMSTRING_SIZE_ERR: Raised when it would return more characters than fit in a DOMString variable on the implementation platform. </td> </tr> <tr> <td class="imsum_left"><a href="#getLength">getLength</a></td> <td class="imsum_right">The number of 16-bit units that are available through data and the substringData method below. </td> </tr> <tr> <td class="imsum_left"><a href="#insertData">insertData</a></td> <td class="imsum_right">Insert a string at the specified 16-bit unit offset. Throws: DOMException - INDEX_SIZE_ERR: Raised if the specified offset is negative or greater than the number of 16-bit units in data. NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly. </td> </tr> <tr> <td class="imsum_left"><a href="#replaceData">replaceData</a></td> <td class="imsum_right">Replace the characters starting at the specified 16-bit unit offset with the specified string. Throws; DOMException - INDEX_SIZE_ERR: Raised if the specified offset is negative or greater than the number of 16-bit units in data, or if the specified count is negative. NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly. </td> </tr> <tr> <td class="imsum_left"><a href="#setData">setData</a></td> <td class="imsum_right">Set the character data of the node that implements this interface. Throws: DOMException - NO_MODIFICATION_ALLOWED_ERR: Raised when the node is readonly. DOMException - DOMSTRING_SIZE_ERR: Raised when it would return more characters than fit in a DOMString variable on the implementation platform. </td> </tr> <tr> <td class="imsum_left"><a href="#subStringData">subStringData</a></td> <td class="imsum_right">Extracts a range of data from the node. Throws: DOMException - INDEX_SIZE_ERR: Raised if the specified offset is negative or greater than the number of 16-bit units in data, or if the specified count is negative. DOMSTRING_SIZE_ERR: Raised if the specified range of text does not fit into a DOMString. </td> </tr> </table> <a name="MethodsDetails"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle">Methods' Details</td> </tr> <tr> <td class="imdetail"><a name="appendData" class="membertitle">appendData</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">void</td> </tr> <tr> <td valign="top"><b>appendData</b>(</td> <td valign="top">[in] string</td> <td valign="bottom"> arg )</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2"><a href="DOMException.html">DOMException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>Append the string to the end of the character data of the node. Throws: DOMException - NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="deleteData" class="membertitle">deleteData</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">void</td> </tr> <tr> <td valign="top"><b>deleteData</b>(</td> <td valign="top">[in] long</td> <td valign="bottom"> offset,</td> </tr> <tr> <td/><td valign="top">[in] long</td> <td valign="bottom"> count )</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2"><a href="DOMException.html">DOMException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>Remove a range of 16-bit units from the node. Throws: DOMException - INDEX_SIZE_ERR: Raised if the specified offset is negative or greater than the number of 16-bit units in data, or if the specified count is negative. NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getData" class="membertitle">getData</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">string</td> </tr> <tr> <td valign="top"><b>getData</b>()</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2"><a href="DOMException.html">DOMException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>Return the character data of the node that implements this interface. Throws: DOMException - NO_MODIFICATION_ALLOWED_ERR: Raised when the node is readonly. DOMException - DOMSTRING_SIZE_ERR: Raised when it would return more characters than fit in a DOMString variable on the implementation platform. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getLength" class="membertitle">getLength</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">long</td> </tr> <tr> <td valign="top"><b>getLength</b>();</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>The number of 16-bit units that are available through data and the substringData method below. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="insertData" class="membertitle">insertData</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">void</td> </tr> <tr> <td valign="top"><b>insertData</b>(</td> <td valign="top">[in] long</td> <td valign="bottom"> offset,</td> </tr> <tr> <td/><td valign="top">[in] string</td> <td valign="bottom"> arg )</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2"><a href="DOMException.html">DOMException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>Insert a string at the specified 16-bit unit offset. Throws: DOMException - INDEX_SIZE_ERR: Raised if the specified offset is negative or greater than the number of 16-bit units in data. NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="replaceData" class="membertitle">replaceData</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">void</td> </tr> <tr> <td valign="top"><b>replaceData</b>(</td> <td valign="top">[in] long</td> <td valign="bottom"> offset,</td> </tr> <tr> <td/><td valign="top">[in] long</td> <td valign="bottom"> count,</td> </tr> <tr> <td/><td valign="top">[in] string</td> <td valign="bottom"> arg )</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2"><a href="DOMException.html">DOMException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>Replace the characters starting at the specified 16-bit unit offset with the specified string. Throws; DOMException - INDEX_SIZE_ERR: Raised if the specified offset is negative or greater than the number of 16-bit units in data, or if the specified count is negative. NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="setData" class="membertitle">setData</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">void</td> </tr> <tr> <td valign="top"><b>setData</b>(</td> <td valign="top">[in] string</td> <td valign="bottom"> data )</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2"><a href="DOMException.html">DOMException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>Set the character data of the node that implements this interface. Throws: DOMException - NO_MODIFICATION_ALLOWED_ERR: Raised when the node is readonly. DOMException - DOMSTRING_SIZE_ERR: Raised when it would return more characters than fit in a DOMString variable on the implementation platform. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="subStringData" class="membertitle">subStringData</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">string</td> </tr> <tr> <td valign="top"><b>subStringData</b>(</td> <td valign="top">[in] long</td> <td valign="bottom"> offset,</td> </tr> <tr> <td/><td valign="top">[in] long</td> <td valign="bottom"> count )</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2"><a href="DOMException.html">DOMException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>Extracts a range of data from the node. Throws: DOMException - INDEX_SIZE_ERR: Raised if the specified offset is negative or greater than the number of 16-bit units in data, or if the specified count is negative. DOMSTRING_SIZE_ERR: Raised if the specified range of text does not fit into a DOMString. </dd> </dl> </td> </tr> </table> </td> </tr> </table> <a href="#_top_">Top of Page</a><hr size="3"><p class="copyright" align="center">Copyright © 2008 Sun Microsystems, Inc.</p> </div> <!-- id="adc-idlref" --> </body> </html>