Classes in this File | Line Coverage | Branch Coverage | Complexity | ||||||
ListItemRenderer |
|
| 1.0;1 |
1 | package org.apache.tapestry.scriptaculous; |
|
2 | ||
3 | import org.apache.tapestry.IMarkupWriter; |
|
4 | import org.apache.tapestry.IRequestCycle; |
|
5 | ||
6 | import java.util.Iterator; |
|
7 | ||
8 | /** |
|
9 | * Renderer used by {@link Suggest} component to render lists usable |
|
10 | * by the currently integrated |
|
11 | * <a href="http://wiki.script.aculo.us/scriptaculous/show/Ajax.Autocompleter">script.aculo.us</a> |
|
12 | * javascript library. |
|
13 | * |
|
14 | * <p/>This particular library expects the rendered contents of this class to |
|
15 | * be an unordered html list. |
|
16 | * <p/> |
|
17 | * <pre> |
|
18 | * <ul> |
|
19 | * <li>Apple</li> |
|
20 | * <li>Apricot</li> |
|
21 | * </ul> |
|
22 | * </pre> |
|
23 | */ |
|
24 | public interface ListItemRenderer { |
|
25 | ||
26 | /** |
|
27 | * Renders an unordered html list to the response, using the specified |
|
28 | * collection of values as the contents to fill in the <pre><li></pre> elements |
|
29 | * with. |
|
30 | * |
|
31 | * @param writer |
|
32 | * Markup writer to write content in to. |
|
33 | * @param cycle |
|
34 | * Current request cycle. |
|
35 | * @param values |
|
36 | * Values used to render list. |
|
37 | */ |
|
38 | public void renderList(IMarkupWriter writer, IRequestCycle cycle, Iterator values); |
|
39 | } |
|
40 |