Class PopupPanel

public class PopupPanel
extends SimplePanel
implements SourcesPopupEvents, EventPreview

// Superclass of DialogBox
A panel that can "pop up" over other widgets. It overlays the browser's client area (and any previously-created popups).

Example

public class PopupPanelExample implements EntryPoint, ClickListener {

  private static class MyPopup extends PopupPanel {

    public MyPopup() {
      // PopupPanel's constructor takes 'auto-hide' as its boolean parameter.
      // If this is set, the panel closes itself automatically when the user
      // clicks outside of it.
      super(true);

      // PopupPanel is a SimplePanel, so you have to set it's widget property to
      // whatever you want its contents to be.
      setWidget(new Label("Click outside of this popup to close it"));
    }
  }

  public void onModuleLoad() {
    Button b = new Button("Click me");
    b.addClickListener(this);

    RootPanel.get().add(b);
  }

  public void onClick(Widget sender) {
    // Instantiate the popup and show it.
    new MyPopup().show();
  }
}

Constructors

PopupPanel()Creates an empty popup panel.
PopupPanel(boolean)Creates an empty popup panel, specifying its "auto-hide" property.

Methods

addPopupListener(PopupListener)Adds a listener interface to receive popup events.
getPopupLeft()Gets the popup's left position relative to the browser's client area.
getPopupTop()Gets the popup's top position relative to the browser's client area.
hide()Hides the popup.
onEventPreview(Event)Called when a browser event occurs and this event preview is on top of the preview stack.
onKeyDownPreview(char, int)Popups get an opportunity to preview keyboard events before they are passed to any other widget.
onKeyPressPreview(char, int)Popups get an opportunity to preview keyboard events before they are passed to any other widget.
onKeyUpPreview(char, int)Popups get an opportunity to preview keyboard events before they are passed to any other widget.
remove(Widget)
removePopupListener(PopupListener)Removes a previously added popup listener.
setPopupPosition(int, int)Sets the popup's position relative to the browser's client area.
show()Shows the popup.

Constructor Detail

PopupPanel

public PopupPanel()
Creates an empty popup panel. A child widget must be added to it before it is shown.

PopupPanel

public PopupPanel(boolean autoHide)
Creates an empty popup panel, specifying its "auto-hide" property.

Parameters

autoHide
true if the popup should be automatically hidden when the user clicks outside of it

Method Detail

addPopupListener

public void addPopupListener(PopupListener listener)
Adds a listener interface to receive popup events.

Parameters

listener
the listener interface to add.

getPopupLeft

public int getPopupLeft()
Gets the popup's left position relative to the browser's client area.

Return Value

the popup's left position

getPopupTop

public int getPopupTop()
Gets the popup's top position relative to the browser's client area.

Return Value

the popup's top position

hide

public void hide()
Hides the popup. This has no effect if it is not currently visible.

onEventPreview

public boolean onEventPreview(Event event)
Called when a browser event occurs and this event preview is on top of the preview stack.

Parameters

event
the browser event

Return Value

false to cancel the event

See Also

DOM.addEventPreview(EventPreview)

onKeyDownPreview

public boolean onKeyDownPreview(char key, int modifiers)
Popups get an opportunity to preview keyboard events before they are passed to any other widget.

Parameters

key
the key code of the depressed key
modifiers
keyboard modifiers, as specified in KeyboardListener.

Return Value

false to suppress the event

onKeyPressPreview

public boolean onKeyPressPreview(char key, int modifiers)
Popups get an opportunity to preview keyboard events before they are passed to any other widget.

Parameters

key
the unicode character pressed
modifiers
keyboard modifiers, as specified in KeyboardListener.

Return Value

false to suppress the event

onKeyUpPreview

public boolean onKeyUpPreview(char key, int modifiers)
Popups get an opportunity to preview keyboard events before they are passed to any other widget.

Parameters

key
the key code of the released key
modifiers
keyboard modifiers, as specified in KeyboardListener.

Return Value

false to suppress the event

remove

public boolean remove(Widget w)

Parameters

w

removePopupListener

public void removePopupListener(PopupListener listener)
Removes a previously added popup listener.

Parameters

listener
the listener interface to remove.

setPopupPosition

public void setPopupPosition(int left, int top)
Sets the popup's position relative to the browser's client area. The popup's position may be set before calling show().

Parameters

left
the left position, in pixels
top
the top position, in pixels

show

public void show()
Shows the popup. It must have a child widget before this method is called.