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