|
|||||||||||||||||||
30 day Evaluation License registered to hlship@comcast.net Your 30 day evaluation period has expired. Please visit http://www.cenqua.com to obtain a licensed version of Clover | |||||||||||||||||||
Source file | Conditionals | Statements | Methods | TOTAL | |||||||||||||||
IContainedComponent.java | - | - | - | - |
|
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.spec; | |
16 | ||
17 | import java.util.Collection; | |
18 | ||
19 | import org.apache.hivemind.Locatable; | |
20 | import org.apache.hivemind.LocationHolder; | |
21 | import org.apache.tapestry.util.IPropertyHolder; | |
22 | ||
23 | /** | |
24 | * Defines a contained component. This includes the information needed to | |
25 | * get the contained component's specification, as well as any bindings | |
26 | * for the component. | |
27 | ||
28 | * @author glongman@intelligentworks.com | |
29 | */ | |
30 | public interface IContainedComponent extends IPropertyHolder, LocationHolder, Locatable, PropertyInjectable | |
31 | { | |
32 | /** | |
33 | * Returns the named binding, or null if the binding does not | |
34 | * exist. | |
35 | * | |
36 | **/ | |
37 | public abstract IBindingSpecification getBinding(String name); | |
38 | /** | |
39 | * Returns an umodifiable <code>Collection</code> | |
40 | * of Strings, each the name of one binding | |
41 | * for the component. | |
42 | * | |
43 | **/ | |
44 | public abstract Collection getBindingNames(); | |
45 | public abstract String getType(); | |
46 | public abstract void setBinding(String name, IBindingSpecification spec); | |
47 | public abstract void setType(String value); | |
48 | /** | |
49 | * Sets the String Id of the component being copied from. | |
50 | * For use by IDE tools like Spindle. | |
51 | * | |
52 | * @since 1.0.9 | |
53 | **/ | |
54 | public abstract void setCopyOf(String id); | |
55 | /** | |
56 | * Returns the id of the component being copied from. | |
57 | * For use by IDE tools like Spindle. | |
58 | * | |
59 | * @since 1.0.9 | |
60 | **/ | |
61 | public abstract String getCopyOf(); | |
62 | ||
63 | /** | |
64 | * Returns whether the contained component will inherit | |
65 | * the informal parameters of its parent. | |
66 | * | |
67 | * @since 3.0 | |
68 | **/ | |
69 | public abstract boolean getInheritInformalParameters(); | |
70 | ||
71 | /** | |
72 | * Sets whether the contained component will inherit | |
73 | * the informal parameters of its parent. | |
74 | * | |
75 | * @since 3.0 | |
76 | */ | |
77 | public abstract void setInheritInformalParameters(boolean value); | |
78 | ||
79 | /** | |
80 | * Returns the name of the property to be created for this component, | |
81 | * or null if no property should be created. | |
82 | * | |
83 | * @since 4.0 | |
84 | */ | |
85 | public String getPropertyName(); | |
86 | ||
87 | /** | |
88 | * | |
89 | * @since 4.0 | |
90 | */ | |
91 | ||
92 | public void setPropertyName(String propertyName); | |
93 | } |
|