PageRenderTime 48ms CodeModel.GetById 18ms app.highlight 21ms RepoModel.GetById 1ms app.codeStats 1ms

/documentation/tts/com/google/tts/TTSEarcon.html

http://eyes-free.googlecode.com/
HTML | 354 lines | 292 code | 40 blank | 22 comment | 0 complexity | 974f4608238735ad1ec1a7082bced871 MD5 | raw file
  1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
  2<!--NewPage-->
  3<HTML>
  4<HEAD>
  5<!-- Generated by javadoc (build 1.6.0_16) on Fri Oct 09 19:06:10 PDT 2009 -->
  6<TITLE>
  7TTSEarcon
  8</TITLE>
  9
 10<META NAME="date" CONTENT="2009-10-09">
 11
 12<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../stylesheet.css" TITLE="Style">
 13
 14<SCRIPT type="text/javascript">
 15function windowTitle()
 16{
 17    if (location.href.indexOf('is-external=true') == -1) {
 18        parent.document.title="TTSEarcon";
 19    }
 20}
 21</SCRIPT>
 22<NOSCRIPT>
 23</NOSCRIPT>
 24
 25</HEAD>
 26
 27<BODY BGCOLOR="white" onload="windowTitle();">
 28<HR>
 29
 30
 31<!-- ========= START OF TOP NAVBAR ======= -->
 32<A NAME="navbar_top"><!-- --></A>
 33<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
 34<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
 35<TR>
 36<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
 37<A NAME="navbar_top_firstrow"><!-- --></A>
 38<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
 39  <TR ALIGN="center" VALIGN="top">
 40  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../com/google/tts/package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
 41  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
 42  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
 43  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
 44  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
 45  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
 46  </TR>
 47</TABLE>
 48</TD>
 49<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
 50</EM>
 51</TD>
 52</TR>
 53
 54<TR>
 55<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
 56&nbsp;<A HREF="../../../com/google/tts/TTS.SpeechCompletedListener.html" title="interface in com.google.tts"><B>PREV CLASS</B></A>&nbsp;
 57&nbsp;<A HREF="../../../com/google/tts/TTSEngine.html" title="enum in com.google.tts"><B>NEXT CLASS</B></A></FONT></TD>
 58<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
 59  <A HREF="../../../index.html?com/google/tts/TTSEarcon.html" target="_top"><B>FRAMES</B></A>  &nbsp;
 60&nbsp;<A HREF="TTSEarcon.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
 61&nbsp;<SCRIPT type="text/javascript">
 62  <!--
 63  if(window==top) {
 64    document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>');
 65  }
 66  //-->
 67</SCRIPT>
 68<NOSCRIPT>
 69  <A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>
 70</NOSCRIPT>
 71
 72
 73</FONT></TD>
 74</TR>
 75<TR>
 76<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
 77  SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;<A HREF="#enum_constant_summary">ENUM CONSTANTS</A>&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
 78<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
 79DETAIL:&nbsp;<A HREF="#enum_constant_detail">ENUM CONSTANTS</A>&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
 80</TR>
 81</TABLE>
 82<A NAME="skip-navbar_top"></A>
 83<!-- ========= END OF TOP NAVBAR ========= -->
 84
 85<HR>
 86<!-- ======== START OF CLASS DATA ======== -->
 87<H2>
 88<FONT SIZE="-1">
 89com.google.tts</FONT>
 90<BR>
 91Enum TTSEarcon</H2>
 92<PRE>
 93java.lang.Object
 94  <IMG SRC="../../../resources/inherit.gif" ALT="extended by ">java.lang.Enum&lt;<A HREF="../../../com/google/tts/TTSEarcon.html" title="enum in com.google.tts">TTSEarcon</A>&gt;
 95      <IMG SRC="../../../resources/inherit.gif" ALT="extended by "><B>com.google.tts.TTSEarcon</B>
 96</PRE>
 97<DL>
 98<DT><B>All Implemented Interfaces:</B> <DD>java.io.Serializable, java.lang.Comparable&lt;<A HREF="../../../com/google/tts/TTSEarcon.html" title="enum in com.google.tts">TTSEarcon</A>&gt;</DD>
 99</DL>
