Classes in this File | Line Coverage | Branch Coverage | Complexity | ||||||
Component |
|
| 1.0;1 |
1 | package org.apache.tapestry.internal; |
|
2 | ||
3 | import org.apache.tapestry.IRender; |
|
4 | ||
5 | /** |
|
6 | * Represents the <em>internal</em> component api exposed for use by core framework code only. |
|
7 | * |
|
8 | * <p> |
|
9 | * Use at your own risk as everything in this API is subject to change without notice from release to |
|
10 | * release. |
|
11 | * </p> |
|
12 | */ |
|
13 | public interface Component { |
|
14 | ||
15 | /** |
|
16 | * Returns the list of of {@link IRender} elements contained by this component. Ie whatever |
|
17 | * has been added via {@link org.apache.tapestry.IComponent#addBody(IRender)}. |
|
18 | * |
|
19 | * @return The values, if any. Null otherwise. |
|
20 | */ |
|
21 | IRender[] getContainedRenderers(); |
|
22 | ||
23 | /** |
|
24 | * In some rare cases a component has both outer and inner renderers - such as with {@link org.apache.tapestry.BaseComponent}. This |
|
25 | * value should return the normal inner renderers most components do in those instances while the other |
|
26 | * {@link #getContainedRenderers()} should return the outer renderers. |
|
27 | * |
|
28 | * @return The inner renderers if this component supports more than one type, null otherwise. |
|
29 | */ |
|
30 | IRender[] getInnerRenderers(); |
|
31 | ||
32 | /** |
|
33 | * Checks if this component has been targeted / connected to for client side |
|
34 | * event listening via @EventListener. |
|
35 | * |
|
36 | * @return True if anything has targeted this component, false otherwise. |
|
37 | */ |
|
38 | boolean hasEvents(); |
|
39 | ||
40 | /** |
|
41 | * Sets whether or not this component has events. |
|
42 | * |
|
43 | * @param hasEvents Whether or not this component has connected events. |
|
44 | */ |
|
45 | void setHasEvents(boolean hasEvents); |
|
46 | } |