com.threerings.gwt.ui

Class Popups

java.lang.Object

com.threerings.gwt.ui.Popups

public class Popups
extends Object

Popup-related utility methods.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Popups.Position Positions supported by show(T, com.threerings.gwt.ui.Popups.Position, com.google.gwt.user.client.ui.Widget) and other methods.
static interface	Popups.Thunk Used to defer the creation of a popup panel.

Constructor Summary

Constructors

Constructor and Description
Popups()

Method Summary

Methods

Modifier and Type	Method and Description
static void	bindPopped(Value<Boolean> popped, PopupPanel panel) Binds the popped up state of a popup to the supplied boolean value and vice versa (i.e.
static void	bindPopped(Value<Boolean> popped, Popups.Position pos, Widget target, PopupPanel panel) Binds the popped up state of a popup to the supplied boolean value and vice versa (i.e.
static void	bindPopped(Value<Boolean> popped, Popups.Position pos, Widget target, Popups.Thunk thunk) Binds the popped up state of a popup to the supplied boolean value and vice versa (i.e.
static void	bindPopped(Value<Boolean> popped, Popups.Thunk thunk) Binds the popped up state of a popup to the supplied boolean value and vice versa (i.e.
static <T extends PopupPanel> T	centerOn(T popup, int ypos) Centers the supplied vertically on the supplied trigger widget.
static <T extends PopupPanel> T	centerOn(T popup, Widget centerOn) Centers the supplied vertically on the supplied trigger widget.
static ClickHandler	createHider(PopupPanel popup) Creates a click handler that hides the specified popup.
static InfoPopup	error(String message) Displays error feedback to the user in a non-offensive way.
static InfoPopup	error(String message, Popups.Position pos, Widget source) Displays error feedback to the user in a non-offensive way.
static InfoPopup	errorAbove(String message, Widget source) Displays error feedback to the user in a non-offensive way.
static InfoPopup	errorBelow(String message, Widget source) Displays error feedback to the user in a non-offensive way.
static void	errorNear(String message, Widget source) Deprecated. Use errorBelow(java.lang.String, com.google.gwt.user.client.ui.Widget)
static InfoPopup	info(String message) Displays an info message centered in the browser window.
static InfoPopup	info(String message, Popups.Position pos, Widget target) Displays an info message below the specified widget.
static InfoPopup	infoAbove(String message, Widget target) Displays an info message below the specified widget.
static InfoPopup	infoBelow(String message, Widget target) Displays an info message below the specified widget.
static void	infoNear(String message, Widget target) Deprecated. Use infoBelow(java.lang.String, com.google.gwt.user.client.ui.Widget)
static InfoPopup	infoOn(String message, Widget target) Displays an info message centered horizontally on the page and centered vertically on the specified target widget.
static void	makeDraggable(HasAllMouseHandlers dragHandle, PopupPanel target) Adds mouse handlers to the specified drag handle that cause the supplied target popup to be dragged around the display.
static PopupPanel	newPopup(String styleName, Widget contents) Creates and returns a new popup with the specified style name and contents.
static PopupPanel	newPopup(String styleName, Widget contents, Popups.Position pos, Widget target) Creates a new popup with the specified style name and contents and shows it near the specified target widget.
static <T extends PopupPanel> T	show(T popup, Popups.Position pos, Widget target) Shows the supplied popup in the specified position relative to the specified target widget.
static <T extends PopupPanel> T	showAbove(T popup, Widget target) Shows the supplied popup panel near the specified target.
static <T extends PopupPanel> T	showBelow(T popup, Widget target) Shows the supplied popup panel below the specified target.
static void	showNear(PopupPanel popup, Widget target) Deprecated. Use showBelow(T, com.google.gwt.user.client.ui.Widget)
static <T extends PopupPanel> T	showOver(T popup, Widget target) Shows the supplied popup panel over the specified target.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Popups

public Popups()

Method Detail

info

public static InfoPopup info(String message)

Displays an info message centered in the browser window.

infoNear

@Deprecated
public static void infoNear(String message,
                       Widget target)

Deprecated. Use infoBelow(java.lang.String, com.google.gwt.user.client.ui.Widget)

infoAbove

public static InfoPopup infoAbove(String message,
                  Widget target)

Displays an info message below the specified widget.

infoBelow

public static InfoPopup infoBelow(String message,
                  Widget target)

Displays an info message below the specified widget.

infoOn

public static InfoPopup infoOn(String message,
               Widget target)

Displays an info message centered horizontally on the page and centered vertically on the specified target widget.

info

public static InfoPopup info(String message,
             Popups.Position pos,
             Widget target)

Displays an info message below the specified widget.

error

public static InfoPopup error(String message)

Displays error feedback to the user in a non-offensive way.

errorNear

@Deprecated
public static void errorNear(String message,
                        Widget source)

Deprecated. Use errorBelow(java.lang.String, com.google.gwt.user.client.ui.Widget)

errorAbove

public static InfoPopup errorAbove(String message,
                   Widget source)

Displays error feedback to the user in a non-offensive way. The error feedback is displayed near the supplied component and if the component supports focus, it is focused.

errorBelow

public static InfoPopup errorBelow(String message,
                   Widget source)

Displays error feedback to the user in a non-offensive way. The error feedback is displayed near the supplied component and if the component supports focus, it is focused.

error

public static InfoPopup error(String message,
              Popups.Position pos,
              Widget source)

Displays error feedback to the user in a non-offensive way. The error feedback is displayed near the supplied component and if the component supports focus, it is focused.

show

public static <T extends PopupPanel> T show(T popup,
                            Popups.Position pos,
                            Widget target)

Shows the supplied popup in the specified position relative to the specified target widget.

showNear

@Deprecated
public static void showNear(PopupPanel popup,
                       Widget target)

Deprecated. Use showBelow(T, com.google.gwt.user.client.ui.Widget)

showAbove

public static <T extends PopupPanel> T showAbove(T popup,
                                 Widget target)

Shows the supplied popup panel near the specified target.

showOver

public static <T extends PopupPanel> T showOver(T popup,
                                Widget target)

Shows the supplied popup panel over the specified target.

showBelow

public static <T extends PopupPanel> T showBelow(T popup,
                                 Widget target)

Shows the supplied popup panel below the specified target.

centerOn

public static <T extends PopupPanel> T centerOn(T popup,
                                Widget centerOn)

Centers the supplied vertically on the supplied trigger widget. The popup's showing state will be preserved.

centerOn

public static <T extends PopupPanel> T centerOn(T popup,
                                int ypos)

Centers the supplied vertically on the supplied trigger widget. The popup's showing state will be preserved.

Returns:

the supplied popup.

newPopup

public static PopupPanel newPopup(String styleName,
                  Widget contents)

Creates and returns a new popup with the specified style name and contents.

newPopup

public static PopupPanel newPopup(String styleName,
                  Widget contents,
                  Popups.Position pos,
                  Widget target)

Creates a new popup with the specified style name and contents and shows it near the specified target widget. Returns the newly created popup.

createHider

public static ClickHandler createHider(PopupPanel popup)

Creates a click handler that hides the specified popup. Useful when creating popups that behave like menus.

bindPopped

public static void bindPopped(Value<Boolean> popped,
              Popups.Thunk thunk)

Binds the popped up state of a popup to the supplied boolean value and vice versa (i.e. if the popup is popped down, the value will be updated to false). The popup is not created until the first time the value is true.

bindPopped

public static void bindPopped(Value<Boolean> popped,
              PopupPanel panel)

Binds the popped up state of a popup to the supplied boolean value and vice versa (i.e. if the popup is popped down, the value will be updated to false).

bindPopped

public static void bindPopped(Value<Boolean> popped,
              Popups.Position pos,
              Widget target,
              Popups.Thunk thunk)

Binds the popped up state of a popup to the supplied boolean value and vice versa (i.e. if the popup is popped down, the value will be updated to false). The popup is not created until the first time the value is true.

bindPopped

public static void bindPopped(Value<Boolean> popped,
              Popups.Position pos,
              Widget target,
              PopupPanel panel)

Binds the popped up state of a popup to the supplied boolean value and vice versa (i.e. if the popup is popped down, the value will be updated to false).

makeDraggable

public static void makeDraggable(HasAllMouseHandlers dragHandle,
                 PopupPanel target)

Adds mouse handlers to the specified drag handle that cause the supplied target popup to be dragged around the display. The drag handle is assumed to be a child of the popup.