Classes in this File | Line Coverage | Branch Coverage | Complexity | ||||
ListenerInvoker |
|
| 1.0;1 |
1 | // Copyright 2005 The Apache Software Foundation | |
2 | // | |
3 | // Licensed under the Apache License, Version 2.0 (the "License"); | |
4 | // you may not use this file except in compliance with the License. | |
5 | // You may obtain a copy of the License at | |
6 | // | |
7 | // http://www.apache.org/licenses/LICENSE-2.0 | |
8 | // | |
9 | // Unless required by applicable law or agreed to in writing, software | |
10 | // distributed under the License is distributed on an "AS IS" BASIS, | |
11 | // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | |
12 | // See the License for the specific language governing permissions and | |
13 | // limitations under the License. | |
14 | ||
15 | package org.apache.tapestry.listener; | |
16 | ||
17 | import org.apache.tapestry.IActionListener; | |
18 | import org.apache.tapestry.IComponent; | |
19 | import org.apache.tapestry.IRequestCycle; | |
20 | ||
21 | /** | |
22 | * Pipeline service interface for the tapestry.listener.ListenerInvoker pipeline service. | |
23 | * | |
24 | * @author Howard M. Lewis Ship | |
25 | * @since 4.0 | |
26 | * @see org.apache.tapestry.listener.ListenerInvokerFilter | |
27 | */ | |
28 | public interface ListenerInvoker | |
29 | { | |
30 | /** | |
31 | * Part of the pipeline for invoking the given listener object. This may be supplemented by | |
32 | * various filters. | |
33 | * | |
34 | * @param listener | |
35 | * to be invoked, may be null if no listener is found (a convienience for all the | |
36 | * places where listeners are optional) | |
37 | * @param source | |
38 | * the component generating the listener "event", to be passed to the listener. Not | |
39 | * generally used, but may not be null. | |
40 | * @param cycle | |
41 | * the current request cycle, to be passed to the listener. | |
42 | */ | |
43 | ||
44 | void invokeListener(IActionListener listener, IComponent source, IRequestCycle cycle); | |
45 | } |