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