KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > tapestry > html > Describe


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.html;
16
17 import org.apache.tapestry.AbstractComponent;
18 import org.apache.tapestry.IMarkupWriter;
19 import org.apache.tapestry.IRequestCycle;
20 import org.apache.tapestry.describe.HTMLDescriber;
21
22 /**
23  * Component that makes use of {@link org.apache.tapestry.describe.HTMLDescriber}to produce HTML
24  * output that describes an object.
25  *
26  * @author Howard M. Lewis Ship
27  * @since 4.0
28  */
29 public abstract class Describe extends AbstractComponent
30 {
31     /**
32      * Parameter object: the object to be described.
33      */
34     public abstract Object JavaDoc getObject();
35
36     /**
37      * Injected service.
38      */
39     public abstract HTMLDescriber getDescriber();
40
41     protected void renderComponent(IMarkupWriter writer, IRequestCycle cycle)
42     {
43         if (cycle.isRewinding())
44             return;
45
46         getDescriber().describeObject(getObject(), writer);
47     }
48 }
Popular Tags