portletpage.java

GridSphere 门户 提供一个基于 portlet 的高级开放源代码门户。GridSphere 是在欧盟提供基金的 GridLab 项目下开发的

/*
 * @author <a href="mailto:[e-mail]">Jason Novotny</a>
 * @version $Id: PortletPage.java 5032 2006-08-17 18:15:06Z novotny $
 */
package org.gridsphere.layout;

import org.gridsphere.layout.view.Render;
import org.gridsphere.portlet.impl.SportletProperties;
import org.gridsphere.portlet.service.PortletServiceException;
import org.gridsphere.portlet.service.spi.PortletServiceFactory;
import org.gridsphere.portletcontainer.GridSphereEvent;
import org.gridsphere.portletcontainer.impl.PortletInvoker;
import org.gridsphere.services.core.cache.CacheService;
import org.gridsphere.services.core.persistence.PersistenceManagerException;

import javax.portlet.PortletRequest;
import javax.portlet.PortletSession;
import javax.portlet.RenderRequest;
import javax.servlet.ServletContext;
import java.io.IOException;
import java.io.Serializable;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;

/**
 * The <code>PortletPage</code> is the generic container for a collection of
 * concrete portlet components and provides lifecycle methods for traversing
 * the tree of components and handling actions and performing rendering.
 */
public class PortletPage extends BasePortletComponent implements Serializable, Cloneable {

    protected transient CacheService cacheService = null;

    protected transient PortletInvoker portletInvoker = null;

    protected PortletContainer footerContainer = null;
    protected PortletContainer headerContainer = null;

    protected PortletComponent component = null;

    // The component ID's of each of the layout components
    protected List<ComponentIdentifier> componentIdentifiers = null;

    protected String keywords = "";
    protected String title = "";
    protected String icon = "images/favicon.ico";
    protected int refresh = 0;
    protected boolean editable = true;
    protected boolean displayModes = true;
    protected boolean displayStates = true;
    private String layoutDescriptor = null;

    private Map<String, Integer> labelsHash = null;

    private transient Render pageView = null;

    private String renderKit = "brush";

    /**
     * Constructs an instance of PortletPage
     */
    public PortletPage() {
    }

    public void setLayoutDescriptor(String layoutDescriptor) {
        this.layoutDescriptor = layoutDescriptor;
    }

    public String getLayoutDescriptor() {
        return layoutDescriptor;
    }

    /**
     * Sets the portlet container title
     *
     * @param title the portlet container title
     */
    public void setTitle(String title) {
        this.title = title;
    }

    /**
     * Returns the portlet container title
     *
     * @return the portlet container title
     */
    public String getTitle() {
        return title;
    }

    /**
     * Boolean flag to determine if this layout can be customized
     *
     * @param editable flag to determine if this layout can be customized
     */
    public void setEditable(boolean editable) {
        this.editable = editable;
    }

    /**
     * Boolean flag to determine if this layout can be customized
     *
     * @return true if this layout can be customized
     */
    public boolean getEditable() {
        return editable;
    }

    /**
     * Boolean flag to determine if the portlet modes should be displayed
     *
     * @param displayModes flag to determine if this layout can be customized
     */
    public void setDisplayModes(boolean displayModes) {
        this.displayModes = displayModes;
    }

    /**
     * Boolean flag to determine if the portlet modes should be displayed
     *
     * @return true if this layout can be customized
     */
    public boolean getDisplayModes() {
        return displayModes;
    }

    /**
     * Boolean flag to determine if thie window states should be displaed
     *
     * @param displayStates to determine if thie window states should be displaed
     */
    public void setDisplayStates(boolean displayStates) {
        this.displayStates = displayStates;
    }

    /**
     * Boolean flag to determine if the window states should be displayed
     *
     * @return true if this layout can be customized
     */
    public boolean getDisplayStates() {
        return displayStates;
    }

    /**
     * Returns the favicon for the page
     *
     * @return the favicon for the page
     */
    public String getIcon() {
        return icon;
    }

    /**
     * Sets the favicon for the page
     *
     * @param icon the favicon for the page
     */
    public void setIcon(String icon) {
        this.icon = icon;
    }

    /**
     * Returns the page refresh rate
     *
     * @return the page refresh rate
     */
    public int getRefresh() {
        return refresh;
    }

    /**
     * Sets the page refresh rate
     *
     * @param refresh the page refresh rate
     */
    public void setRefresh(int refresh) {
        this.refresh = refresh;
    }

    /**
     * Returns the keywords used in rendering output
     *
     * @return keywords
     */
    public String getKeywords() {
        return keywords;
    }

    /**
     * Sets the keywords used in rendering output
     *
     * @param keywords used in rendering output
     */
    public void setKeywords(String keywords) {
        this.keywords = keywords;
    }

    /**
     * Returns the render kit
     *
     * @return the render kit
     */
    public String getRenderKit() {
        return renderKit;
    }

    /**
     * Sets the render kit
     *
     * @param renderKit the render kit
     */
    public void setRenderKit(String renderKit) {
        this.renderKit = renderKit;
    }

    /**
     * Sets the page header
     *
     * @param headerContainer a portlet container with header components
     */
    public void setPortletHeader(PortletContainer headerContainer) {
        this.headerContainer = headerContainer;
    }

    /**
     * Returns the page header
     *
     * @return a portlet container with header components
     */
    public PortletContainer getPortletHeader() {
        return headerContainer;
    }

    /**
     * Sets the page footer
     *
     * @param footerContainer a portlet container with footer components
     */
    public void setPortletFooter(PortletContainer footerContainer) {
        this.footerContainer = footerContainer;
    }

    /**
     * Returns the page footer
     *
     * @return a portlet container with footer components
     */
    public PortletContainer getPortletFooter() {
        return footerContainer;
    }

    public void setPortletComponent(PortletComponent component) {
        this.component = component;
    }


    public PortletComponent getPortletComponent() {
        return component;
    }

    /**
     * Returns the list of portlet component identifiers