/[debian]/libspin-java/branches/upstream/current/docs/api/spin/off/ListenerSpinOver.html
ViewVC logotype

Contents of /libspin-java/branches/upstream/current/docs/api/spin/off/ListenerSpinOver.html

Parent Directory Parent Directory | Revision Log Revision Log


Revision 376 - (show annotations)
Fri Sep 29 21:09:27 2006 UTC (14 years, 10 months ago) by gregoa
File MIME type: text/html
File size: 14509 byte(s)
[svn-inject] Installing original source of libspin-java
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.4.2_01) on Tue Oct 18 20:10:26 CEST 2005 -->
6 <TITLE>
7 ListenerSpinOver
8 </TITLE>
9
10 <META NAME="keywords" CONTENT="spin.off.ListenerSpinOver class">
11
12 <LINK REL ="stylesheet" TYPE="text/css" HREF="../../stylesheet.css" TITLE="Style">
13
14 <SCRIPT type="text/javascript">
15 function windowTitle()
16 {
17 parent.document.title="ListenerSpinOver";
18 }
19 </SCRIPT>
20
21 </HEAD>
22
23 <BODY BGCOLOR="white" onload="windowTitle();">
24
25
26 <!-- ========= START OF TOP NAVBAR ======= -->
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="">
30 <TR>
31 <TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
32 <A NAME="navbar_top_firstrow"><!-- --></A>
33 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
34 <TR ALIGN="center" VALIGN="top">
35 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
36 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
37 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
38 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
39 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
40 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
41 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
42 </TR>
43 </TABLE>
44 </TD>
45 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
46 </EM>
47 </TD>
48 </TR>
49
50 <TR>
51 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
52 &nbsp;<A HREF="../../spin/off/InternalOptionPaneDispatcherFactory.html" title="class in spin.off"><B>PREV CLASS</B></A>&nbsp;
53 &nbsp;<A HREF="../../spin/off/SimpleStarter.html" title="class in spin.off"><B>NEXT CLASS</B></A></FONT></TD>
54 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
55 <A HREF="../../index.html" target="_top"><B>FRAMES</B></A> &nbsp;
56 &nbsp;<A HREF="ListenerSpinOver.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
57 &nbsp;<SCRIPT type="text/javascript">
58 <!--
59 if(window==top) {
60 document.writeln('<A HREF="../../allclasses-noframe.html"><B>All Classes</B></A>');
61 }
62 //-->
63 </SCRIPT>
64 <NOSCRIPT>
65 <A HREF="../../allclasses-noframe.html"><B>All Classes</B></A>
66 </NOSCRIPT>
67
68 </FONT></TD>
69 </TR>
70 <TR>
71 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
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>
73 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
74 DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
75 </TR>
76 </TABLE>
77 <A NAME="skip-navbar_top"></A>
78 <!-- ========= END OF TOP NAVBAR ========= -->
79
80 <HR>
81 <!-- ======== START OF CLASS DATA ======== -->
82 <H2>
83 <FONT SIZE="-1">
84 spin.off</FONT>
85 <BR>
86 Class ListenerSpinOver</H2>
87 <PRE>
88 java.lang.Object
89 <IMG SRC="../../resources/inherit.gif" ALT="extended by"><A HREF="../../spin/Evaluator.html" title="class in spin">spin.Evaluator</A>
90 <IMG SRC="../../resources/inherit.gif" ALT="extended by"><B>spin.off.ListenerSpinOver</B>
91 </PRE>
92 <HR>
93 <DL>
94 <DT>public class <B>ListenerSpinOver</B><DT>extends <A HREF="../../spin/Evaluator.html" title="class in spin">Evaluator</A></DL>
95
96 <P>
97 An evaluator for spin-off that automatically spins-over all
98 arguments of a <A HREF="../../spin/off/SpinOffEvaluator.html" title="class in spin.off"><CODE>SpinOffEvaluator</CODE></A> if their corresponding parameter
99 types are subinterfaces of <code>java.util.EventListener</code>.
100 <br>
101 Use an instance of this class on construction of a <em>Spin</em> object
102 or install it globally by calling the static method:
103 <pre>
104 Spin.setDefaultOffEvaluator(new ListenerSpinOver());
105 </pre>
106 <P>
107
108 <P>
109 <DL>
110 <DT><B>See Also:</B><DD><A HREF="../../spin/off/ListenerSpinOver.html#isListenerAdditionOrRemoval(java.lang.reflect.Method)"><CODE>isListenerAdditionOrRemoval(java.lang.reflect.Method)</CODE></A>,
111 <A HREF="../../spin/off/ListenerSpinOver.html#isListener(java.lang.Class)"><CODE>isListener(java.lang.Class)</CODE></A></DL>
112 <HR>
113
114 <P>
115 <!-- ======== NESTED CLASS SUMMARY ======== -->
116
117
118 <!-- =========== FIELD SUMMARY =========== -->
119
120
121 <!-- ======== CONSTRUCTOR SUMMARY ======== -->
122
123 <A NAME="constructor_summary"><!-- --></A>
124 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
125 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
126 <TD COLSPAN=2><FONT SIZE="+2">
127 <B>Constructor Summary</B></FONT></TD>
128 </TR>
129 <TR BGCOLOR="white" CLASS="TableRowColor">
130 <TD><CODE><B><A HREF="../../spin/off/ListenerSpinOver.html#ListenerSpinOver()">ListenerSpinOver</A></B>()</CODE>
131
132 <BR>
133 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
134 </TR>
135 <TR BGCOLOR="white" CLASS="TableRowColor">
136 <TD><CODE><B><A HREF="../../spin/off/ListenerSpinOver.html#ListenerSpinOver(spin.Evaluator)">ListenerSpinOver</A></B>(<A HREF="../../spin/Evaluator.html" title="class in spin">Evaluator</A>&nbsp;evaluator)</CODE>
137
138 <BR>
139 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
140 </TR>
141 </TABLE>
142 &nbsp;
143 <!-- ========== METHOD SUMMARY =========== -->
144
145 <A NAME="method_summary"><!-- --></A>
146 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
147 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
148 <TD COLSPAN=2><FONT SIZE="+2">
149 <B>Method Summary</B></FONT></TD>
150 </TR>
151 <TR BGCOLOR="white" CLASS="TableRowColor">
152 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
153 <CODE>&nbsp;void</CODE></FONT></TD>
154 <TD><CODE><B><A HREF="../../spin/off/ListenerSpinOver.html#evaluate(spin.Invocation)">evaluate</A></B>(<A HREF="../../spin/Invocation.html" title="class in spin">Invocation</A>&nbsp;invocation)</CODE>
155
156 <BR>
157 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Evaluate the given invocation.</TD>
158 </TR>
159 <TR BGCOLOR="white" CLASS="TableRowColor">
160 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
161 <CODE>protected &nbsp;boolean</CODE></FONT></TD>
162 <TD><CODE><B><A HREF="../../spin/off/ListenerSpinOver.html#isListener(java.lang.Class)">isListener</A></B>(java.lang.Class&nbsp;type)</CODE>
163
164 <BR>
165 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Test if the given class is a listener subinterface.</TD>
166 </TR>
167 <TR BGCOLOR="white" CLASS="TableRowColor">
168 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
169 <CODE>protected &nbsp;boolean</CODE></FONT></TD>
170 <TD><CODE><B><A HREF="../../spin/off/ListenerSpinOver.html#isListenerAdditionOrRemoval(java.lang.reflect.Method)">isListenerAdditionOrRemoval</A></B>(java.lang.reflect.Method&nbsp;method)</CODE>
171
172 <BR>
173 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Test if the given method is a listener addition or removal. </TD>
174 </TR>
175 <TR BGCOLOR="white" CLASS="TableRowColor">
176 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
177 <CODE>protected &nbsp;java.lang.Object</CODE></FONT></TD>
178 <TD><CODE><B><A HREF="../../spin/off/ListenerSpinOver.html#spinOver(java.lang.Object)">spinOver</A></B>(java.lang.Object&nbsp;object)</CODE>
179
180 <BR>
181 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Spin-over the given object.</TD>
182 </TR>
183 </TABLE>
184 &nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
185 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
186 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
187 <TD><B>Methods inherited from class java.lang.Object</B></TD>
188 </TR>
189 <TR BGCOLOR="white" CLASS="TableRowColor">
190 <TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
191 </TR>
192 </TABLE>
193 &nbsp;
194 <P>
195
196 <!-- ============ FIELD DETAIL =========== -->
197
198
199 <!-- ========= CONSTRUCTOR DETAIL ======== -->
200
201 <A NAME="constructor_detail"><!-- --></A>
202 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
203 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
204 <TD COLSPAN=1><FONT SIZE="+2">
205 <B>Constructor Detail</B></FONT></TD>
206 </TR>
207 </TABLE>
208
209 <A NAME="ListenerSpinOver()"><!-- --></A><H3>
210 ListenerSpinOver</H3>
211 <PRE>
212 public <B>ListenerSpinOver</B>()</PRE>
213 <DL>
214 </DL>
215 <HR>
216
217 <A NAME="ListenerSpinOver(spin.Evaluator)"><!-- --></A><H3>
218 ListenerSpinOver</H3>
219 <PRE>
220 public <B>ListenerSpinOver</B>(<A HREF="../../spin/Evaluator.html" title="class in spin">Evaluator</A>&nbsp;evaluator)</PRE>
221 <DL>
222 </DL>
223
224 <!-- ============ METHOD DETAIL ========== -->
225
226 <A NAME="method_detail"><!-- --></A>
227 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
228 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
229 <TD COLSPAN=1><FONT SIZE="+2">
230 <B>Method Detail</B></FONT></TD>
231 </TR>
232 </TABLE>
233
234 <A NAME="evaluate(spin.Invocation)"><!-- --></A><H3>
235 evaluate</H3>
236 <PRE>
237 public void <B>evaluate</B>(<A HREF="../../spin/Invocation.html" title="class in spin">Invocation</A>&nbsp;invocation)
238 throws java.lang.Throwable</PRE>
239 <DL>
240 <DD><B>Description copied from class: <CODE><A HREF="../../spin/Evaluator.html" title="class in spin">Evaluator</A></CODE></B></DD>
241 <DD>Evaluate the given invocation.
242 <P>
243 <DD><DL>
244 <DT><B>Specified by:</B><DD><CODE><A HREF="../../spin/Evaluator.html#evaluate(spin.Invocation)">evaluate</A></CODE> in class <CODE><A HREF="../../spin/Evaluator.html" title="class in spin">Evaluator</A></CODE></DL>
245 </DD>
246 <DD><DL>
247 <DT><B>Parameters:</B><DD><CODE>invocation</CODE> - invocation to evaluate
248 <DT><B>Throws:</B>
249 <DD><CODE>java.lang.Throwable</CODE></DL>
250 </DD>
251 </DL>
252 <HR>
253
254 <A NAME="isListenerAdditionOrRemoval(java.lang.reflect.Method)"><!-- --></A><H3>
255 isListenerAdditionOrRemoval</H3>
256 <PRE>
257 protected boolean <B>isListenerAdditionOrRemoval</B>(java.lang.reflect.Method&nbsp;method)</PRE>
258 <DL>
259 <DD>Test if the given method is a listener addition or removal. For this the
260 methods name must obey the name pattern <code>(add|remove).*Listener</code>.
261 <P>
262 <DD><DL>
263 <DT><B>Parameters:</B><DD><CODE>method</CODE> - method to test
264 <DT><B>Returns:</B><DD><code>true</code> if method obeys the name pattern of
265 listener addition or removal</DL>
266 </DD>
267 </DL>
268 <HR>
269
270 <A NAME="isListener(java.lang.Class)"><!-- --></A><H3>
271 isListener</H3>
272 <PRE>
273 protected boolean <B>isListener</B>(java.lang.Class&nbsp;type)</PRE>
274 <DL>
275 <DD>Test if the given class is a listener subinterface.
276 <P>
277 <DD><DL>
278 <DT><B>Parameters:</B><DD><CODE>type</CODE> - class to test
279 <DT><B>Returns:</B><DD><code>true</code> if the class is an sub-interface of
280 <code>java.util.EventListener</code></DL>
281 </DD>
282 </DL>
283 <HR>
284
285 <A NAME="spinOver(java.lang.Object)"><!-- --></A><H3>
286 spinOver</H3>
287 <PRE>
288 protected java.lang.Object <B>spinOver</B>(java.lang.Object&nbsp;object)</PRE>
289 <DL>
290 <DD>Spin-over the given object.
291 <P>
292 <DD><DL>
293 <DT><B>Parameters:</B><DD><CODE>object</CODE> - object to spin-over
294 <DT><B>Returns:</B><DD><em>Spin</em> proxy</DL>
295 </DD>
296 </DL>
297 <!-- ========= END OF CLASS DATA ========= -->
298 <HR>
299
300
301 <!-- ======= START OF BOTTOM NAVBAR ====== -->
302 <A NAME="navbar_bottom"><!-- --></A>
303 <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
304 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
305 <TR>
306 <TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
307 <A NAME="navbar_bottom_firstrow"><!-- --></A>
308 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
309 <TR ALIGN="center" VALIGN="top">
310 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
311 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
312 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
313 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
314 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
315 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
316 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
317 </TR>
318 </TABLE>
319 </TD>
320 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
321 </EM>
322 </TD>
323 </TR>
324
325 <TR>
326 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
327 &nbsp;<A HREF="../../spin/off/InternalOptionPaneDispatcherFactory.html" title="class in spin.off"><B>PREV CLASS</B></A>&nbsp;
328 &nbsp;<A HREF="../../spin/off/SimpleStarter.html" title="class in spin.off"><B>NEXT CLASS</B></A></FONT></TD>
329 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
330 <A HREF="../../index.html" target="_top"><B>FRAMES</B></A> &nbsp;
331 &nbsp;<A HREF="ListenerSpinOver.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
332 &nbsp;<SCRIPT type="text/javascript">
333 <!--
334 if(window==top) {
335 document.writeln('<A HREF="../../allclasses-noframe.html"><B>All Classes</B></A>');
336 }
337 //-->
338 </SCRIPT>
339 <NOSCRIPT>
340 <A HREF="../../allclasses-noframe.html"><B>All Classes</B></A>
341 </NOSCRIPT>
342
343 </FONT></TD>
344 </TR>
345 <TR>
346 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
347 SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
348 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
349 DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
350 </TR>
351 </TABLE>
352 <A NAME="skip-navbar_bottom"></A>
353 <!-- ======== END OF BOTTOM NAVBAR ======= -->
354
355 <HR>
356
357 </BODY>
358 </HTML>

  ViewVC Help
Powered by ViewVC 1.1.26