source: NonGTP/Xerces/xerces/doc/html/apiDocs/classDOMText.html @ 358

Revision 358, 27.8 KB checked in by bittner, 19 years ago (diff)

xerces added
Line 
1<HTML><HEAD><SCRIPT language="JavaScript" src="../resources/script.js" type="text/javascript"></SCRIPT><TITLE>DOMText class Reference</TITLE><link href="XercesApi.css" rel="stylesheet" type="text/css"></HEAD><BODY alink="#ff0000" bgcolor="#ffffff" leftmargin="4" link="#0000ff" marginheight="4" marginwidth="4" text="#000000" topmargin="4" vlink="#0000aa"><TABLE border="0" cellpadding="0" cellspacing="0" width="620"><TR><TD align="left" height="60" rowspan="3" valign="top" width="135"><IMG border="0" height="60" hspace="0" src="../resources/logo.gif" vspace="0" width="135"></TD><TD align="left" colspan="4" height="5" valign="top" width="456"><IMG border="0" height="5" hspace="0" src="../resources/line.gif" vspace="0" width="456"></TD><TD align="left" height="60" rowspan="3" valign="top" width="29"><IMG border="0" height="60" hspace="0" src="../resources/right.gif" vspace="0" width="29"></TD></TR><TR><TD align="left" bgcolor="#0086b2" colspan="4" height="35" valign="top" width="456"><IMG alt="" border="0" height="35" hspace="0" src="../graphics/api-header.jpg" vspace="0" width="456"></TD></TR><TR><TD align="left" height="20" valign="top" width="168"><IMG border="0" height="20" hspace="0" src="../resources/bottom.gif" vspace="0" width="168"></TD><TD align="left" height="20" valign="top" width="96"><A href="http://xml.apache.org/" onMouseOut="rolloverOff('xml');" onMouseOver="rolloverOn('xml');" target="new"><IMG alt="http://xml.apache.org/" border="0" height="20" hspace="0" name="xml" onLoad="rolloverLoad('xml','../resources/button-xml-hi.gif','../resources/button-xml-lo.gif');" src="../resources/button-xml-lo.gif" vspace="0" width="96"></A></TD><TD align="left" height="20" valign="top" width="96"><A href="http://www.apache.org/" onMouseOut="rolloverOff('asf');" onMouseOver="rolloverOn('asf');" target="new"><IMG alt="http://www.apache.org/" border="0" height="20" hspace="0" name="asf" onLoad="rolloverLoad('asf','../resources/button-asf-hi.gif','../resources/button-asf-lo.gif');" src="../resources/button-asf-lo.gif" vspace="0" width="96"></A></TD><TD align="left" height="20" valign="top" width="96"><A href="http://www.w3.org/" onMouseOut="rolloverOff('w3c');" onMouseOver="rolloverOn('w3c');" target="new"><IMG alt="http://www.w3.org/" border="0" height="20" hspace="0" name="w3c" onLoad="rolloverLoad('w3c','../resources/button-w3c-hi.gif','../resources/button-w3c-lo.gif');" src="../resources/button-w3c-lo.gif" vspace="0" width="96"></A></TD></TR></TABLE><TABLE border="0" cellpadding="0" cellspacing="0" width="620"><TR><TD align="left" valign="top" width="120"><IMG border="0" height="14" hspace="0" src="../resources/join.gif" vspace="0" width="120"><BR>
2  <A href="../../index.html" onMouseOut="rolloverOff('side-ext-2');" onMouseOver="rolloverOn('side-ext-2');"><IMG alt="Home" border="0" height="12" hspace="0" name="side-ext-2" onLoad="rolloverLoad('side-ext-2','../graphics/ext-2-label-2.jpg','../graphics/ext-2-label-3.jpg');" src="../graphics/ext-2-label-3.jpg" vspace="0" width="120"></A><BR>
3
4  <IMG border="0" height="6" hspace="0" src="../resources/separator.gif" vspace="0" width="120"><BR>
5
6  <A href="../index.html" onMouseOut="rolloverOff('side-index');" onMouseOver="rolloverOn('side-index');"><IMG alt="Readme" border="0" height="12" hspace="0" name="side-index" onLoad="rolloverLoad('side-index','../graphics/index-label-2.jpg','../graphics/index-label-3.jpg');" src="../graphics/index-label-3.jpg" vspace="0" width="120"></A><BR>
7  <A href="../releases.html" onMouseOut="rolloverOff('side-releases');" onMouseOver="rolloverOn('side-releases');"><IMG alt="Release Info" border="0" height="12" hspace="0" name="side-releases" onLoad="rolloverLoad('side-releases','../graphics/releases-label-2.jpg','../graphics/releases-label-3.jpg');" src="../graphics/releases-label-3.jpg" vspace="0" width="120"></A><BR>
8  <IMG border="0" height="6" hspace="0" src="../resources/separator.gif" vspace="0" width="120"><BR>
9  <A href="../install.html" onMouseOut="rolloverOff('side-install');" onMouseOver="rolloverOn('side-install');"><IMG alt="Installation" border="0" height="12" hspace="0" name="side-install" onLoad="rolloverLoad('side-install','../graphics/install-label-2.jpg','../graphics/install-label-3.jpg');" src="../graphics/install-label-3.jpg" vspace="0" width="120"></A><BR>
10  <A href="http://xml.apache.org/dist/xerces-c/" onMouseOut="rolloverOff('side-ext-18');" onMouseOver="rolloverOn('side-ext-18');"><IMG alt="Download" border="0" height="12" hspace="0" name="side-ext-18" onLoad="rolloverLoad('side-ext-18','../graphics/ext-18-label-2.jpg','../graphics/ext-18-label-3.jpg');" src="../graphics/ext-18-label-3.jpg" vspace="0" width="120"></A><BR>
11  <A href="../build.html" onMouseOut="rolloverOff('side-build');" onMouseOver="rolloverOn('side-build');"><IMG alt="Build" border="0" height="12" hspace="0" name="side-build" onLoad="rolloverLoad('side-build','../graphics/build-label-2.jpg','../graphics/build-label-3.jpg');" src="../graphics/build-label-3.jpg" vspace="0" width="120"></A><BR>
12
13  <IMG border="0" height="6" hspace="0" src="../resources/separator.gif" vspace="0" width="120"><BR>
14  <A href="../faqs.html" onMouseOut="rolloverOff('side-faqs');" onMouseOver="rolloverOn('side-faqs');"><IMG alt="FAQs" border="0" height="12" hspace="0" name="side-faqs" onLoad="rolloverLoad('side-faqs','../graphics/faqs-label-2.jpg','../graphics/faqs-label-3.jpg');" src="../graphics/faqs-label-3.jpg" vspace="0" width="120"></A><BR> 
15  <A href="../samples.html" onMouseOut="rolloverOff('side-samples');" onMouseOver="rolloverOn('side-samples');"><IMG alt="Samples" border="0" height="12" hspace="0" name="side-samples" onLoad="rolloverLoad('side-samples','../graphics/samples-label-2.jpg','../graphics/samples-label-3.jpg');" src="../graphics/samples-label-3.jpg" vspace="0" width="120"></A><BR>
16  <A href="../api.html" onMouseOut="rolloverOff('side-api');" onMouseOver="rolloverOn('side-api');"><IMG alt="API Docs" border="0" height="12" hspace="0" name="side-api" onLoad="rolloverLoad('side-api','../graphics/api-label-2.jpg','../graphics/api-label-3.jpg');" src="../graphics/api-label-3.jpg" vspace="0" width="120"></A><BR> 
17
18  <IMG border="0" height="6" hspace="0" src="../resources/separator.gif" vspace="0" width="120"><BR> 
19  <A href="../ApacheDOMC++Binding.html" onMouseOut="rolloverOff('side-ext-68');" onMouseOver="rolloverOn('side-ext-68');"><IMG alt="DOM C++ Binding" border="0" height="12" hspace="0" name="side-ext-68" onLoad="rolloverLoad('side-ext-68','../graphics/ext-68-label-2.jpg','../graphics/ext-68-label-3.jpg');" src="../graphics/ext-68-label-3.jpg" vspace="0" width="120"></A><BR>
20
21  <A href="../program.html" onMouseOut="rolloverOff('side-program');" onMouseOver="rolloverOn('side-program');"><IMG alt="Programming" border="0" height="12" hspace="0" name="side-program" onLoad="rolloverLoad('side-program','../graphics/program-label-2.jpg','../graphics/program-label-3.jpg');" src="../graphics/program-label-3.jpg" vspace="0" width="120"></A><BR>
22  <A href="../migrate.html" onMouseOut="rolloverOff('side-migrate');" onMouseOver="rolloverOn('side-migrate');"><IMG alt="Migration Guide" border="0" height="12" hspace="0" name="side-migrate" onLoad="rolloverLoad('side-migrate','../graphics/migrate-label-2.jpg','../graphics/migrate-label-3.jpg');" src="../graphics/migrate-label-3.jpg" vspace="0" width="120"></A><BR>
23
24  <IMG border="0" height="6" hspace="0" src="../resources/separator.gif" vspace="0" width="120"><BR>
25
26  <A href="../feedback.html" onMouseOut="rolloverOff('side-feedback');" onMouseOver="rolloverOn('side-feedback');"><IMG alt="Feedback" border="0" height="12" hspace="0" name="side-feedback" onLoad="rolloverLoad('side-feedback','../graphics/feedback-label-2.jpg','../graphics/feedback-label-3.jpg');" src="../graphics/feedback-label-3.jpg" vspace="0" width="120"></A><BR>
27  <A href="../bug-report.html" onMouseOut="rolloverOff('side-bug-report');" onMouseOver="rolloverOn('side-bug-report');"><IMG alt="Bug-Reporting" border="0" height="12" hspace="0" name="side-bug-report" onLoad="rolloverLoad('side-bug-report','../graphics/bug-report-label-2.jpg','../graphics/bug-report-label-3.jpg');" src="../graphics/bug-report-label-3.jpg" vspace="0" width="120"></A><BR> 
28  <A href="../pdf.html" onMouseOut="rolloverOff('side-pdf');" onMouseOver="rolloverOn('side-pdf');"><IMG alt="PDF Document" border="0" height="12" hspace="0" name="side-pdf" onLoad="rolloverLoad('side-pdf','../graphics/pdf-label-2.jpg','../graphics/pdf-label-3.jpg');" src="../graphics/pdf-label-3.jpg" vspace="0" width="120"></A><BR>
29
30  <IMG border="0" height="6" hspace="0" src="../resources/separator.gif" vspace="0" width="120"><BR>
31
32  <A href="http://xml.apache.org/websrc/cvsweb.cgi/xml-xerces/c/" onMouseOut="rolloverOff('side-ext-100');" onMouseOver="rolloverOn('side-ext-100');"><IMG alt="CVS Repository" border="0" height="12" hspace="0" name="side-ext-100" onLoad="rolloverLoad('side-ext-100','../graphics/ext-100-label-2.jpg','../graphics/ext-100-label-3.jpg');" src="../graphics/ext-100-label-3.jpg" vspace="0" width="120"></A><BR>
33
34  <A href="http://marc.theaimsgroup.com/?l=xerces-c-dev" onMouseOut="rolloverOff('side-ext-102');" onMouseOver="rolloverOn('side-ext-102');"><IMG alt="Mail Archive" border="0" height="12" hspace="0" name="side-ext-102" onLoad="rolloverLoad('side-ext-102','../graphics/ext-102-label-2.jpg','../graphics/ext-102-label-3.jpg');" src="../graphics/ext-102-label-3.jpg" vspace="0" width="120"></A><BR>
35
36
37<IMG border="0" height="14" hspace="0" src="../resources/close.gif" vspace="0" width="120"><BR></TD><TD align="left" valign="top" width="500"><TABLE border="0" cellpadding="3" cellspacing="0"><TR><TD>
38    <TABLE border="0" cellpadding="0" cellspacing="0" width="494"><TR><TD bgcolor="#FFFFFF" colspan="2" width="494"><TABLE border="0" cellpadding="0" cellspacing="0" width="494"><TR><TD bgcolor="#039acc" height="1" width="1"><IMG border="0" height="1" hspace="0" src="../resources/void.gif" vspace="0" width="1"></TD><TD bgcolor="#039acc" height="1" width="492"><IMG border="0" height="1" hspace="0" src="../resources/void.gif" vspace="0" width="492"></TD><TD bgcolor="#0086b2" height="1" width="1"><IMG border="0" height="1" hspace="0" src="../resources/void.gif" vspace="0" width="1"></TD></TR><TR><TD bgcolor="#039acc" width="1"><IMG border="0" height="1" hspace="0" src="../resources/void.gif" vspace="0" width="1"></TD><TD bgcolor="#0086b2" width="492"><FONT color="#ffffff" face="arial,helvetica,sanserif" size="+1"><IMG border="0" height="2" hspace="0" src="../resources/void.gif" vspace="0" width="2"><B>API Docs for SAX and DOM</B></FONT></TD><TD bgcolor="#017299" width="1"><IMG border="0" height="1" hspace="0" src="../resources/void.gif" vspace="0" width="1"></TD></TR><TR><TD bgcolor="#0086b2" height="1" width="1"><IMG border="0" height="1" hspace="0" src="../resources/void.gif" vspace="0" width="1"></TD><TD bgcolor="#017299" height="1" width="492"><IMG border="0" height="1" hspace="0" src="../resources/void.gif" vspace="0" width="492"></TD><TD bgcolor="#017299" height="1" width="1"><IMG border="0" height="1" hspace="0" src="../resources/void.gif" vspace="0" width="1"></TD></TR></TABLE></TD></TR><TR><TD width="10">&nbsp;</TD><TD width="484"><FONT color="#000000" face="arial,helvetica,sanserif">
39
40            <P>
41<!-- Generated by Doxygen 1.2.14 -->
42<center>
43<a class="qindex" href="index.html">Main Page</a> &nbsp; <a class="qindex" href="hierarchy.html">Class Hierarchy</a> &nbsp; <a class="qindex" href="classes.html">Alphabetical List</a> &nbsp; <a class="qindex" href="annotated.html">Compound List</a> &nbsp; <a class="qindex" href="files.html">File List</a> &nbsp; <a class="qindex" href="functions.html">Compound Members</a> &nbsp; <a class="qindex" href="globals.html">File Members</a> &nbsp; </center>
44<hr><h1>DOMText Class Reference</h1>The <code>DOMText</code> interface inherits from <code><a class="el" href="classDOMCharacterData.html">DOMCharacterData</a></code> and represents the textual content (termed character data in XML) of an <code><a class="el" href="classDOMElement.html">DOMElement</a></code> or <code><a class="el" href="classDOMAttr.html">DOMAttr</a></code>.
45<a href="#_details">More...</a>
46<p>
47Inheritance diagram for DOMText:<p><center><img src="classDOMText__inherit__graph.gif" border="0" usemap="#DOMText__inherit__map" alt="Inheritance graph"></center>
48<map name="DOMText__inherit__map">
49<area href="classDOMCDATASection.html" shape="rect" coords="7,243,140,225" alt="">
50<area href="classDOMCharacterData.html" shape="rect" coords="8,105,139,86" alt="">
51<area href="classDOMNode.html" shape="rect" coords="37,35,109,17" alt="">
52</map>
53<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center>Collaboration diagram for DOMText:<p><center><img src="classDOMText__coll__graph.gif" border="0" usemap="#DOMText__coll__map" alt="Collaboration graph"></center>
54<map name="DOMText__coll__map">
55<area href="classDOMCharacterData.html" shape="rect" coords="7,105,137,86" alt="">
56<area href="classDOMNode.html" shape="rect" coords="36,36,108,17" alt="">
57</map>
58<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center><a href="classDOMText-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0>
59<tr><td colspan=2><br><h2>Public Methods</h2></td></tr>
60<tr><td colspan="2"><div class="groupHeader">Destructor</div></td></tr>
61<tr><td nowrap align=right valign=top>virtual&nbsp;</td><td valign=bottom><a class="el" href="classDOMText.html#z155_0">~DOMText</a> ()</td></tr>
62<tr><td>&nbsp;</td><td><font size=-1><em>Destructor.</em> <a href="#z155_0">More...</a><em></em></font><br><br></td></tr>
63<tr><td colspan="2"><div class="groupHeader">Functions introduced in DOM Level 1</div></td></tr>
64<tr><td nowrap align=right valign=top>virtual DOMText *&nbsp;</td><td valign=bottom><a class="el" href="classDOMText.html#z156_0">splitText</a> (XMLSize_t offset)=0</td></tr>
65<tr><td>&nbsp;</td><td><font size=-1><em>Breaks this node into two nodes at the specified <code>offset</code>, keeping both in the tree as siblings.</em> <a href="#z156_0">More...</a><em></em></font><br><br></td></tr>
66<tr><td colspan="2"><div class="groupHeader">Functions introduced in DOM Level 3</div></td></tr>
67<tr><td nowrap align=right valign=top>virtual bool&nbsp;</td><td valign=bottom><a class="el" href="classDOMText.html#z157_0">getIsWhitespaceInElementContent</a> () const=0</td></tr>
68<tr><td>&nbsp;</td><td><font size=-1><em>Returns whether this text node contains whitespace in element content, often abusively called "ignorable whitespace".</em> <a href="#z157_0">More...</a><em></em></font><br><br></td></tr>
69<tr><td nowrap align=right valign=top>virtual const XMLCh *&nbsp;</td><td valign=bottom><a class="el" href="classDOMText.html#z157_1">getWholeText</a> ()=0</td></tr>
70<tr><td>&nbsp;</td><td><font size=-1><em>Returns all text of <code>DOMText</code> nodes logically-adjacent text nodes to this node, concatenated in document order.</em> <a href="#z157_1">More...</a><em></em></font><br><br></td></tr>
71<tr><td nowrap align=right valign=top>virtual DOMText *&nbsp;</td><td valign=bottom><a class="el" href="classDOMText.html#z157_2">replaceWholeText</a> (const XMLCh *content)=0</td></tr>
72<tr><td>&nbsp;</td><td><font size=-1><em>Substitutes the a specified text for the text of the current node and all logically-adjacent text nodes.</em> <a href="#z157_2">More...</a><em></em></font><br><br></td></tr>
73<tr><td colspan="2"><div class="groupHeader">Non-standard extension</div></td></tr>
74<tr><td nowrap align=right valign=top>virtual bool&nbsp;</td><td valign=bottom><a class="el" href="classDOMText.html#z158_0">isIgnorableWhitespace</a> () const=0</td></tr>
75<tr><td>&nbsp;</td><td><font size=-1><em>Non-standard extension.</em> <a href="#z158_0">More...</a><em></em></font><br><br></td></tr>
76<tr><td colspan=2><br><h2>Protected Methods</h2></td></tr>
77<tr><td colspan="2"><div class="groupHeader">Hidden constructors</div></td></tr>
78<tr><td nowrap align=right valign=top>&nbsp;</td><td valign=bottom><a class="el" href="classDOMText.html#z153_0">DOMText</a> ()</td></tr>
79</table>
80<hr><a name="_details"></a><h2>Detailed Description</h2>
81The <code>DOMText</code> interface inherits from <code><a class="el" href="classDOMCharacterData.html">DOMCharacterData</a></code> and represents the textual content (termed character data in XML) of an <code><a class="el" href="classDOMElement.html">DOMElement</a></code> or <code><a class="el" href="classDOMAttr.html">DOMAttr</a></code>.
82<p>
83If there is no markup inside an element's content, the text is contained in a single object implementing the <code>DOMText</code> interface that is the only child of the element. If there is markup, it is parsed into the information items (elements, comments, etc.) and <code>DOMText</code> nodes that form the list of children of the element.
84<p>
85When a document is first made available via the DOM, there is only one <code>DOMText</code> node for each block of text. Users may create adjacent <code>DOMText</code> nodes that represent the contents of a given element without any intervening markup, but should be aware that there is no way to represent the separations between these nodes in XML or HTML, so they will not (in general) persist between DOM editing sessions. The <code><a class="el" href="classDOMNode.html#z114_0">normalize</a>()</code> method on <code><a class="el" href="classDOMNode.html">DOMNode</a></code> merges any such adjacent <code>DOMText</code> objects into a single node for each block of text.
86<p>
87See 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>.
88<p>
89<hr><h2>Constructor &amp; Destructor Documentation</h2>
90<a name="z153_0" doxytag="DOMText::DOMText"></a><p>
91<table width="100%" cellpadding="2" cellspacing="0" border="0">
92  <tr>
93    <td class="md">
94      <table cellpadding="0" cellspacing="0" border="0">
95        <tr>
96          <td class="md" nowrap valign="top"> DOMText::DOMText </td>
97          <td class="md" valign="top">(&nbsp;</td>
98          <td class="mdname1" valign="top" nowrap>&nbsp;          </td>
99          <td class="md" valign="top">)&nbsp;</td>
100          <td class="md" nowrap><code> [protected]</code></td>
101        </tr>
102
103      </table>
104    </td>
105  </tr>
106</table>
107<table cellspacing=5 cellpadding=0 border=0>
108  <tr>
109    <td>
110      &nbsp;
111    </td>
112    <td>
113
114<p>
115    </td>
116  </tr>
117</table>
118<a name="z155_0" doxytag="DOMText::~DOMText"></a><p>
119<table width="100%" cellpadding="2" cellspacing="0" border="0">
120  <tr>
121    <td class="md">
122      <table cellpadding="0" cellspacing="0" border="0">
123        <tr>
124          <td class="md" nowrap valign="top"> virtual DOMText::~DOMText </td>
125          <td class="md" valign="top">(&nbsp;</td>
126          <td class="mdname1" valign="top" nowrap>&nbsp;          </td>
127          <td class="md" valign="top">)&nbsp;</td>
128          <td class="md" nowrap><code> [virtual]</code></td>
129        </tr>
130
131      </table>
132    </td>
133  </tr>
134</table>
135<table cellspacing=5 cellpadding=0 border=0>
136  <tr>
137    <td>
138      &nbsp;
139    </td>
140    <td>
141
142<p>
143Destructor.
144<p>
145    </td>
146  </tr>
147</table>
148<hr><h2>Member Function Documentation</h2>
149<a name="z157_0" doxytag="DOMText::getIsWhitespaceInElementContent"></a><p>
150<table width="100%" cellpadding="2" cellspacing="0" border="0">
151  <tr>
152    <td class="md">
153      <table cellpadding="0" cellspacing="0" border="0">
154        <tr>
155          <td class="md" nowrap valign="top"> virtual bool DOMText::getIsWhitespaceInElementContent </td>
156          <td class="md" valign="top">(&nbsp;</td>
157          <td class="mdname1" valign="top" nowrap>&nbsp;          </td>
158          <td class="md" valign="top">)&nbsp;</td>
159          <td class="md" nowrap> const<code> [pure virtual]</code></td>
160        </tr>
161
162      </table>
163    </td>
164  </tr>
165</table>
166<table cellspacing=5 cellpadding=0 border=0>
167  <tr>
168    <td>
169      &nbsp;
170    </td>
171    <td>
172
173<p>
174Returns whether this text node contains whitespace in element content, often abusively called "ignorable whitespace".
175<p>
176An implementation can only return <code>true</code> if, one way or another, it has access to the relevant information (e.g., the DTD or schema).
177<p>
178
179<p>
180<b>"Experimental - subject to change"</b>
181<p>
182<br>
183 This attribute represents the property [element content whitespace] defined in . <dl compact><dt><b>
184Since: </b><dd>
185DOM Level 3 </dl>    </td>
186  </tr>
187</table>
188<a name="z157_1" doxytag="DOMText::getWholeText"></a><p>
189<table width="100%" cellpadding="2" cellspacing="0" border="0">
190  <tr>
191    <td class="md">
192      <table cellpadding="0" cellspacing="0" border="0">
193        <tr>
194          <td class="md" nowrap valign="top"> virtual const XMLCh* DOMText::getWholeText </td>
195          <td class="md" valign="top">(&nbsp;</td>
196          <td class="mdname1" valign="top" nowrap>&nbsp;          </td>
197          <td class="md" valign="top">)&nbsp;</td>
198          <td class="md" nowrap><code> [pure virtual]</code></td>
199        </tr>
200
201      </table>
202    </td>
203  </tr>
204</table>
205<table cellspacing=5 cellpadding=0 border=0>
206  <tr>
207    <td>
208      &nbsp;
209    </td>
210    <td>
211
212<p>
213Returns all text of <code>DOMText</code> nodes logically-adjacent text nodes to this node, concatenated in document order.
214<p>
215
216<p>
217<b>"Experimental - subject to change"</b>
218<p>
219<dl compact><dt><b>
220Since: </b><dd>
221DOM Level 3 </dl>    </td>
222  </tr>
223</table>
224<a name="z158_0" doxytag="DOMText::isIgnorableWhitespace"></a><p>
225<table width="100%" cellpadding="2" cellspacing="0" border="0">
226  <tr>
227    <td class="md">
228      <table cellpadding="0" cellspacing="0" border="0">
229        <tr>
230          <td class="md" nowrap valign="top"> virtual bool DOMText::isIgnorableWhitespace </td>
231          <td class="md" valign="top">(&nbsp;</td>
232          <td class="mdname1" valign="top" nowrap>&nbsp;          </td>
233          <td class="md" valign="top">)&nbsp;</td>
234          <td class="md" nowrap> const<code> [pure virtual]</code></td>
235        </tr>
236
237      </table>
238    </td>
239  </tr>
240</table>
241<table cellspacing=5 cellpadding=0 border=0>
242  <tr>
243    <td>
244      &nbsp;
245    </td>
246    <td>
247
248<p>
249Non-standard extension.
250<p>
251Return true if this node contains ignorable whitespaces only. <dl compact><dt><b>
252Returns: </b><dd>
253True if this node contains ignorable whitespaces only. </dl>    </td>
254  </tr>
255</table>
256<a name="z157_2" doxytag="DOMText::replaceWholeText"></a><p>
257<table width="100%" cellpadding="2" cellspacing="0" border="0">
258  <tr>
259    <td class="md">
260      <table cellpadding="0" cellspacing="0" border="0">
261        <tr>
262          <td class="md" nowrap valign="top"> virtual DOMText* DOMText::replaceWholeText </td>
263          <td class="md" valign="top">(&nbsp;</td>
264          <td class="md" nowrap valign="top">const XMLCh *&nbsp;</td>
265          <td class="mdname1" valign="top" nowrap>&nbsp; <em>content</em>          </td>
266          <td class="md" valign="top">)&nbsp;</td>
267          <td class="md" nowrap><code> [pure virtual]</code></td>
268        </tr>
269
270      </table>
271    </td>
272  </tr>
273</table>
274<table cellspacing=5 cellpadding=0 border=0>
275  <tr>
276    <td>
277      &nbsp;
278    </td>
279    <td>
280
281<p>
282Substitutes the a specified text for the text of the current node and all logically-adjacent text nodes.
283<p>
284
285<p>
286<b>"Experimental - subject to change"</b>
287<p>
288<br>
289This method returns the node in the hierarchy which received the replacement text, which is null if the text was empty or is the current node if the current node is not read-only or otherwise is a new node of the same type as the current node inserted at the site of the replacement. All logically-adjacent text nodes are removed including the current node unless it was the recipient of the replacement text. <br>
290Where the nodes to be removed are read-only descendants of an <code><a class="el" href="classDOMEntityReference.html">DOMEntityReference</a></code>, the <code><a class="el" href="classDOMEntityReference.html">DOMEntityReference</a></code> must be removed instead of the read-only nodes. If any <code><a class="el" href="classDOMEntityReference.html">DOMEntityReference</a></code> to be removed has descendants that are not <code><a class="el" href="classDOMEntityReference.html">DOMEntityReference</a></code>, <code>DOMText</code>, or <code><a class="el" href="classDOMCDATASection.html">DOMCDATASection</a></code> nodes, the <code>replaceWholeText</code> method must fail before performing any modification of the document, raising a <code><a class="el" href="classDOMException.html">DOMException</a></code> with the code <code>NO_MODIFICATION_ALLOWED_ERR</code>. <dl compact><dt><b>
291Parameters: </b><dd>
292<table border=0 cellspacing=2 cellpadding=0>
293<tr><td valign=top><em>content</em>&nbsp;</td><td>
294The content of the replacing <code>DOMText</code> node. </td></tr>
295</table>
296</dl><dl compact><dt><b>
297Returns: </b><dd>
298The <code>DOMText</code> node created with the specified content. </dl><dl compact><dt><b>
299Exceptions: </b><dd>
300<table border=0 cellspacing=2 cellpadding=0>
301<tr><td valign=top><em><a class="el" href="classDOMException.html">DOMException</a></em>&nbsp;</td><td>
302 NO_MODIFICATION_ALLOWED_ERR: Raised if one of the <code>DOMText</code> nodes being replaced is readonly. </td></tr>
303</table>
304</dl><dl compact><dt><b>
305Since: </b><dd>
306DOM Level 3 </dl>    </td>
307  </tr>
308</table>
309<a name="z156_0" doxytag="DOMText::splitText"></a><p>
310<table width="100%" cellpadding="2" cellspacing="0" border="0">
311  <tr>
312    <td class="md">
313      <table cellpadding="0" cellspacing="0" border="0">
314        <tr>
315          <td class="md" nowrap valign="top"> virtual DOMText* DOMText::splitText </td>
316          <td class="md" valign="top">(&nbsp;</td>
317          <td class="md" nowrap valign="top">XMLSize_t&nbsp;</td>
318          <td class="mdname1" valign="top" nowrap>&nbsp; <em>offset</em>          </td>
319          <td class="md" valign="top">)&nbsp;</td>
320          <td class="md" nowrap><code> [pure virtual]</code></td>
321        </tr>
322
323      </table>
324    </td>
325  </tr>
326</table>
327<table cellspacing=5 cellpadding=0 border=0>
328  <tr>
329    <td>
330      &nbsp;
331    </td>
332    <td>
333
334<p>
335Breaks this node into two nodes at the specified <code>offset</code>, keeping both in the tree as siblings.
336<p>
337After being split, this node will contain all the content up to the <code>offset</code> point. A new node of the same type, which contains all the content at and after the <code>offset</code> point, is returned. If the original node had a parent node, the new node is inserted as the next sibling of the original node. When the <code>offset</code> is equal to the length of this node, the new node has no data. <dl compact><dt><b>
338Parameters: </b><dd>
339<table border=0 cellspacing=2 cellpadding=0>
340<tr><td valign=top><em>offset</em>&nbsp;</td><td>
341The 16-bit unit offset at which to split, starting from <code>0</code>. </td></tr>
342</table>
343</dl><dl compact><dt><b>
344Returns: </b><dd>
345The new node, of the same type as this node. </dl><dl compact><dt><b>
346Exceptions: </b><dd>
347<table border=0 cellspacing=2 cellpadding=0>
348<tr><td valign=top><em><a class="el" href="classDOMException.html">DOMException</a></em>&nbsp;</td><td>
349 INDEX_SIZE_ERR: Raised if the specified offset is negative or greater than the number of 16-bit units in <code>data</code>. <br>
350NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly. </td></tr>
351</table>
352</dl><dl compact><dt><b>
353Since: </b><dd>
354DOM Level 1 </dl>    </td>
355  </tr>
356</table>
357<hr>The documentation for this class was generated from the following file:<ul>
358<li><a class="el" href="DOMText_8hpp-source.html">DOMText.hpp</a></ul>
359    </FONT></TD></TR></TABLE><BR>
360</TD></TR></TABLE></TD></TR></TABLE><BR><TABLE border="0" cellpadding="0" cellspacing="0" width="620"><TR><TD bgcolor="#0086b2"><IMG height="1" src="images/dot.gif" width="1" alt=""></TD></TR><TR><TD align="center"><FONT color="#0086b2" size="-1"><I>
361              Copyright &copy; 1994-2004 The Apache Software Foundation.
362              All Rights Reserved.
363            </I></FONT></TD></TR></TABLE></BODY></HTML>
Note: See TracBrowser for help on using the repository browser.