001// Copyright 2005 The Apache Software Foundation
002//
003// Licensed under the Apache License, Version 2.0 (the "License");
004// you may not use this file except in compliance with the License.
005// You may obtain a copy of the License at
006//
007//     http://www.apache.org/licenses/LICENSE-2.0
008//
009// Unless required by applicable law or agreed to in writing, software
010// distributed under the License is distributed on an "AS IS" BASIS,
011// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
012// See the License for the specific language governing permissions and
013// limitations under the License.
014
015package org.apache.tapestry.html;
016
017import org.apache.tapestry.AbstractComponent;
018import org.apache.tapestry.IMarkupWriter;
019import org.apache.tapestry.IRequestCycle;
020import org.apache.tapestry.describe.HTMLDescriber;
021
022/**
023 * Component that makes use of {@link org.apache.tapestry.describe.HTMLDescriber}to produce HTML
024 * output that describes an object.
025 * 
026 * @author Howard M. Lewis Ship
027 * @since 4.0
028 */
029public abstract class Describe extends AbstractComponent
030{
031    /**
032     * Parameter object: the object to be described.
033     */
034    public abstract Object getObject();
035
036    /**
037     * Injected service.
038     */
039    public abstract HTMLDescriber getDescriber();
040
041    protected void renderComponent(IMarkupWriter writer, IRequestCycle cycle)
042    {
043        if (cycle.isRewinding())
044            return;
045
046        getDescriber().describeObject(getObject(), writer);
047    }
048}