100<HR>
101<DL>
102<DT><PRE>public enum <B>TTSEarcon</B><DT>extends java.lang.Enum&lt;<A HREF="../../../com/google/tts/TTSEarcon.html" title="enum in com.google.tts">TTSEarcon</A>&gt;</DL>
103</PRE>
104
105<P>
106Enumerates the possible earcons to pass to the TTS.
107<P>
108
109<P>
110<HR>
111
112<P>
113<!-- =========== ENUM CONSTANT SUMMARY =========== -->
114
115<A NAME="enum_constant_summary"><!-- --></A>
116<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
117<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
118<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
119<B>Enum Constant Summary</B></FONT></TH>
120</TR>
121<TR BGCOLOR="white" CLASS="TableRowColor">
122<TD><CODE><B><A HREF="../../../com/google/tts/TTSEarcon.html#CANCEL">CANCEL</A></B></CODE>
123
124<BR>
125&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
126</TR>
127<TR BGCOLOR="white" CLASS="TableRowColor">
128<TD><CODE><B><A HREF="../../../com/google/tts/TTSEarcon.html#SILENCE">SILENCE</A></B></CODE>
129
130<BR>
131&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
132</TR>
133<TR BGCOLOR="white" CLASS="TableRowColor">
134<TD><CODE><B><A HREF="../../../com/google/tts/TTSEarcon.html#TICK">TICK</A></B></CODE>
135
136<BR>
137&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
138</TR>
139<TR BGCOLOR="white" CLASS="TableRowColor">
140<TD><CODE><B><A HREF="../../../com/google/tts/TTSEarcon.html#TOCK">TOCK</A></B></CODE>
141
142<BR>
143&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
144</TR>
145</TABLE>
146&nbsp;
147<!-- ========== METHOD SUMMARY =========== -->
148
149<A NAME="method_summary"><!-- --></A>
150<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
151<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
152<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
153<B>Method Summary</B></FONT></TH>
154</TR>
155<TR BGCOLOR="white" CLASS="TableRowColor">
156<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
157<CODE>static&nbsp;<A HREF="../../../com/google/tts/TTSEarcon.html" title="enum in com.google.tts">TTSEarcon</A></CODE></FONT></TD>
158<TD><CODE><B><A HREF="../../../com/google/tts/TTSEarcon.html#valueOf(java.lang.String)">valueOf</A></B>(java.lang.String&nbsp;name)</CODE>
159
160<BR>
161&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the enum constant of this type with the specified name.</TD>
162</TR>
163<TR BGCOLOR="white" CLASS="TableRowColor">
164<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
165<CODE>static&nbsp;<A HREF="../../../com/google/tts/TTSEarcon.html" title="enum in com.google.tts">TTSEarcon</A>[]</CODE></FONT></TD>
166<TD><CODE><B><A HREF="../../../com/google/tts/TTSEarcon.html#values()">values</A></B>()</CODE>
167
168<BR>
169&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns an array containing the constants of this enum type, in
170the order they are declared.</TD>
171</TR>
172</TABLE>
173&nbsp;<A NAME="methods_inherited_from_class_java.lang.Enum"><!-- --></A>
174<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
175<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
176<TH ALIGN="left"><B>Methods inherited from class java.lang.Enum</B></TH>
177</TR>
178<TR BGCOLOR="white" CLASS="TableRowColor">
179<TD><CODE>clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf</CODE></TD>
180</TR>
181</TABLE>
182&nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
183<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
184<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
185<TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH>
186</TR>
187<TR BGCOLOR="white" CLASS="TableRowColor">
188<TD><CODE>getClass, notify, notifyAll, wait, wait, wait</CODE></TD>
189</TR>
190</TABLE>
191&nbsp;
192<P>
193
194<!-- ============ ENUM CONSTANT DETAIL =========== -->
195
196<A NAME="enum_constant_detail"><!-- --></A>
197<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
198<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
199<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
200<B>Enum Constant Detail</B></FONT></TH>
201</TR>
202</TABLE>
203
204<A NAME="SILENCE"><!-- --></A><H3>
205SILENCE</H3>
206<PRE>
207public static final <A HREF="../../../com/google/tts/TTSEarcon.html" title="enum in com.google.tts">TTSEarcon</A> <B>SILENCE</B></PRE>
208<DL>
209<DL>
210</DL>
211</DL>
212<HR>
213
214<A NAME="TICK"><!-- --></A><H3>
215TICK</H3>
216<PRE>
217public static final <A HREF="../../../com/google/tts/TTSEarcon.html" title="enum in com.google.tts">TTSEarcon</A> <B>TICK</B></PRE>
218<DL>
219<DL>
220</DL>
221</DL>
222<HR>
223
224<A NAME="TOCK"><!-- --></A><H3>
225TOCK</H3>
226<PRE>
227public static final <A HREF="../../../com/google/tts/TTSEarcon.html" title="enum in com.google.tts">TTSEarcon</A> <B>TOCK</B></PRE>
228<DL>
229<DL>
230</DL>
231</DL>
232<HR>
233
234<A NAME="CANCEL"><!-- --></A><H3>
235CANCEL</H3>
236<PRE>
237public static final <A HREF="../../../com/google/tts/TTSEarcon.html" title="enum in com.google.tts">TTSEarcon</A> <B>CANCEL</B></PRE>
238<DL>
239<DL>
240</DL>
241</DL>
242
243<!-- ============ METHOD DETAIL ========== -->
244
245<A NAME="method_detail"><!-- --></A>
246<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
247<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
248<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
249<B>Method Detail</B></FONT></TH>
250</TR>
251</TABLE>
252
253<A NAME="values()"><!-- --></A><H3>
254values</H3>
255<PRE>
256public static <A HREF="../../../com/google/tts/TTSEarcon.html" title="enum in com.google.tts">TTSEarcon</A>[] <B>values</B>()</PRE>
257<DL>
258<DD>Returns an array containing the constants of this enum type, in
259the order they are declared.  This method may be used to iterate
260over the constants as follows:
261<pre>
262for (TTSEarcon c : TTSEarcon.values())
263&nbsp;   System.out.println(c);
264</pre>
265<P>
266<DD><DL>
267
268<DT><B>Returns:</B><DD>an array containing the constants of this enum type, in
269the order they are declared</DL>
270</DD>
271</DL>
272<HR>
273
274<A NAME="valueOf(java.lang.String)"><!-- --></A><H3>
275valueOf</H3>
276<PRE>
277public static <A HREF="../../../com/google/tts/TTSEarcon.html" title="enum in com.google.tts">TTSEarcon</A> <B>valueOf</B>(java.lang.String&nbsp;name)</PRE>
278<DL>
279<DD>Returns the enum constant of this type with the specified name.
280The string must match <I>exactly</I> an identifier used to declare an
281enum constant in this type.  (Extraneous whitespace characters are 
282not permitted.)
283<P>
284<DD><DL>
285<DT><B>Parameters:</B><DD><CODE>name</CODE> - the name of the enum constant to be returned.
286<DT><B>Returns:</B><DD>the enum constant with the specified name
287<DT><B>Throws:</B>
288<DD><CODE>java.lang.IllegalArgumentException</CODE> - if this enum type has no constant
289with the specified name
290<DD><CODE>java.lang.NullPointerException</CODE> - if the argument is null</DL>
291</DD>
292</DL>
293<!-- ========= END OF CLASS DATA ========= -->
294<HR>
295
296
297<!-- ======= START OF BOTTOM NAVBAR ====== -->
298<A NAME="navbar_bottom"><!-- --></A>
299<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
300<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
301<TR>
302<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
303<A NAME="navbar_bottom_firstrow"><!-- --></A>
304<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
305  <TR ALIGN="center" VALIGN="top">
306  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../com/google/tts/package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
307  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
308  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
309  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
310  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
311  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
312  </TR>
313</TABLE>
314</TD>
315<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
316</EM>
317</TD>
318</TR>
319
320<TR>
321<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
322&nbsp;<A HREF="../../../com/google/tts/TTS.SpeechCompletedListener.html" title="interface in com.google.tts"><B>PREV CLASS</B></A>&nbsp;
323&nbsp;<A HREF="../../../com/google/tts/TTSEngine.html" title="enum in com.google.tts"><B>NEXT CLASS</B></A></FONT></TD>
324<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
325  <A HREF="../../../index.html?com/google/tts/TTSEarcon.html" target="_top"><B>FRAMES</B></A>  &nbsp;
326&nbsp;<A HREF="TTSEarcon.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
327&nbsp;<SCRIPT type="text/javascript">
328  <!--
329  if(window==top) {
330    document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>');
331  }
332  //-->
333</SCRIPT>
334<NOSCRIPT>
335  <A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>
336</NOSCRIPT>
337
338
339</FONT></TD>
340</TR>
341<TR>
342<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
343  SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;<A HREF="#enum_constant_summary">ENUM CONSTANTS</A>&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
344<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
345DETAIL:&nbsp;<A HREF="#enum_constant_detail">ENUM CONSTANTS</A>&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
346</TR>
347</TABLE>
348<A NAME="skip-navbar_bottom"></A>
349<!-- ======== END OF BOTTOM NAVBAR ======= -->
350
351<HR>
352
353</BODY>
354</HTML>