001/*
002 * JGrapes Event Driven Framework
003 * Copyright (C) 2017-2018 Michael N. Lipp
004 * 
005 * This program is free software; you can redistribute it and/or modify it 
006 * under the terms of the GNU Affero General Public License as published by 
007 * the Free Software Foundation; either version 3 of the License, or 
008 * (at your option) any later version.
009 * 
010 * This program is distributed in the hope that it will be useful, but 
011 * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
012 * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License 
013 * for more details.
014 * 
015 * You should have received a copy of the GNU Affero General Public License along 
016 * with this program; if not, see <http://www.gnu.org/licenses/>.
017 */
018
019package org.jgrapes.portal.base.events;
020
021import java.util.List;
022
023import org.jgrapes.core.Event;
024import org.jgrapes.portal.base.Portlet.RenderMode;
025import org.jgrapes.portal.base.RenderSupport;
026
027/**
028 * The base class for events that result in a portlet being rendered.
029 */
030public abstract class RenderPortletRequestBase<T> extends Event<T> {
031    private final RenderSupport renderSupport;
032    private final List<RenderMode> renderModes;
033
034    /**
035     * Creates a new event.
036     *
037     * @param renderSupport the render support
038     * @param renderModes the render modes
039     */
040    public RenderPortletRequestBase(
041            RenderSupport renderSupport, List<RenderMode> renderModes) {
042        this.renderSupport = renderSupport;
043        this.renderModes = renderModes;
044    }
045
046    /**
047     * Returns the render support.
048     * 
049     * @return the render support
050     */
051    public RenderSupport renderSupport() {
052        return renderSupport;
053    }
054
055    /**
056     * Returns the render modes.
057     * 
058     * @return the render modes
059     */
060    public List<RenderMode> renderModes() {
061        return renderModes;
062    }
063
064    /**
065     * Returns the preferred render mode.
066     *
067     * @return the render mode
068     */
069    public RenderMode preferredRenderMode() {
070        return renderModes().stream()
071            .filter(mode -> mode != RenderMode.Foreground).findFirst()
072            .orElse(RenderMode.Preview);
073    }
074
075    /**
076     * Indicates if portlet is to be put in foreground.
077     * 
078     * @return the result
079     */
080    public abstract boolean isForeground();
081
082}