001    // Copyright 2004, 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.form;
016    
017    import org.apache.tapestry.IMarkupWriter;
018    import org.apache.tapestry.IRequestCycle;
019    
020    /**
021     * Defines an object that works with a {@link PropertySelection} component to
022     * render the individual elements obtained from the
023     * {@link IPropertySelectionModel model}.
024     * 
025     * @author Howard Lewis Ship
026     */
027    
028    public interface IPropertySelectionRenderer
029    {
030    
031        /**
032         * Begins the rendering of the {@link PropertySelection}.
033         */
034    
035        void beginRender(PropertySelection component, IMarkupWriter writer,
036                IRequestCycle cycle);
037    
038        /**
039         * Invoked for each element obtained from the
040         * {@link IPropertySelectionModel model}.
041         */
042    
043        void renderOption(PropertySelection component, IMarkupWriter writer,
044                IRequestCycle cycle, IPropertySelectionModel model, Object option,
045                int index, boolean selected);
046    
047        /**
048         * Ends the rendering of the {@link PropertySelection}.
049         */
050    
051        void endRender(PropertySelection component, IMarkupWriter writer,
052                IRequestCycle cycle);
053    }