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.core.model.portal;
23:
24: import org.jboss.portal.Mode;
25: import org.jboss.portal.WindowState;
26: import org.jboss.portal.core.model.content.Content;
27: import org.jboss.portal.core.model.content.ContentType;
28:
29: /**
30: * Represents a window, i.e the view port to integrated content.
31: *
32: * @author <a href="mailto:julien@jboss.org">Julien Viet</a>
33: * @version $Revision: 8786 $
34: */
35: public interface Window extends PortalObject {
36:
37: /**
38: * Return the page containing this window.
39: *
40: * @return the page
41: */
42: Page getPage();
43:
44: /**
45: * Return the window content type.
46: *
47: * @return the window content type
48: */
49: ContentType getContentType();
50:
51: /**
52: * Returns the window content or null if no content can be provided. Content could not be provided if no content
53: * handler has been found in the content handler registry.
54: *
55: * @return the window content
56: */
57: Content getContent();
58:
59: /**
60: * Returns the inital window state (the window state to use when no navigational state exists, for example on a new
61: * page request) for this particular window
62: *
63: * @return a windowState
64: */
65: WindowState getInitialWindowState();
66:
67: /**
68: * Returns the inital mode to use (the mode to use when no navigational state exists, for example on a new page
69: * request) for this particular window
70: *
71: * @return a portlet mode
72: */
73: Mode getInitialMode();
74: }
|