com.google.gwt.user.client.ui
Class PopupPanel

java.lang.Object
  extended by com.google.gwt.user.client.ui.UIObject
      extended by com.google.gwt.user.client.ui.Widget
          extended by com.google.gwt.user.client.ui.Panel
              extended by com.google.gwt.user.client.ui.SimplePanel
                  extended by com.google.gwt.user.client.ui.PopupPanel
All Implemented Interfaces:
EventListener, EventPreview, HasWidgets, SourcesPopupEvents
Direct Known Subclasses:
DialogBox

public class PopupPanel
extends SimplePanel
implements SourcesPopupEvents, EventPreview

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();
  }
}


Constructor Summary
PopupPanel()
          Creates an empty popup panel.
PopupPanel(boolean autoHide)
          Creates an empty popup panel, specifying its "auto-hide" property.
 
Method Summary
 void addPopupListener(PopupListener listener)
          Adds a listener interface to receive popup events.
 int getPopupLeft()
          Gets the popup's left position relative to the browser's client area.
 int getPopupTop()
          Gets the popup's top position relative to the browser's client area.
 void hide()
          Hides the popup.
 boolean onEventPreview(Event event)
          Called when a browser event occurs and this event preview is on top of the preview stack.
 boolean onKeyDownPreview(char key, int modifiers)
          Popups get an opportunity to preview keyboard events before they are passed to any other widget.
 boolean onKeyPressPreview(char key, int modifiers)
          Popups get an opportunity to preview keyboard events before they are passed to any other widget.
 boolean onKeyUpPreview(char key, int modifiers)
          Popups get an opportunity to preview keyboard events before they are passed to any other widget.
 boolean remove(Widget w)
          Removes a child widget.
 void removePopupListener(PopupListener listener)
          Removes a previously added popup listener.
 void setPopupPosition(int left, int top)
          Sets the popup's position relative to the browser's client area.
 void show()
          Shows the popup.
 
Methods inherited from class com.google.gwt.user.client.ui.SimplePanel
add, getContainerElement, getWidget, iterator, setWidget
 
Methods inherited from class com.google.gwt.user.client.ui.Panel
adopt, clear, disown, onAttach, onDetach
 
Methods inherited from class com.google.gwt.user.client.ui.Widget
getParent, isAttached, onBrowserEvent, onLoad, removeFromParent
 
Methods inherited from class com.google.gwt.user.client.ui.UIObject
addStyleName, getAbsoluteLeft, getAbsoluteTop, getElement, getOffsetHeight, getOffsetWidth, getStyleName, getTitle, isVisible, isVisible, removeStyleName, setElement, setHeight, setPixelSize, setSize, setStyleName, setStyleName, setTitle, setVisible, setVisible, setWidth, sinkEvents, toString, unsinkEvents
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

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)
Description copied from interface: SourcesPopupEvents
Adds a listener interface to receive popup events.

Specified by:
addPopupListener in interface SourcesPopupEvents
Parameters:
listener - the listener interface to add.

getPopupLeft

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

Returns:
the popup's left position

getPopupTop

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

Returns:
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)
Description copied from interface: EventPreview
Called when a browser event occurs and this event preview is on top of the preview stack.

Specified by:
onEventPreview in interface EventPreview
Parameters:
event - the browser event
Returns:
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.
Returns:
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.
Returns:
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.
Returns:
false to suppress the event

remove

public boolean remove(Widget w)
Description copied from interface: HasWidgets
Removes a child widget.

Specified by:
remove in interface HasWidgets
Overrides:
remove in class SimplePanel
Parameters:
w - the widget to be removed
Returns:
true if the widget was present

removePopupListener

public void removePopupListener(PopupListener listener)
Description copied from interface: SourcesPopupEvents
Removes a previously added popup listener.

Specified by:
removePopupListener in interface SourcesPopupEvents
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.