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 org.jboss.portal.common.util.MarkupInfo;
25: import org.jboss.portal.theme.render.RendererContext;
26: import org.jboss.portal.theme.render.ThemeContext;
27: import org.jboss.portal.web.ServletContextDispatcher;
28:
29: import java.io.Writer;
30:
31: /**
32: * Implementation of a <code>PortalLayout</code>. <p>An instance of this class represents the meta data of a portal
33: * layout.</p>
34: *
35: * @author <a href="mailto:mholzner@novell.com">Martin Holzner</a>.
36: * @version <tt>$Revision: 8784 $</tt>
37: */
38: public abstract class PortalLayout {
39:
40: /** . */
41: protected LayoutInfo info;
42:
43: /** . */
44: protected LayoutServiceInfo serviceInfo;
45:
46: public void init(LayoutServiceInfo serviceInfo, LayoutInfo info) {
47: this .info = info;
48: this .serviceInfo = serviceInfo;
49: }
50:
51: public void destroy() {
52: info = null;
53: serviceInfo = null;
54: }
55:
56: public LayoutInfo getLayoutInfo() {
57: return info;
58: }
59:
60: public LayoutServiceInfo getServiceInfo() {
61: return serviceInfo;
62: }
63:
64: /**
65: * Provides a render context that will render its markup in the response provided by the servlet context dispatcher.
66: *
67: * @param themeContext the theme context
68: * @param markupInfo the markup info
69: * @param dispatcher the way to dispatch to the layout and receive the produced markup
70: * @return a render context
71: */
72: public abstract RendererContext getRenderContext(
73: ThemeContext themeContext, MarkupInfo markupInfo,
74: ServletContextDispatcher dispatcher);
75:
76: /**
77: * Provides a render context that will render its markup in the provided writer.
78: *
79: * @param themeContext the theme context
80: * @param markupInfo the markup info
81: * @param dispatcher the way to dispatch to the layout
82: * @param writer the writer that will receive the produced markup
83: * @return a render context
84: */
85: public abstract RendererContext getRenderContext(
86: ThemeContext themeContext, MarkupInfo markupInfo,
87: ServletContextDispatcher dispatcher, Writer writer);
88: }
|