wave/src/main/java/org/waveprotocol/wave/client/widget/popup/PopupProvider.java

/**
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you 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.waveprotocol.wave.client.widget.popup;

import com.google.gwt.dom.client.Element;
import com.google.gwt.user.client.ui.Panel;

/**
 * Implementation of popup functionality which may change across clients.
 *
 */
public interface PopupProvider {
  /**
   * Create a popup panel
   */
  UniversalPopup createPopup(Element relative, RelativePopupPositioner positioner,
      PopupChrome chrome, boolean autoHide);

  /**
   * Sets the root panel to be used for displaying popups. Some platforms may
   * ignore this. Should be set before displaying any popups.
   */
  void setRootPanel(Panel rootPanel);
}