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 org.jgrapes.core.Event;
022import org.jgrapes.portal.base.Portlet.RenderMode;
023import org.jgrapes.portal.base.RenderSupport;
024
025/**
026 * The base class for events that result in a portlet being rendered.
027 */
028public abstract class RenderPortletRequestBase<T> extends Event<T> {
029    private final RenderSupport renderSupport;
030    private final RenderMode renderMode;
031
032    /**
033     * Creates a new event.
034     * 
035     * @param renderSupport the render support
036     * @param mode the view mode that is requested
037     */
038    public RenderPortletRequestBase(
039            RenderSupport renderSupport, RenderMode mode) {
040        this.renderSupport = renderSupport;
041        this.renderMode = mode;
042    }
043
044    /**
045     * Returns the render support.
046     * 
047     * @return the render support
048     */
049    public RenderSupport renderSupport() {
050        return renderSupport;
051    }
052
053    /**
054     * Returns the render mode.
055     * 
056     * @return the render mode
057     */
058    public RenderMode renderMode() {
059        return renderMode;
060    }
061
062    /**
063     * Indicates if portlet is to be put in foreground.
064     * 
065     * @return the result
066     */
067    public abstract boolean isForeground();
068}