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

java.lang.Object
  com.google.gwt.user.client.ui.UIObject
      com.google.gwt.user.client.ui.Widget
          com.google.gwt.user.client.ui.Panel
              com.google.gwt.user.client.ui.SimplePanel
                  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

code

Field Summary

Fields inherited from class java.lang.Object

typeId, typeName

Constructor Summary

PopupPanel()
Creates an empty popup panel.

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

Method Summary

boolean	add(Widget w) Adds a new child widget to the panel.
void	addPopupListener(PopupListener listener) Adds a listener interface to receive popup events.
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.
void	removePopupListener(PopupListener listener) Removes a previously added popup listener.
void	setHeight(String height) Sets the object's height.
void	setPixelSize(int width, int height) Sets the object's size, in pixels, not including decorations such as border, margin, and padding.
void	setPopupPosition(int left, int top) Sets the popup's position relative to the browser's client area.
void	setStyleName(String style) Sets the object's style name, removing all other styles.
void	setWidth(String width) Sets the object's width.
void	show() Shows the popup.

Methods inherited from class com.google.gwt.user.client.ui.SimplePanel

clear, getContainerElement, getWidget, getWidgetCount, getWidgetIndex, iterator, remove, setWidget

Methods inherited from class com.google.gwt.user.client.ui.Panel

adopt, disown, onAttach, onDetach

Methods inherited from class com.google.gwt.user.client.ui.Widget

getParent, isAttached, onBrowserEvent, onLoad

Methods inherited from class com.google.gwt.user.client.ui.UIObject

addStyleName, getAbsoluteLeft, getAbsoluteTop, getElement, getOffsetHeight, getOffsetWidth, getStyleName, isVisible, isVisible, removeStyleName, setElement, setSize, setStyleName, setVisible, setVisible, sinkEvents, toString, unsinkEvents

Methods inherited from class java.lang.Object

equals, finalize, hashCode

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

add

public boolean add(Widget w)

Description copied from class: Panel

Adds a new child widget to the panel.

Overrides:

add in class SimplePanel

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.

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

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.

setHeight

public void setHeight(String height)

Description copied from class: UIObject

Sets the object's height. This height does not include decorations such as border, margin, and padding.

Overrides:

setHeight in class UIObject

Parameters:

height - the object's new height, in CSS units (e.g. "10px", "1em")

setPixelSize

public void setPixelSize(int width,
                         int height)

Description copied from class: UIObject

Sets the object's size, in pixels, not including decorations such as border, margin, and padding.

Overrides:

setPixelSize in class UIObject

Parameters:

width - the object's new width, in pixels

height - the object's new height, in pixels

setPopupPosition

public void setPopupPosition(int left,
                             int top)

Sets the popup's position relative to the browser's client area.

Parameters:

left - the left position, in pixels

top - the top position, in pixels

setStyleName

public void setStyleName(String style)

Description copied from class: UIObject

Sets the object's style name, removing all other styles.

The style name is the name referred to in CSS style rules (in HTML, this is referred to as the element's "class"). By convention, style rules are of the form [project]-[widget] (e.g. the Button widget's style name is .gwt-Button).

For example, if a widget's style name is myProject-MyWidget, then the style rule that applies to it will be .myProject-MyWidget. Note the "dot" prefix -- this is necessary because calling this method sets the underlying element's className property.

An object may have any number of style names, which may be manipulated using UIObject.addStyleName(String) and UIObject.removeStyleName(String). The attributes of all styles associated with the object will be applied to it.

Overrides:

setStyleName in class UIObject

Parameters:

style - the style name to be added

See Also:

UIObject.addStyleName(String), UIObject.removeStyleName(String)

setWidth

public void setWidth(String width)

Description copied from class: UIObject

Sets the object's width. This width does not include decorations such as border, margin, and padding.

Overrides:

setWidth in class UIObject

Parameters:

width - the object's new width, in CSS units (e.g. "10px", "1em")

show

public void show()

Shows the popup. It must have a child widget before this method is called.