Deprecated. The UI service was deprecated on December 11, 2014. To create user interfaces, use the HTML service instead.
A form of popup that has a caption area at the top and can be dragged by the user. Unlike a
, calls to PopupPanel
and setWidth(width)
will set
the width and height of the dialog box itself, even if a widget has not been added as yet.
setHeight(height)
In general it's not recommended to add this panel as a child of another widget or of the app
as that will make it behave like any other inline panel and not act as a popup. Instead, create
the popup and then use its
and show()
methods to show and hide it. See
the example below.
hide()
Internally, UiApp widgets are built on top of the Google Web Toolkit, and it can sometimes be helpful to look at the GWT documentation directly. You can find the DialogBox documentation here.
Here is an example showing how to use the dialog box widget:
function doGet() { var app = UiApp.createApplication(); // Create a dialog box. var dialog = app.createDialogBox(); // Set the position and dimensions. dialog.setPopupPosition(100, 100).setSize(500, 500); // Show the dialog. Note that it does not have to be "added" to the UiInstance. dialog.show(); return app; }
Deprecated methods
Method | Return type | Brief description |
---|---|---|
|
| Add a widget to the . |
|
| Set the partner widget for auto-hiding. |
|
| Add a handler for close events. |
|
| Sets the dependent style name of this . |
|
| Adds a style name to this . |
|
| Remove all widgets from the . |
| String | Returns the id that has been assigned to this object. |
| String | Gets the text tag of this . |
| String | Gets the type of this object. |
|
| Hides the popup. |
|
| Sets whether opening and closing the is animated. |
|
| Enable or disable the autoHide feature. |
|
| Enable or disable a "glass" pane. |
|
| Set the style name of the glass panel. |
|
| Sets the HTML content of this . |
|
| Sets the height of this . |
|
| Sets the id of this . |
|
| Set the layout for this . |
|
| Sets whether this is in "modal" mode. |
|
| Sets the size of this in pixels. |
|
| Sets the popup's position relative to the browser's client area. |
|
| Set the popup position. |
|
| When enabled, the will preview all native events, even if another popup
was opened after this one. |
|
| Sets the size of this . |
|
| Sets one of this 's style attributes to a new value. |
|
| Sets this 's style attributes. |
|
| Sets the style name of this . |
|
| Sets the primary style name of this . |
|
| Sets the text tag of this . |
|
| Sets the text inside the caption. |
|
| Sets the hover title of this . |
|
| Sets whether this is visible. |
|
| Sets the widget inside this , removing anything previously there. |
|
| Sets the width of this . |
|
| Shows the popup. |
Deprecated methods
add(widget)
add(widget)
addAutoHidePartner(partner)
addAutoHidePartner(partner)
addCloseHandler(handler)
addCloseHandler(handler)
Deprecated. This function is deprecated and should not be used in new scripts.
Add a handler for close events.
Note that you can have multiple handlers for the same event on the same widget. They will be
called in the order that they were added to the widget, although
s may appear to happen
simultaneously.
ServerHandler
The handler passes back some information to the server about what happened. This information can be accessed as follows:
function doGet() { var app = UiApp.createApplication(); var item1 = app.createTreeItem("item1"); item1.addItem(app.createTreeItem("item2")); var tree = app.createTree(); tree.addItem(item1); var handler = app.createServerHandler("handlerFunction"); tree.addCloseHandler(handler) app.add(tree); return app; } function handlerFunction(eventInfo) { var parameter = eventInfo.parameter; // the type of event, in this case "close". var eventType = parameter.eventType; // the id of the widget that fired this event. var source = parameter.source; }In addition, the values of certain widgets can be sent up with the event as well as "callback elements." See the documentation of
ServerHandler
for more information.Parameters
Name | Type | Description |
---|---|---|
handler |
| the handler to execute when the event occurs. This can be a or a . |
Return
addStyleDependentName(styleName)
addStyleDependentName(styleName)
Deprecated. This function is deprecated and should not be used in new scripts.
Sets the dependent style name of this
.
DialogBox
This is useful for debugging but is otherwise of minimal use since there is no way to use custom stylesheets in UiApp.
Parameters
Name | Type | Description |
---|---|---|
styleName | String | the new style name. |
Return
addStyleName(styleName)
addStyleName(styleName)
Deprecated. This function is deprecated and should not be used in new scripts.
Adds a style name to this
.
DialogBox
This is useful for debugging but is otherwise of minimal use since there is no way to use custom stylesheets in UiApp.
Parameters
Name | Type | Description |
---|---|---|
styleName | String | the new style name. |
Return
clear()
clear()
getId()
getId()
Deprecated. This function is deprecated and should not be used in new scripts.
Returns the id that has been assigned to this object.
This can be used in conjunction with app.getElementById() to retrieve a reference to this object.
Return
String
— the id that has been assigned to this object
getTag()
getTag()
Deprecated. This function is deprecated and should not be used in new scripts.
Gets the text tag of this
.DialogBox
Return
String
— the text tag.
getType()
getType()
Deprecated. This function is deprecated and should not be used in new scripts.
Gets the type of this object.
Return
String
— the object type
hide()
hide()
setAnimationEnabled(animationEnabled)
setAnimationEnabled(animationEnabled)
setAutoHideEnabled(enabled)
setAutoHideEnabled(enabled)
Deprecated. This function is deprecated and should not be used in new scripts.
Enable or disable the autoHide feature.
When enabled, the
will be automatically hidden when the user clicks
outside of it.DialogBox
Parameters
Name | Type | Description |
---|---|---|
enabled | Boolean | whether auto-hiding should be enabled. |
Return
setGlassEnabled(enabled)
setGlassEnabled(enabled)
Deprecated. This function is deprecated and should not be used in new scripts.
Enable or disable a "glass" pane.
When enabled, the background will be blocked with a semi-transparent pane the next time it
is shown. If the
is already visible, the glass will not be displayed
until it is hidden and shown again.DialogBox
Parameters
Name | Type | Description |
---|---|---|
enabled | Boolean | whether the glass panel should be enabled. |
Return
setGlassStyleName(styleName)
setGlassStyleName(styleName)
setHTML(html)
setHTML(html)
setHeight(height)
setHeight(height)
setId(id)
setId(id)
setLayoutData(layout)
setLayoutData(layout)
setModal(modal)
setModal(modal)
Deprecated. This function is deprecated and should not be used in new scripts.
Sets whether this
is in "modal" mode.
DialogBox
When the
is modal, keyboard or mouse events that do not target the
PopupPanel or its children will be ignored.DialogBox
Parameters
Name | Type | Description |
---|---|---|
modal | Boolean | whether the should be modal. |
Return
setPixelSize(width, height)
setPixelSize(width, height)
setPopupPosition(left, top)
setPopupPosition(left, top)
Deprecated. This function is deprecated and should not be used in new scripts.
Sets the popup's position relative to the browser's client area.
The popup's position may be set before calling show().
Parameters
Name | Type | Description |
---|---|---|
left | Integer | the popup's left, in pixels. |
top | Integer | the popup's top, in pixels. |
Return
setPopupPositionAndShow(a)
setPopupPositionAndShow(a)
setPreviewingAllNativeEvents(previewing)
setPreviewingAllNativeEvents(previewing)
Deprecated. This function is deprecated and should not be used in new scripts.
When enabled, the
will preview all native events, even if another popup
was opened after this one.
DialogBox
What this practically means is that if autoHide is enabled, enabling this feature will cause
the
to autoHide even if another non-modal popup was shown after it. If
this feature is disabled, the DialogBox
will only autoHide if it was the last
popup opened.DialogBox
Parameters
Name | Type | Description |
---|---|---|
previewing | Boolean | whether to preview all native events. |
Return
setSize(width, height)
setSize(width, height)
Deprecated. This function is deprecated and should not be used in new scripts.
Sets the size of this
.DialogBox
Parameters
Name | Type | Description |
---|---|---|
width | String | the new width in any CSS unit such as "10px" or "50%". |
height | String | the new height in any CSS unit such as "10px" or "50%". |
Return
setStyleAttribute(attribute, value)
setStyleAttribute(attribute, value)
Deprecated. This function is deprecated and should not be used in new scripts.
Sets one of this
's style attributes to a new value. Valid attributes are listed here; the values for each attribute are the
same as those available in CSS style sheets.
DialogBox
// Change the widget's background to black and text color to green. widget.setStyleAttribute("background", "black") .setStyleAttribute("color", "green");
Parameters
Name | Type | Description |
---|---|---|
attribute | String | the CSS attribute, in camel-case ("fontSize", not "font-size"), as listed here |
value | String | the CSS value |
Return
setStyleAttributes(attributes)
setStyleAttributes(attributes)
Deprecated. This function is deprecated and should not be used in new scripts.
Sets this
's style attributes. This is a convenience method that is equivalent
to calling setStyleAttribute with every key/value pair in the attributes object. Valid
attributes are listed here; the values for each
attribute are the same as those available in CSS style sheets.
DialogBox
// Change the widget's background to black and text color to green. widget.setStyleAttributes({background: "black", color: "green"});
Parameters
Name | Type | Description |
---|---|---|
attributes | Object | an object of key/value pairs for the CSS attributes and values to set; valid attributes are listed here |
Return
setStyleName(styleName)
setStyleName(styleName)
Deprecated. This function is deprecated and should not be used in new scripts.
Sets the style name of this
.
DialogBox
This is useful for debugging but is otherwise of minimal use since there is no way to use custom stylesheets in UiApp.
Parameters
Name | Type | Description |
---|---|---|
styleName | String | the new style name. |
Return
setStylePrimaryName(styleName)
setStylePrimaryName(styleName)
Deprecated. This function is deprecated and should not be used in new scripts.
Sets the primary style name of this
.
DialogBox
This is useful for debugging but is otherwise of minimal use since there is no way to use custom stylesheets in UiApp.
Parameters
Name | Type | Description |
---|---|---|
styleName | String | the new style name. |
Return
setTag(tag)
setTag(tag)
setText(text)
setText(text)
setTitle(title)
setTitle(title)
setVisible(visible)
setVisible(visible)
setWidget(widget)
setWidget(widget)
setWidth(width)
setWidth(width)