Class PopupPanel | Apps Script

Deprecated. The UI service was deprecated on December 11, 2014. To create user interfaces, use the HTML service instead.

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

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 show() and hide() methods to show and hide it. See the example below.

To make the popup stay at a fixed location rather than scrolling with the page, try setting the 'position', 'fixed' style on it with setStyleAttribute(attribute, value).

Note that this panel can contain at most one direct child widget. To add more children, make the child of this panel a different panel that can contain more than one child.

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 PopupPanel documentation here.

Here is an example showing how to use the popup panel widget:

function doGet() {
  var app = UiApp.createApplication();
  // Create a popup panel and set it to be modal.
  var popupPanel = app.createPopupPanel(false, true);
  // Add a button to the panel and set the dimensions and position.
  popupPanel.add(app.createButton()).setWidth("100px").setHeight("100px")
      .setPopupPosition(100, 100);
  // Show the panel. Note that it does not have to be "added" to the UiInstance.
  popupPanel.show();
  return app;
}

Deprecated methods

Method	Return type	Brief description
`add(widget)`	`PopupPanel`	Add a widget to the `PopupPanel`.
`addAutoHidePartner(partner)`	`PopupPanel`	Set the partner widget for auto-hiding.
`addCloseHandler(handler)`	`PopupPanel`	Add a handler for close events.
`addStyleDependentName(styleName)`	`PopupPanel`	Sets the dependent style name of this `PopupPanel`.
`addStyleName(styleName)`	`PopupPanel`	Adds a style name to this `PopupPanel`.
`clear()`	`PopupPanel`	Remove all widgets from the `PopupPanel`.
`getId()`	`String`	Returns the id that has been assigned to this object.
`getTag()`	`String`	Gets the text tag of this `PopupPanel`.
`getType()`	`String`	Gets the type of this object.
`hide()`	`PopupPanel`	Hides the popup.
`setAnimationEnabled(animationEnabled)`	`PopupPanel`	Sets whether opening and closing the `PopupPanel` is animated.
`setAutoHideEnabled(enabled)`	`PopupPanel`	Enable or disable the autoHide feature.
`setGlassEnabled(enabled)`	`PopupPanel`	Enable or disable a "glass" pane.
`setGlassStyleName(styleName)`	`PopupPanel`	Set the style name of the glass panel.
`setHeight(height)`	`PopupPanel`	Sets the height of this `PopupPanel`.
`setId(id)`	`PopupPanel`	Sets the id of this `PopupPanel`.
`setLayoutData(layout)`	`PopupPanel`	Set the layout for this `PopupPanel`.
`setModal(modal)`	`PopupPanel`	Sets whether this `PopupPanel` is in "modal" mode.
`setPixelSize(width, height)`	`PopupPanel`	Sets the size of this `PopupPanel` in pixels.
`setPopupPosition(left, top)`	`PopupPanel`	Sets the popup's position relative to the browser's client area.
`setPopupPositionAndShow(a)`	`PopupPanel`	Set the popup position.
`setPreviewingAllNativeEvents(previewing)`	`PopupPanel`	When enabled, the `PopupPanel` will preview all native events, even if another popup was opened after this one.
`setSize(width, height)`	`PopupPanel`	Sets the size of this `PopupPanel`.
`setStyleAttribute(attribute, value)`	`PopupPanel`	Sets one of this `PopupPanel`'s style attributes to a new value.
`setStyleAttributes(attributes)`	`PopupPanel`	Sets this `PopupPanel`'s style attributes.
`setStyleName(styleName)`	`PopupPanel`	Sets the style name of this `PopupPanel`.
`setStylePrimaryName(styleName)`	`PopupPanel`	Sets the primary style name of this `PopupPanel`.
`setTag(tag)`	`PopupPanel`	Sets the text tag of this `PopupPanel`.
`setTitle(title)`	`PopupPanel`	Sets the hover title of this `PopupPanel`.
`setVisible(visible)`	`PopupPanel`	Sets whether this `PopupPanel` is visible.
`setWidget(widget)`	`PopupPanel`	Sets the widget inside this `PopupPanel`, removing anything previously there.
`setWidth(width)`	`PopupPanel`	Sets the width of this `PopupPanel`.
`show()`	`PopupPanel`	Shows the popup.

