com.gwtplatform.mvp.client.proxy.RevealRootPopupContentEvent Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of gwtp-all Show documentation
There is a newer version: 1.6
/**
 * Copyright 2011 ArcBees Inc.
 *
 * 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 com.gwtplatform.mvp.client.proxy;

import com.google.gwt.event.shared.GwtEvent;
import com.google.gwt.event.shared.HasHandlers;

import com.gwtplatform.mvp.client.PopupView;
import com.gwtplatform.mvp.client.PresenterWidget;

/**
 * This event is fired when a {@link com.gwtplatform.mvp.client.PresenterWidget} wants to reveal itself
 * as a popup at the root of the application. It is typically fired by the
 * {@link com.gwtplatform.mvp.client.PresenterWidget}'s parent.
 *
 * @see RevealContentEvent
 * @see RevealRootContentEvent
 * @see RevealRootLayoutContentEvent
 *
 * @author Philippe Beaudoin
 */
/**
 * Use this type of event to reveal popup content that should get added at the
 * root of the presenter hierarchy.
 *
 * @author Philippe Beaudoin
 */
public final class RevealRootPopupContentEvent extends
    GwtEvent {

  private static final Type TYPE = new Type();

  /**
   * Fires a {@link RevealRootPopupContentEvent}
   * into a source that has access to an {@link com.google.web.bindery.event.shared.EventBus}.
   *
   * @param source The source that fires this event ({@link HasHandlers}).
   * @param content The {@link PresenterWidget} with a {@link PopupView} that wants to set
   *                itself as root content.
   */
  public static void fire(final HasHandlers source, final PresenterWidget content) {
    source.fireEvent(new RevealRootPopupContentEvent(content));
  }

  public static Type getType() {
    return TYPE;
  }

  private final PresenterWidget content;

  public RevealRootPopupContentEvent(PresenterWidget content) {
    this.content = content;
  }

  @Override
  public Type getAssociatedType() {
    return getType();
  }

  public PresenterWidget getContent() {
    return content;
  }

  @Override
  protected void dispatch(RevealRootPopupContentHandler handler) {
    handler.onRevealRootPopupContent(this);
  }

}