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.CompletionEvent;
022import org.jgrapes.core.Event;
023import org.jgrapes.portal.base.RenderSupport;
024
025/**
026 * Signals the successful loading of the portal structure
027 * in the browser. Portlets should respond to this event by
028 * adding their types (using {@link AddPortletType} events).
029 * 
030 * After the portal ready event has been processed, a {@link PortalPrepared}
031 * event is generated as its {@link CompletionEvent}. All further action is 
032 * triggered by the {@link PortalPrepared} event.
033 */
034public class PortalReady extends Event<Void> {
035
036    private final RenderSupport renderSupport;
037
038    /**
039     * Creates a new event.
040     * 
041     * @param renderSupport the render support for generating responses
042     */
043    public PortalReady(RenderSupport renderSupport) {
044        new PortalPrepared(this);
045        this.renderSupport = renderSupport;
046    }
047
048    /**
049     * Returns the render support.
050     * 
051     * @return the render support
052     */
053    public RenderSupport renderSupport() {
054        return renderSupport;
055    }
056}