Deprecated methods

`add(widget)`

Deprecated. This function is deprecated and should not be used in new scripts.

Add a widget to the PopupPanel.

Parameters

Name	Type	Description
`widget`	`Widget`	the widget to add.

Return

PopupPanel — the PopupPanel itself, useful for chaining.

`addAutoHidePartner(partner)`

Deprecated. This function is deprecated and should not be used in new scripts.

Set the partner widget for auto-hiding.

This is not currently functional.

Parameters

Name	Type	Description
`partner`	`Component`	the partner widget.

Return

PopupPanel — the PopupPanel itself, useful for chaining.

`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 ServerHandlers may appear to happen simultaneously.

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`	`Handler`	the handler to execute when the event occurs. This can be a `ClientHandler` or a `ServerHandler`.

Return

PopupPanel — the PopupPanel itself, useful for chaining.

`addStyleDependentName(styleName)`

Deprecated. This function is deprecated and should not be used in new scripts.

Sets the dependent style name of this PopupPanel.

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

PopupPanel — the PopupPanel itself, useful for chaining.

`addStyleName(styleName)`

Deprecated. This function is deprecated and should not be used in new scripts.

Adds a style name to this PopupPanel.

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

PopupPanel — the PopupPanel itself, useful for chaining.

`clear()`

Deprecated. This function is deprecated and should not be used in new scripts.

Remove all widgets from the PopupPanel.

Return

PopupPanel — the PopupPanel itself, useful for chaining.

`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()`

Deprecated. This function is deprecated and should not be used in new scripts.

Gets the text tag of this PopupPanel.

Return

String — the text tag.

`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()`

Deprecated. This function is deprecated and should not be used in new scripts.

Hides the popup.

Return

PopupPanel — the PopupPanel itself, useful for chaining.

`setAnimationEnabled(animationEnabled)`

Deprecated. This function is deprecated and should not be used in new scripts.

Sets whether opening and closing the PopupPanel is animated.

Parameters

Name	Type	Description
`animationEnabled`	`Boolean`	whether to animate opening and closing.

Return

PopupPanel — the PopupPanel itself, useful for chaining.

`setAutoHideEnabled(enabled)`

Deprecated. This function is deprecated and should not be used in new scripts.

Enable or disable the autoHide feature.

When enabled, the PopupPanel will be automatically hidden when the user clicks outside of it.

Parameters

Name	Type	Description
`enabled`	`Boolean`	whether auto-hiding should be enabled.

Return

PopupPanel — the PopupPanel itself, useful for chaining.

`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 PopupPanel is already visible, the glass will not be displayed until it is hidden and shown again.

Parameters

Name	Type	Description
`enabled`	`Boolean`	whether the glass panel should be enabled.

Return

PopupPanel — the PopupPanel itself, useful for chaining.

`setGlassStyleName(styleName)`

Deprecated. This function is deprecated and should not be used in new scripts.

Set the style name of the glass panel.

Parameters

Name	Type	Description
`styleName`	`String`	the new style name.

Return

PopupPanel — the PopupPanel itself, useful for chaining.

`setHeight(height)`

Deprecated. This function is deprecated and should not be used in new scripts.

Sets the height of this PopupPanel.

Parameters

Name	Type	Description
`height`	`String`	the new height in any CSS unit such as "10px" or "50%".

Return

PopupPanel — the PopupPanel itself, useful for chaining.

`setId(id)`

Deprecated. This function is deprecated and should not be used in new scripts.

Sets the id of this PopupPanel.

Parameters

Name	Type	Description
`id`	`String`	the new id, which can be used to retrieve the `PopupPanel` from app.getElementById(id).

Return

PopupPanel — the PopupPanel itself, useful for chaining.

`setLayoutData(layout)`

Deprecated. This function is deprecated and should not be used in new scripts.

Set the layout for this PopupPanel.

This is not currently functional.

Parameters

Name	Type	Description
`layout`	`Object`

Return

PopupPanel — the PopupPanel itself, useful for chaining.

`setModal(modal)`

Deprecated. This function is deprecated and should not be used in new scripts.

Sets whether this PopupPanel is in "modal" mode.

When the PopupPanel is modal, keyboard or mouse events that do not target the PopupPanel or its children will be ignored.

Parameters

Name	Type	Description
`modal`	`Boolean`	whether the `PopupPanel` should be modal.

Return

PopupPanel — the PopupPanel itself, useful for chaining.

`setPixelSize(width, height)`

Deprecated. This function is deprecated and should not be used in new scripts.

Sets the size of this PopupPanel in pixels.

Parameters

Name	Type	Description
`width`	`Integer`	the new width in pixels.
`height`	`Integer`	the new height in pixels.

Return

PopupPanel — the PopupPanel itself, useful for chaining.

`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

