RevealRootContentHandler.java

/*
 * Copyright 2012 Cedric Hauber
 *
 *    Licensed under the Apache License, Version 2.0 (the "License");
 *    you may not use this file except in compliance with the License.
 *    You may obtain a copy of the License at
 *
 *        http://www.apache.org/licenses/LICENSE-2.0
 *
 *    Unless required by applicable law or agreed to in writing, software
 *    distributed under the License is distributed on an "AS IS" BASIS,
 *    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *    See the License for the specific language governing permissions and
 *    limitations under the License.
 */

package org.jboss.errai.mvp.client.events;

import com.google.gwt.event.shared.EventHandler;

/**
 * This is the handler interface for {@link RevealRootContentEvent}. It is used
 * solely by {@link com.gwtplatform.mvp.client.RootPresenter}.
 *
 * @author Philippe Beaudoin
 */
public interface RevealRootContentHandler extends EventHandler {

  /**
   * Called whenever a presenter wants to sets itself as the root content of the
   * application, that is, within GWT's
   * {@link com.google.gwt.user.client.ui.RootPanel}.
   *
   * @param event The event containing the presenter that wants to bet set as
   *          root content.
   */
  void onRevealRootContent(RevealRootContentEvent event);

}