01: /******************************************************************************
02: * JBoss, a division of Red Hat *
03: * Copyright 2006, Red Hat Middleware, LLC, and individual *
04: * contributors as indicated by the @authors tag. See the *
05: * copyright.txt in the distribution for a full listing of *
06: * individual contributors. *
07: * *
08: * This is free software; you can redistribute it and/or modify it *
09: * under the terms of the GNU Lesser General Public License as *
10: * published by the Free Software Foundation; either version 2.1 of *
11: * the License, or (at your option) any later version. *
12: * *
13: * This software is distributed in the hope that it will be useful, *
14: * but WITHOUT ANY WARRANTY; without even the implied warranty of *
15: * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU *
16: * Lesser General Public License for more details. *
17: * *
18: * You should have received a copy of the GNU Lesser General Public *
19: * License along with this software; if not, write to the Free *
20: * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA *
21: * 02110-1301 USA, or see the FSF site: http://www.fsf.org. *
22: ******************************************************************************/package org.jboss.portal.theme;
23:
24: import java.util.Collection;
25:
26: /**
27: * A portal theme is a collection of tags that will be injected into a layout to govern the look and feel of a portal
28: * page. <p>Themes are links to css, javascript and image/resource files. A theme's css needs to cooperate with the
29: * markup in the portal layout, the markup produced by the portlets, and the markup produced by the render set.</p>
30: * <p>Any theme that the portal will pick up needs to be defined in a theme descriptor. The theme desciptor is an xml
31: * file in WEB-INF/ with the file name *-themes.xml</p>
32: *
33: * @author <a href="mailto:mholzner@novell.com>Martin Holzner</a>
34: * @version $LastChangedRevision: 8784 $, $LastChangedDate: 2007-10-27 19:01:46 -0400 (Sat, 27 Oct 2007) $
35: * @see org.jboss.portal.theme.render.ObjectRenderer
36: * @see org.jboss.portal.theme.PortalLayout
37: */
38: public abstract class PortalTheme {
39:
40: private ThemeInfo info;
41: private ThemeServiceInfo serviceInfo;
42:
43: public PortalTheme() {
44: }
45:
46: public abstract Collection getElements();
47:
48: /**
49: * Initialize the theme with a reference to the theme service and the theme meta data
50: *
51: * @param serviceInfo a theme service reference
52: * @param info the meta data of the theme to render
53: */
54: public void init(ThemeServiceInfo serviceInfo, ThemeInfo info) {
55: this .info = info;
56: this .serviceInfo = serviceInfo;
57: }
58:
59: /** Destroy the theme. Here is your chance to clean up */
60: public void destroy() {
61: info = null;
62: serviceInfo = null;
63: }
64:
65: /** @return the theme meta data */
66: public ThemeInfo getThemeInfo() {
67: return info;
68: }
69:
70: /** @return the theme service info */
71: public ThemeServiceInfo getServiceInfo() {
72: return serviceInfo;
73: }
74: }
|