IMultiplePropertySelectionRenderer


1   // Copyright 2004, 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.contrib.form;
16  
17  import org.apache.tapestry.IMarkupWriter;
18  import org.apache.tapestry.IRequestCycle;
19  import org.apache.tapestry.form.IPropertySelectionModel;
20  
21  /**
22   *  Defines an object that works with a {@link MultiplePropertySelection} component
23   *  to render the individual elements obtained from the {@link IPropertySelectionModel model}.
24   *
25   *  @author Sanjay Munjal
26   *
27   **/
28  
29  public interface IMultiplePropertySelectionRenderer
30  {
31      /**
32       *  Begins the rendering of the {@link MultiplePropertySelection}.
33       *
34       **/
35  
36      public void beginRender(
37          MultiplePropertySelection component,
38          IMarkupWriter writer,
39          IRequestCycle cycle);
40  
41      /**
42       *  Invoked for each element obtained from the {@link IPropertySelectionModel model}.
43       *
44       **/
45  
46      public void renderOption(
47          MultiplePropertySelection component,
48          IMarkupWriter writer,
49          IRequestCycle cycle,
50          IPropertySelectionModel model,
51          Object   option,
52          int index,
53          boolean selected);
54  
55      /**
56       *  Ends the rendering of the {@link MultiplePropertySelection}.
57       *
58       **/
59  
60      public void endRender(
61          MultiplePropertySelection component,
62          IMarkupWriter writer,
63          IRequestCycle cycle);
64  }
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags