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    
015    package org.apache.tapestry.html;
016    
017    import org.apache.tapestry.AbstractComponent;
018    import org.apache.tapestry.IMarkupWriter;
019    import org.apache.tapestry.IRequestCycle;
020    import org.apache.tapestry.describe.HTMLDescriber;
021    
022    /**
023     * Component that makes use of
024     * {@link org.apache.tapestry.describe.HTMLDescriber}to produce HTML output
025     * that describes an object.
026     * 
027     * @author Howard M. Lewis Ship
028     * @since 4.0
029     */
030    public abstract class Describe extends AbstractComponent
031    {
032    
033        /**
034         * Parameter object: the object to be described.
035         */
036        public abstract Object getObject();
037    
038        /**
039         * Injected service.
040         */
041        public abstract HTMLDescriber getDescriber();
042    
043        protected void renderComponent(IMarkupWriter writer, IRequestCycle cycle)
044        {
045            if (cycle.isRewinding()) return;
046    
047            getDescriber().describeObject(getObject(), writer);
048        }
049    }