PopupPanel — the PopupPanel itself, useful for chaining.

`setPopupPositionAndShow(a)`

Deprecated. This function is deprecated and should not be used in new scripts.

Set the popup position.

This is not currently functional.

Parameters

Name	Type	Description
`a`	`Component`

Return

PopupPanel — the PopupPanel itself, useful for chaining.

`setPreviewingAllNativeEvents(previewing)`

Deprecated. This function is deprecated and should not be used in new scripts.

When enabled, the PopupPanel will preview all native events, even if another popup was opened after this one.

What this practically means is that if autoHide is enabled, enabling this feature will cause the PopupPanel to autoHide even if another non-modal popup was shown after it. If this feature is disabled, the PopupPanel will only autoHide if it was the last popup opened.

Parameters

Name	Type	Description
`previewing`	`Boolean`	whether to preview all native events.

Return

PopupPanel — the PopupPanel itself, useful for chaining.

`setSize(width, height)`

Deprecated. This function is deprecated and should not be used in new scripts.

Sets the size of this PopupPanel.

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

PopupPanel — the PopupPanel itself, useful for chaining.

`setStyleAttribute(attribute, value)`

Deprecated. This function is deprecated and should not be used in new scripts.

Sets one of this PopupPanel'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.

// 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

PopupPanel — the PopupPanel itself, useful for chaining.

`setStyleAttributes(attributes)`

Deprecated. This function is deprecated and should not be used in new scripts.

Sets this PopupPanel'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.

// 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

PopupPanel — the PopupPanel itself, useful for chaining.

`setStyleName(styleName)`

Deprecated. This function is deprecated and should not be used in new scripts.

Sets the style name of this PopupPanel.

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

PopupPanel — the PopupPanel itself, useful for chaining.

`setStylePrimaryName(styleName)`

Deprecated. This function is deprecated and should not be used in new scripts.

Sets the primary style name of this PopupPanel.

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

PopupPanel — the PopupPanel itself, useful for chaining.

`setTag(tag)`

Deprecated. This function is deprecated and should not be used in new scripts.

Sets the text tag of this PopupPanel.

Parameters

Name	Type	Description
`tag`	`String`	the new text tag, which can be anything you wish to store with the widget.

Return

PopupPanel — the PopupPanel itself, useful for chaining.

`setTitle(title)`

Deprecated. This function is deprecated and should not be used in new scripts.

Sets the hover title of this PopupPanel.

Not all browsers will show this.

Parameters

Name	Type	Description
`title`	`String`	the hover title.

Return

PopupPanel — the PopupPanel itself, useful for chaining.

`setVisible(visible)`

Deprecated. This function is deprecated and should not be used in new scripts.

Sets whether this PopupPanel is visible.

Parameters

Name	Type	Description
`visible`	`Boolean`	whether this `PopupPanel` should be visible or not.

Return

PopupPanel — the PopupPanel itself, useful for chaining.

`setWidget(widget)`

Deprecated. This function is deprecated and should not be used in new scripts.

Sets the widget inside this PopupPanel, removing anything previously there.

Parameters

Name	Type	Description
`widget`	`Widget`	the widget to put in this `PopupPanel`.

Return

PopupPanel — the PopupPanel itself, useful for chaining.

`setWidth(width)`

Deprecated. This function is deprecated and should not be used in new scripts.

Sets the width of this PopupPanel.

Parameters

Name	Type	Description
`width`	`String`	the new width in any CSS unit such as "10px" or "50%".

Return

PopupPanel — the PopupPanel itself, useful for chaining.

`show()`

Deprecated. This function is deprecated and should not be used in new scripts.

Shows the popup.

Return

PopupPanel — the PopupPanel itself, useful for chaining.