KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > riotfamily > components > Component


1 /* ***** BEGIN LICENSE BLOCK *****
2  * Version: MPL 1.1
3  * The contents of this file are subject to the Mozilla Public License Version
4  * 1.1 (the "License"); you may not use this file except in compliance with
5  * the License. You may obtain a copy of the License at
6  * http://www.mozilla.org/MPL/
7  *
8  * Software distributed under the License is distributed on an "AS IS" basis,
9  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
10  * for the specific language governing rights and limitations under the
11  * License.
12  *
13  * The Original Code is Riot.
14  *
15  * The Initial Developer of the Original Code is
16  * Neteye GmbH.
17  * Portions created by the Initial Developer are Copyright (C) 2006
18  * the Initial Developer. All Rights Reserved.
19  *
20  * Contributor(s):
21  * Felix Gnass [fgnass at neteye dot de]
22  *
23  * ***** END LICENSE BLOCK ***** */

24 package org.riotfamily.components;
25
26 import java.io.IOException JavaDoc;
27 import java.util.Collection JavaDoc;
28 import java.util.List JavaDoc;
29 import java.util.Map JavaDoc;
30
31 import javax.servlet.http.HttpServletRequest JavaDoc;
32 import javax.servlet.http.HttpServletResponse JavaDoc;
33
34
35
36
37 public interface Component {
38
39     /**
40      * Indicates whether the content rendered by the component depends on
41      * anything other but the components internal data.
42      */

43     public boolean isDynamic();
44
45     public void setPropertyProcessors(List JavaDoc propertyProcessors);
46
47     public void addPropertyProcessor(PropertyProcessor propertyProcessor);
48
49     public Map JavaDoc buildModel(ComponentVersion version);
50
51     public void updateProperties(ComponentVersion version, Map JavaDoc model);
52
53     public List JavaDoc getPropertyProcessors();
54
55     /**
56      * Renders the given ComponentVersion.
57      */

58     public void render(ComponentVersion version, String JavaDoc positionClassName,
59             HttpServletRequest JavaDoc request, HttpServletResponse JavaDoc response)
60             throws IOException JavaDoc;
61
62     /**
63      * Returns a Collection of Strings that should be used to tag the
64      * CacheItem containing the rendered component.
65      */

66     public Collection JavaDoc getCacheTags(ComponentVersion version);
67
68 }
69
Popular Tags