upstream version 1.2.2
[debian/freetts] / javadoc / com / sun / speech / freetts / FreeTTSSpeakableImpl.html
1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">\r
2 <!--NewPage-->\r
3 <HTML>\r
4 <HEAD>\r
5 <!-- Generated by javadoc (build 1.4.2_16) on Mon Mar 09 18:20:29 CET 2009 -->\r
6 <TITLE>\r
7 FreeTTSSpeakableImpl (FreeTTS 1.2)\r
8 </TITLE>\r
9 \r
10 <META NAME="keywords" CONTENT="com.sun.speech.freetts.FreeTTSSpeakableImpl class">\r
11 \r
12 <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style">\r
13 \r
14 <SCRIPT type="text/javascript">\r
15 function windowTitle()\r
16 {\r
17     parent.document.title="FreeTTSSpeakableImpl (FreeTTS 1.2)";\r
18 }\r
19 </SCRIPT>\r
20 \r
21 </HEAD>\r
22 \r
23 <BODY BGCOLOR="white" onload="windowTitle();">\r
24 \r
25
26 <!-- ========= START OF TOP NAVBAR ======= -->\r
27 <A NAME="navbar_top"><!-- --></A>
28 <A HREF="#skip-navbar_top" title="Skip navigation links"></A>
29 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">\r
30 <TR>\r
31 <TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">\r
32 <A NAME="navbar_top_firstrow"><!-- --></A>
33 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">\r
34   <TR ALIGN="center" VALIGN="top">\r
35   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>\r
36   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>\r
37   <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>\r
38   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>\r
39   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>\r
40   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>\r
41   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>\r
42   </TR>\r
43 </TABLE>\r
44 </TD>\r
45 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>\r
46 </EM>\r
47 </TD>\r
48 </TR>\r
49 \r
50 <TR>\r
51 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
52 &nbsp;<A HREF="../../../../com/sun/speech/freetts/FreeTTS.html" title="class in com.sun.speech.freetts"><B>PREV CLASS</B></A>&nbsp;\r
53 &nbsp;<A HREF="../../../../com/sun/speech/freetts/FreeTTSTime.html" title="class in com.sun.speech.freetts"><B>NEXT CLASS</B></A></FONT></TD>\r
54 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
55   <A HREF="../../../../index.html" target="_top"><B>FRAMES</B></A>  &nbsp;\r
56 &nbsp;<A HREF="FreeTTSSpeakableImpl.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;\r
57 &nbsp;<SCRIPT type="text/javascript">\r
58   <!--\r
59   if(window==top) {\r
60     document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');\r
61   }\r
62   //-->\r
63 </SCRIPT>\r
64 <NOSCRIPT>\r
65   <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>\r
66 </NOSCRIPT>
67 \r
68 </FONT></TD>\r
69 </TR>\r
70 <TR>\r
71 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">\r
72   SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>\r
73 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">\r
74 DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>\r
75 </TR>\r
76 </TABLE>\r
77 <A NAME="skip-navbar_top"></A>
78 <!-- ========= END OF TOP NAVBAR ========= -->\r
79 \r
80 <HR>\r
81 <!-- ======== START OF CLASS DATA ======== -->\r
82 <H2>\r
83 <FONT SIZE="-1">\r
84 com.sun.speech.freetts</FONT>\r
85 <BR>\r
86 Class FreeTTSSpeakableImpl</H2>\r
87 <PRE>\r
88 java.lang.Object\r
89   <IMG SRC="../../../../resources/inherit.gif" ALT="extended by"><B>com.sun.speech.freetts.FreeTTSSpeakableImpl</B>\r
90 </PRE>\r
91 <DL>\r
92 <DT><B>All Implemented Interfaces:</B> <DD><A HREF="../../../../com/sun/speech/freetts/FreeTTSSpeakable.html" title="interface in com.sun.speech.freetts">FreeTTSSpeakable</A></DD>\r
93 </DL>\r
94 <HR>\r
95 <DL>\r
96 <DT>public class <B>FreeTTSSpeakableImpl</B><DT>extends java.lang.Object<DT>implements <A HREF="../../../../com/sun/speech/freetts/FreeTTSSpeakable.html" title="interface in com.sun.speech.freetts">FreeTTSSpeakable</A></DL>\r
97 \r
98 <P>\r
99 Minimal implementation of a FreeTTSSpeakable\r
100 <P>\r
101 \r
102 <P>\r
103 <HR>\r
104 \r
105 <P>\r
106 <!-- ======== NESTED CLASS SUMMARY ======== -->\r
107 \r
108 \r
109 <!-- =========== FIELD SUMMARY =========== -->\r
110 \r
111 \r
112 <!-- ======== CONSTRUCTOR SUMMARY ======== -->\r
113 \r
114 <A NAME="constructor_summary"><!-- --></A>
115 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
116 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
117 <TD COLSPAN=2><FONT SIZE="+2">\r
118 <B>Constructor Summary</B></FONT></TD>\r
119 </TR>\r
120 <TR BGCOLOR="white" CLASS="TableRowColor">\r
121 <TD><CODE><B><A HREF="../../../../com/sun/speech/freetts/FreeTTSSpeakableImpl.html#FreeTTSSpeakableImpl(org.w3c.dom.Document)">FreeTTSSpeakableImpl</A></B>(org.w3c.dom.Document&nbsp;doc)</CODE>\r
122 \r
123 <BR>\r
124 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Constructor.</TD>\r
125 </TR>\r
126 <TR BGCOLOR="white" CLASS="TableRowColor">\r
127 <TD><CODE><B><A HREF="../../../../com/sun/speech/freetts/FreeTTSSpeakableImpl.html#FreeTTSSpeakableImpl(java.io.InputStream)">FreeTTSSpeakableImpl</A></B>(java.io.InputStream&nbsp;is)</CODE>\r
128 \r
129 <BR>\r
130 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Constructor.</TD>\r
131 </TR>\r
132 <TR BGCOLOR="white" CLASS="TableRowColor">\r
133 <TD><CODE><B><A HREF="../../../../com/sun/speech/freetts/FreeTTSSpeakableImpl.html#FreeTTSSpeakableImpl(java.lang.String)">FreeTTSSpeakableImpl</A></B>(java.lang.String&nbsp;text)</CODE>\r
134 \r
135 <BR>\r
136 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Constructor.</TD>\r
137 </TR>\r
138 </TABLE>\r
139 &nbsp;\r
140 <!-- ========== METHOD SUMMARY =========== -->\r
141 \r
142 <A NAME="method_summary"><!-- --></A>
143 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
144 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
145 <TD COLSPAN=2><FONT SIZE="+2">\r
146 <B>Method Summary</B></FONT></TD>\r
147 </TR>\r
148 <TR BGCOLOR="white" CLASS="TableRowColor">\r
149 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
150 <CODE>&nbsp;void</CODE></FONT></TD>\r
151 <TD><CODE><B><A HREF="../../../../com/sun/speech/freetts/FreeTTSSpeakableImpl.html#cancelled()">cancelled</A></B>()</CODE>\r
152 \r
153 <BR>\r
154 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Indicates that this speakable has been cancelled.</TD>\r
155 </TR>\r
156 <TR BGCOLOR="white" CLASS="TableRowColor">\r
157 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
158 <CODE>&nbsp;void</CODE></FONT></TD>\r
159 <TD><CODE><B><A HREF="../../../../com/sun/speech/freetts/FreeTTSSpeakableImpl.html#completed()">completed</A></B>()</CODE>\r
160 \r
161 <BR>\r
162 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Indicates that this speakable has been completed.</TD>\r
163 </TR>\r
164 <TR BGCOLOR="white" CLASS="TableRowColor">\r
165 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
166 <CODE>&nbsp;org.w3c.dom.Document</CODE></FONT></TD>\r
167 <TD><CODE><B><A HREF="../../../../com/sun/speech/freetts/FreeTTSSpeakableImpl.html#getDocument()">getDocument</A></B>()</CODE>\r
168 \r
169 <BR>\r
170 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Gets the DOM document for this object.</TD>\r
171 </TR>\r
172 <TR BGCOLOR="white" CLASS="TableRowColor">\r
173 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
174 <CODE>&nbsp;java.io.InputStream</CODE></FONT></TD>\r
175 <TD><CODE><B><A HREF="../../../../com/sun/speech/freetts/FreeTTSSpeakableImpl.html#getInputStream()">getInputStream</A></B>()</CODE>\r
176 \r
177 <BR>\r
178 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Gets the input stream.</TD>\r
179 </TR>\r
180 <TR BGCOLOR="white" CLASS="TableRowColor">\r
181 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
182 <CODE>&nbsp;java.lang.String</CODE></FONT></TD>\r
183 <TD><CODE><B><A HREF="../../../../com/sun/speech/freetts/FreeTTSSpeakableImpl.html#getText()">getText</A></B>()</CODE>\r
184 \r
185 <BR>\r
186 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the text corresponding to this Playable.</TD>\r
187 </TR>\r
188 <TR BGCOLOR="white" CLASS="TableRowColor">\r
189 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
190 <CODE>&nbsp;boolean</CODE></FONT></TD>\r
191 <TD><CODE><B><A HREF="../../../../com/sun/speech/freetts/FreeTTSSpeakableImpl.html#isCompleted()">isCompleted</A></B>()</CODE>\r
192 \r
193 <BR>\r
194 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns true if this queue item has been 
195  processed.</TD>\r
196 </TR>\r
197 <TR BGCOLOR="white" CLASS="TableRowColor">\r
198 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
199 <CODE>&nbsp;boolean</CODE></FONT></TD>\r
200 <TD><CODE><B><A HREF="../../../../com/sun/speech/freetts/FreeTTSSpeakableImpl.html#isDocument()">isDocument</A></B>()</CODE>\r
201 \r
202 <BR>\r
203 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns <code>true</code> if the item is a JSML document
204  (Java Speech Markup Language).</TD>\r
205 </TR>\r
206 <TR BGCOLOR="white" CLASS="TableRowColor">\r
207 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
208 <CODE>&nbsp;boolean</CODE></FONT></TD>\r
209 <TD><CODE><B><A HREF="../../../../com/sun/speech/freetts/FreeTTSSpeakableImpl.html#isPlainText()">isPlainText</A></B>()</CODE>\r
210 \r
211 <BR>\r
212 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns <code>true</code> if the item contains plain text
213  (not Java Speech Markup Language text).</TD>\r
214 </TR>\r
215 <TR BGCOLOR="white" CLASS="TableRowColor">\r
216 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
217 <CODE>&nbsp;boolean</CODE></FONT></TD>\r
218 <TD><CODE><B><A HREF="../../../../com/sun/speech/freetts/FreeTTSSpeakableImpl.html#isStream()">isStream</A></B>()</CODE>\r
219 \r
220 <BR>\r
221 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns <code>true</code> if the item is an input stream.</TD>\r
222 </TR>\r
223 <TR BGCOLOR="white" CLASS="TableRowColor">\r
224 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
225 <CODE>&nbsp;void</CODE></FONT></TD>\r
226 <TD><CODE><B><A HREF="../../../../com/sun/speech/freetts/FreeTTSSpeakableImpl.html#started()">started</A></B>()</CODE>\r
227 \r
228 <BR>\r
229 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Indicate that this speakable has been started.</TD>\r
230 </TR>\r
231 <TR BGCOLOR="white" CLASS="TableRowColor">\r
232 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
233 <CODE>&nbsp;boolean</CODE></FONT></TD>\r
234 <TD><CODE><B><A HREF="../../../../com/sun/speech/freetts/FreeTTSSpeakableImpl.html#waitCompleted()">waitCompleted</A></B>()</CODE>\r
235 \r
236 <BR>\r
237 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Waits for this speakable item to be completed.</TD>\r
238 </TR>\r
239 </TABLE>\r
240 &nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
241 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
242 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">\r
243 <TD><B>Methods inherited from class java.lang.Object</B></TD>\r
244 </TR>\r
245 <TR BGCOLOR="white" CLASS="TableRowColor">\r
246 <TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>\r
247 </TR>\r
248 </TABLE>\r
249 &nbsp;\r
250 <P>\r
251 \r
252 <!-- ============ FIELD DETAIL =========== -->\r
253 \r
254 \r
255 <!-- ========= CONSTRUCTOR DETAIL ======== -->\r
256 \r
257 <A NAME="constructor_detail"><!-- --></A>
258 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
259 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
260 <TD COLSPAN=1><FONT SIZE="+2">\r
261 <B>Constructor Detail</B></FONT></TD>\r
262 </TR>\r
263 </TABLE>\r
264 \r
265 <A NAME="FreeTTSSpeakableImpl(java.lang.String)"><!-- --></A><H3>\r
266 FreeTTSSpeakableImpl</H3>\r
267 <PRE>\r
268 public <B>FreeTTSSpeakableImpl</B>(java.lang.String&nbsp;text)</PRE>\r
269 <DL>\r
270 <DD>Constructor.\r
271 <P>\r
272 <DT><B>Parameters:</B><DD><CODE>text</CODE> - the text to be spoken</DL>\r
273 <HR>\r
274 \r
275 <A NAME="FreeTTSSpeakableImpl(org.w3c.dom.Document)"><!-- --></A><H3>\r
276 FreeTTSSpeakableImpl</H3>\r
277 <PRE>\r
278 public <B>FreeTTSSpeakableImpl</B>(org.w3c.dom.Document&nbsp;doc)</PRE>\r
279 <DL>\r
280 <DD>Constructor.\r
281 <P>\r
282 <DT><B>Parameters:</B><DD><CODE>doc</CODE> - the doc to be spoken</DL>\r
283 <HR>\r
284 \r
285 <A NAME="FreeTTSSpeakableImpl(java.io.InputStream)"><!-- --></A><H3>\r
286 FreeTTSSpeakableImpl</H3>\r
287 <PRE>\r
288 public <B>FreeTTSSpeakableImpl</B>(java.io.InputStream&nbsp;is)</PRE>\r
289 <DL>\r
290 <DD>Constructor.\r
291 <P>\r
292 <DT><B>Parameters:</B><DD><CODE>is</CODE> - the doc to be spoken</DL>\r
293 \r
294 <!-- ============ METHOD DETAIL ========== -->\r
295 \r
296 <A NAME="method_detail"><!-- --></A>
297 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
298 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
299 <TD COLSPAN=1><FONT SIZE="+2">\r
300 <B>Method Detail</B></FONT></TD>\r
301 </TR>\r
302 </TABLE>\r
303 \r
304 <A NAME="started()"><!-- --></A><H3>\r
305 started</H3>\r
306 <PRE>\r
307 public void <B>started</B>()</PRE>\r
308 <DL>\r
309 <DD>Indicate that this speakable has been started.\r
310 <P>\r
311 <DD><DL>\r
312 <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../com/sun/speech/freetts/FreeTTSSpeakable.html#started()">started</A></CODE> in interface <CODE><A HREF="../../../../com/sun/speech/freetts/FreeTTSSpeakable.html" title="interface in com.sun.speech.freetts">FreeTTSSpeakable</A></CODE></DL>\r
313 </DD>\r
314 <DD><DL>\r
315 </DL>\r
316 </DD>\r
317 </DL>\r
318 <HR>\r
319 \r
320 <A NAME="completed()"><!-- --></A><H3>\r
321 completed</H3>\r
322 <PRE>\r
323 public void <B>completed</B>()</PRE>\r
324 <DL>\r
325 <DD>Indicates that this speakable has been completed.\r
326 <P>\r
327 <DD><DL>\r
328 <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../com/sun/speech/freetts/FreeTTSSpeakable.html#completed()">completed</A></CODE> in interface <CODE><A HREF="../../../../com/sun/speech/freetts/FreeTTSSpeakable.html" title="interface in com.sun.speech.freetts">FreeTTSSpeakable</A></CODE></DL>\r
329 </DD>\r
330 <DD><DL>\r
331 </DL>\r
332 </DD>\r
333 </DL>\r
334 <HR>\r
335 \r
336 <A NAME="cancelled()"><!-- --></A><H3>\r
337 cancelled</H3>\r
338 <PRE>\r
339 public void <B>cancelled</B>()</PRE>\r
340 <DL>\r
341 <DD>Indicates that this speakable has been cancelled.\r
342 <P>\r
343 <DD><DL>\r
344 <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../com/sun/speech/freetts/FreeTTSSpeakable.html#cancelled()">cancelled</A></CODE> in interface <CODE><A HREF="../../../../com/sun/speech/freetts/FreeTTSSpeakable.html" title="interface in com.sun.speech.freetts">FreeTTSSpeakable</A></CODE></DL>\r
345 </DD>\r
346 <DD><DL>\r
347 </DL>\r
348 </DD>\r
349 </DL>\r
350 <HR>\r
351 \r
352 <A NAME="isCompleted()"><!-- --></A><H3>\r
353 isCompleted</H3>\r
354 <PRE>\r
355 public boolean <B>isCompleted</B>()</PRE>\r
356 <DL>\r
357 <DD>Returns true if this queue item has been 
358  processed.\r
359 <P>\r
360 <DD><DL>\r
361 <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../com/sun/speech/freetts/FreeTTSSpeakable.html#isCompleted()">isCompleted</A></CODE> in interface <CODE><A HREF="../../../../com/sun/speech/freetts/FreeTTSSpeakable.html" title="interface in com.sun.speech.freetts">FreeTTSSpeakable</A></CODE></DL>\r
362 </DD>\r
363 <DD><DL>\r
364
365 <DT><B>Returns:</B><DD>true if it has been processed</DL>\r
366 </DD>\r
367 </DL>\r
368 <HR>\r
369 \r
370 <A NAME="waitCompleted()"><!-- --></A><H3>\r
371 waitCompleted</H3>\r
372 <PRE>\r
373 public boolean <B>waitCompleted</B>()</PRE>\r
374 <DL>\r
375 <DD>Waits for this speakable item to be completed.\r
376 <P>\r
377 <DD><DL>\r
378 <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../com/sun/speech/freetts/FreeTTSSpeakable.html#waitCompleted()">waitCompleted</A></CODE> in interface <CODE><A HREF="../../../../com/sun/speech/freetts/FreeTTSSpeakable.html" title="interface in com.sun.speech.freetts">FreeTTSSpeakable</A></CODE></DL>\r
379 </DD>\r
380 <DD><DL>\r
381
382 <DT><B>Returns:</B><DD>true if the item was completed successfully, false if
383    the speakable  was cancelled or an error occurred.</DL>\r
384 </DD>\r
385 </DL>\r
386 <HR>\r
387 \r
388 <A NAME="isPlainText()"><!-- --></A><H3>\r
389 isPlainText</H3>\r
390 <PRE>\r
391 public boolean <B>isPlainText</B>()</PRE>\r
392 <DL>\r
393 <DD>Returns <code>true</code> if the item contains plain text
394  (not Java Speech Markup Language text).\r
395 <P>\r
396 <DD><DL>\r
397 <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../com/sun/speech/freetts/FreeTTSSpeakable.html#isPlainText()">isPlainText</A></CODE> in interface <CODE><A HREF="../../../../com/sun/speech/freetts/FreeTTSSpeakable.html" title="interface in com.sun.speech.freetts">FreeTTSSpeakable</A></CODE></DL>\r
398 </DD>\r
399 <DD><DL>\r
400
401 <DT><B>Returns:</B><DD>true if the item contains plain text</DL>\r
402 </DD>\r
403 </DL>\r
404 <HR>\r
405 \r
406 <A NAME="getText()"><!-- --></A><H3>\r
407 getText</H3>\r
408 <PRE>\r
409 public java.lang.String <B>getText</B>()</PRE>\r
410 <DL>\r
411 <DD>Returns the text corresponding to this Playable.\r
412 <P>\r
413 <DD><DL>\r
414 <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../com/sun/speech/freetts/FreeTTSSpeakable.html#getText()">getText</A></CODE> in interface <CODE><A HREF="../../../../com/sun/speech/freetts/FreeTTSSpeakable.html" title="interface in com.sun.speech.freetts">FreeTTSSpeakable</A></CODE></DL>\r
415 </DD>\r
416 <DD><DL>\r
417
418 <DT><B>Returns:</B><DD>the Playable text</DL>\r
419 </DD>\r
420 </DL>\r
421 <HR>\r
422 \r
423 <A NAME="getDocument()"><!-- --></A><H3>\r
424 getDocument</H3>\r
425 <PRE>\r
426 public org.w3c.dom.Document <B>getDocument</B>()</PRE>\r
427 <DL>\r
428 <DD>Gets the DOM document for this object.\r
429 <P>\r
430 <DD><DL>\r
431 <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../com/sun/speech/freetts/FreeTTSSpeakable.html#getDocument()">getDocument</A></CODE> in interface <CODE><A HREF="../../../../com/sun/speech/freetts/FreeTTSSpeakable.html" title="interface in com.sun.speech.freetts">FreeTTSSpeakable</A></CODE></DL>\r
432 </DD>\r
433 <DD><DL>\r
434
435 <DT><B>Returns:</B><DD>the DOM document for this object.</DL>\r
436 </DD>\r
437 </DL>\r
438 <HR>\r
439 \r
440 <A NAME="isStream()"><!-- --></A><H3>\r
441 isStream</H3>\r
442 <PRE>\r
443 public boolean <B>isStream</B>()</PRE>\r
444 <DL>\r
445 <DD>Returns <code>true</code> if the item is an input stream.\r
446 <P>\r
447 <DD><DL>\r
448 <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../com/sun/speech/freetts/FreeTTSSpeakable.html#isStream()">isStream</A></CODE> in interface <CODE><A HREF="../../../../com/sun/speech/freetts/FreeTTSSpeakable.html" title="interface in com.sun.speech.freetts">FreeTTSSpeakable</A></CODE></DL>\r
449 </DD>\r
450 <DD><DL>\r
451
452 <DT><B>Returns:</B><DD>true if the item is an input stream</DL>\r
453 </DD>\r
454 </DL>\r
455 <HR>\r
456 \r
457 <A NAME="getInputStream()"><!-- --></A><H3>\r
458 getInputStream</H3>\r
459 <PRE>\r
460 public java.io.InputStream <B>getInputStream</B>()</PRE>\r
461 <DL>\r
462 <DD>Gets the input stream.\r
463 <P>\r
464 <DD><DL>\r
465 <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../com/sun/speech/freetts/FreeTTSSpeakable.html#getInputStream()">getInputStream</A></CODE> in interface <CODE><A HREF="../../../../com/sun/speech/freetts/FreeTTSSpeakable.html" title="interface in com.sun.speech.freetts">FreeTTSSpeakable</A></CODE></DL>\r
466 </DD>\r
467 <DD><DL>\r
468
469 <DT><B>Returns:</B><DD>the input stream</DL>\r
470 </DD>\r
471 </DL>\r
472 <HR>\r
473 \r
474 <A NAME="isDocument()"><!-- --></A><H3>\r
475 isDocument</H3>\r
476 <PRE>\r
477 public boolean <B>isDocument</B>()</PRE>\r
478 <DL>\r
479 <DD>Returns <code>true</code> if the item is a JSML document
480  (Java Speech Markup Language).\r
481 <P>\r
482 <DD><DL>\r
483 <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../com/sun/speech/freetts/FreeTTSSpeakable.html#isDocument()">isDocument</A></CODE> in interface <CODE><A HREF="../../../../com/sun/speech/freetts/FreeTTSSpeakable.html" title="interface in com.sun.speech.freetts">FreeTTSSpeakable</A></CODE></DL>\r
484 </DD>\r
485 <DD><DL>\r
486
487 <DT><B>Returns:</B><DD>true if the item is a document</DL>\r
488 </DD>\r
489 </DL>\r
490 <!-- ========= END OF CLASS DATA ========= -->\r
491 <HR>\r
492 \r
493
494 <!-- ======= START OF BOTTOM NAVBAR ====== -->\r
495 <A NAME="navbar_bottom"><!-- --></A>
496 <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
497 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">\r
498 <TR>\r
499 <TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">\r
500 <A NAME="navbar_bottom_firstrow"><!-- --></A>
501 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">\r
502   <TR ALIGN="center" VALIGN="top">\r
503   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>\r
504   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>\r
505   <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>\r
506   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>\r
507   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>\r
508   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>\r
509   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>\r
510   </TR>\r
511 </TABLE>\r
512 </TD>\r
513 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>\r
514 </EM>\r
515 </TD>\r
516 </TR>\r
517 \r
518 <TR>\r
519 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
520 &nbsp;<A HREF="../../../../com/sun/speech/freetts/FreeTTS.html" title="class in com.sun.speech.freetts"><B>PREV CLASS</B></A>&nbsp;\r
521 &nbsp;<A HREF="../../../../com/sun/speech/freetts/FreeTTSTime.html" title="class in com.sun.speech.freetts"><B>NEXT CLASS</B></A></FONT></TD>\r
522 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
523   <A HREF="../../../../index.html" target="_top"><B>FRAMES</B></A>  &nbsp;\r
524 &nbsp;<A HREF="FreeTTSSpeakableImpl.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;\r
525 &nbsp;<SCRIPT type="text/javascript">\r
526   <!--\r
527   if(window==top) {\r
528     document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');\r
529   }\r
530   //-->\r
531 </SCRIPT>\r
532 <NOSCRIPT>\r
533   <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>\r
534 </NOSCRIPT>
535 \r
536 </FONT></TD>\r
537 </TR>\r
538 <TR>\r
539 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">\r
540   SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>\r
541 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">\r
542 DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>\r
543 </TR>\r
544 </TABLE>\r
545 <A NAME="skip-navbar_bottom"></A>
546 <!-- ======== END OF BOTTOM NAVBAR ======= -->\r
547 \r
548 <HR>\r
549 \r
550 </BODY>\r
551 </HTML>\r