KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > tapestry > IRender


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;
16
17 /**
18  * An element that may be asked to render itself to an
19  * {@link IMarkupWriter} using a {@link IRequestCycle}.
20  *
21  * <p>This primarily includes {@link IComponent} and {@link IPage},
22  * but also extends to other things, such as objects responsible for
23  * rendering static markup text.
24  *
25  * @author Howard Lewis Ship
26  *
27  **/
28
29 public interface IRender
30 {
31     /**
32      * The principal rendering/rewinding method. This will cause
33      * the receiving component to render its top level elements (HTML
34      * text and components).
35      *
36      * <p>Renderring and rewinding are the exact same process. The
37      * same code that renders must be able to restore state by going
38      * through the exact same operations (even though the output is
39      * discarded).
40      *
41      **/
42
43     public void render(IMarkupWriter writer, IRequestCycle cycle);
44 }
Popular Tags