IPropertySelectionRenderer


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