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