KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > tapestry > link > ILinkRenderer


1 // Copyright 2004, 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.link;
16
17 import org.apache.tapestry.IMarkupWriter;
18 import org.apache.tapestry.IRequestCycle;
19 import org.apache.tapestry.components.ILinkComponent;
20
21 /**
22  * Used by various instances of {@link org.apache.tapestry.components.ILinkComponent} to
23  * actually renderer a link. Implementations of the interface can manipulate
24  * some of the details of how the link is written.
25  *
26  * <p>
27  * A link rendered may be used in many threads, and must be threadsafe.
28  *
29  * @author Howard Lewis Ship
30  * @since 3.0
31  *
32  **/
33
34 public interface ILinkRenderer
35 {
36     /**
37      * Renders the link, taking into account whether the link is
38      * {@link org.apache.tapestry.components.ILinkComponent#isDisabled() disabled}.
39      * This is complicated by the fact that the rendering of the body must be done
40      * within a nested writer, since the Link component will not render its tag
41      * until after its body renders (to allow for any wrapped components that need
42      * to write event handlers for the link).
43      *
44      * <p>
45      * The renderer is expected to call back into the link component to handle
46      * any informal parameters, and to handle events output.
47      *
48      *
49      **/
50
51     public void renderLink(IMarkupWriter writer, IRequestCycle cycle, ILinkComponent linkComponent);
52
53 }
54
Popular Tags