1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
\r
5 <!-- Generated by javadoc (build 1.4.2_16) on Mon Mar 09 18:20:29 CET 2009 -->
\r
7 SpeechEventWrapper (FreeTTS 1.2)
\r
10 <META NAME="keywords" CONTENT="com.sun.speech.engine.SpeechEventWrapper class">
\r
12 <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style">
\r
14 <SCRIPT type="text/javascript">
\r
15 function windowTitle()
\r
17 parent.document.title="SpeechEventWrapper (FreeTTS 1.2)";
\r
23 <BODY BGCOLOR="white" onload="windowTitle();">
\r
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
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> </TD>
\r
36 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
\r
37 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
\r
38 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
\r
39 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
\r
40 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
\r
41 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
\r
45 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
\r
51 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
\r
52 <A HREF="../../../../com/sun/speech/engine/SpeechEventUtilities.SpeechAWTEventTarget.html" title="class in com.sun.speech.engine"><B>PREV CLASS</B></A>
\r
53 NEXT CLASS</FONT></TD>
\r
54 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
\r
55 <A HREF="../../../../index.html" target="_top"><B>FRAMES</B></A>
\r
56 <A HREF="SpeechEventWrapper.html" target="_top"><B>NO FRAMES</B></A>
\r
57 <SCRIPT type="text/javascript">
\r
60 document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
\r
65 <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
\r
71 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
\r
72 SUMMARY: NESTED | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
\r
73 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
\r
74 DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
\r
77 <A NAME="skip-navbar_top"></A>
78 <!-- ========= END OF TOP NAVBAR ========= -->
\r
81 <!-- ======== START OF CLASS DATA ======== -->
\r
84 com.sun.speech.engine</FONT>
\r
86 Class SpeechEventWrapper</H2>
\r
89 <IMG SRC="../../../../resources/inherit.gif" ALT="extended by">java.util.EventObject
\r
90 <IMG SRC="../../../../resources/inherit.gif" ALT="extended by">javax.speech.SpeechEvent
\r
91 <IMG SRC="../../../../resources/inherit.gif" ALT="extended by"><B>com.sun.speech.engine.SpeechEventWrapper</B>
\r
94 <DT><B>All Implemented Interfaces:</B> <DD>java.io.Serializable</DD>
\r
98 <DT>public class <B>SpeechEventWrapper</B><DT>extends javax.speech.SpeechEvent</DL>
\r
101 Wraps an arbitrary event object (from <code>EventObject</code>)
102 in a <code>SpeechEvent</code> so that it can be dispatched through
103 the speech event dispatch mechanism.
104 One use of this is in the <code>BaseEngineProperties</code> class
105 that needs to wrap and issue <code>PropertyChangeEvents</code>.
\r
110 <DT><B>See Also:</B><DD><A HREF="../../../../com/sun/speech/engine/SpeechEventUtilities.html" title="class in com.sun.speech.engine"><CODE>SpeechEventUtilities</CODE></A>,
111 <CODE>EventObject</CODE>,
112 <A HREF="../../../../serialized-form.html#com.sun.speech.engine.SpeechEventWrapper">Serialized Form</A></DL>
\r
116 <!-- ======== NESTED CLASS SUMMARY ======== -->
\r
119 <!-- =========== FIELD SUMMARY =========== -->
\r
121 <A NAME="field_summary"><!-- --></A>
122 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
\r
123 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
\r
124 <TD COLSPAN=2><FONT SIZE="+2">
\r
125 <B>Field Summary</B></FONT></TD>
\r
127 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
128 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
129 <CODE>protected java.util.EventObject</CODE></FONT></TD>
\r
130 <TD><CODE><B><A HREF="../../../../com/sun/speech/engine/SpeechEventWrapper.html#eventObject">eventObject</A></B></CODE>
\r
133 The wrapped event.</TD>
\r
135 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
136 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
137 <CODE>protected static int</CODE></FONT></TD>
\r
138 <TD><CODE><B><A HREF="../../../../com/sun/speech/engine/SpeechEventWrapper.html#WRAPPER_ID">WRAPPER_ID</A></B></CODE>
\r
141 Use an id that won't be confused with JSAPI event ids.</TD>
\r
144 <A NAME="fields_inherited_from_class_javax.speech.SpeechEvent"><!-- --></A>
145 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
\r
146 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
\r
147 <TD><B>Fields inherited from class javax.speech.SpeechEvent</B></TD>
\r
149 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
150 <TD><CODE>id</CODE></TD>
\r
153 <A NAME="fields_inherited_from_class_java.util.EventObject"><!-- --></A>
154 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
\r
155 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
\r
156 <TD><B>Fields inherited from class java.util.EventObject</B></TD>
\r
158 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
159 <TD><CODE>source</CODE></TD>
\r
163 <!-- ======== CONSTRUCTOR SUMMARY ======== -->
\r
165 <A NAME="constructor_summary"><!-- --></A>
166 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
\r
167 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
\r
168 <TD COLSPAN=2><FONT SIZE="+2">
\r
169 <B>Constructor Summary</B></FONT></TD>
\r
171 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
172 <TD><CODE><B><A HREF="../../../../com/sun/speech/engine/SpeechEventWrapper.html#SpeechEventWrapper(java.util.EventObject)">SpeechEventWrapper</A></B>(java.util.EventObject e)</CODE>
\r
175 Class constructor.</TD>
\r
179 <!-- ========== METHOD SUMMARY =========== -->
\r
181 <A NAME="method_summary"><!-- --></A>
182 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
\r
183 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
\r
184 <TD COLSPAN=2><FONT SIZE="+2">
\r
185 <B>Method Summary</B></FONT></TD>
\r
187 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
188 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
189 <CODE> java.util.EventObject</CODE></FONT></TD>
\r
190 <TD><CODE><B><A HREF="../../../../com/sun/speech/engine/SpeechEventWrapper.html#getEventObject()">getEventObject</A></B>()</CODE>
\r
193 Gets the wrapped event.</TD>
\r
196 <A NAME="methods_inherited_from_class_javax.speech.SpeechEvent"><!-- --></A>
197 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
\r
198 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
\r
199 <TD><B>Methods inherited from class javax.speech.SpeechEvent</B></TD>
\r
201 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
202 <TD><CODE>getId, paramString, toString</CODE></TD>
\r
205 <A NAME="methods_inherited_from_class_java.util.EventObject"><!-- --></A>
206 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
\r
207 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
\r
208 <TD><B>Methods inherited from class java.util.EventObject</B></TD>
\r
210 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
211 <TD><CODE>getSource</CODE></TD>
\r
214 <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
215 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
\r
216 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
\r
217 <TD><B>Methods inherited from class java.lang.Object</B></TD>
\r
219 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
220 <TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait</CODE></TD>
\r
226 <!-- ============ FIELD DETAIL =========== -->
\r
228 <A NAME="field_detail"><!-- --></A>
229 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
\r
230 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
\r
231 <TD COLSPAN=1><FONT SIZE="+2">
\r
232 <B>Field Detail</B></FONT></TD>
\r
236 <A NAME="WRAPPER_ID"><!-- --></A><H3>
\r
239 protected static int <B>WRAPPER_ID</B></PRE>
\r
241 <DD>Use an id that won't be confused with JSAPI event ids.
\r
248 <A NAME="eventObject"><!-- --></A><H3>
\r
251 protected java.util.EventObject <B>eventObject</B></PRE>
\r
253 <DD>The wrapped event.
\r
259 <!-- ========= CONSTRUCTOR DETAIL ======== -->
\r
261 <A NAME="constructor_detail"><!-- --></A>
262 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
\r
263 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
\r
264 <TD COLSPAN=1><FONT SIZE="+2">
\r
265 <B>Constructor Detail</B></FONT></TD>
\r
269 <A NAME="SpeechEventWrapper(java.util.EventObject)"><!-- --></A><H3>
\r
270 SpeechEventWrapper</H3>
\r
272 public <B>SpeechEventWrapper</B>(java.util.EventObject e)</PRE>
\r
274 <DD>Class constructor.
\r
276 <DT><B>Parameters:</B><DD><CODE>e</CODE> - the <code>EventObject</code> to wrap.</DL>
\r
278 <!-- ============ METHOD DETAIL ========== -->
\r
280 <A NAME="method_detail"><!-- --></A>
281 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
\r
282 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
\r
283 <TD COLSPAN=1><FONT SIZE="+2">
\r
284 <B>Method Detail</B></FONT></TD>
\r
288 <A NAME="getEventObject()"><!-- --></A><H3>
\r
289 getEventObject</H3>
\r
291 public java.util.EventObject <B>getEventObject</B>()</PRE>
\r
293 <DD>Gets the wrapped event.
\r
297 <DT><B>Returns:</B><DD>the event that was passed to the constructor</DL>
\r
300 <!-- ========= END OF CLASS DATA ========= -->
\r
304 <!-- ======= START OF BOTTOM NAVBAR ====== -->
\r
305 <A NAME="navbar_bottom"><!-- --></A>
306 <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
307 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
\r
309 <TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
\r
310 <A NAME="navbar_bottom_firstrow"><!-- --></A>
311 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
\r
312 <TR ALIGN="center" VALIGN="top">
\r
313 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
\r
314 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
\r
315 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
\r
316 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
\r
317 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
\r
318 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
\r
319 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
\r
323 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
\r
329 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
\r
330 <A HREF="../../../../com/sun/speech/engine/SpeechEventUtilities.SpeechAWTEventTarget.html" title="class in com.sun.speech.engine"><B>PREV CLASS</B></A>
\r
331 NEXT CLASS</FONT></TD>
\r
332 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
\r
333 <A HREF="../../../../index.html" target="_top"><B>FRAMES</B></A>
\r
334 <A HREF="SpeechEventWrapper.html" target="_top"><B>NO FRAMES</B></A>
\r
335 <SCRIPT type="text/javascript">
\r
338 document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
\r
343 <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
\r
349 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
\r
350 SUMMARY: NESTED | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
\r
351 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
\r
352 DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
\r
355 <A NAME="skip-navbar_bottom"></A>
356 <!-- ======== END OF BOTTOM NAVBAR ======= -->
\r