add(widget)

Add a widget to the DialogBox.

Parameters

Return

DialogBox — the DialogBox itself, useful for chaining.

addCloseHandler(handler)

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:

 {code
 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;
 }
 }

Parameters

Return

DialogBox — the DialogBox itself, useful for chaining.

addStyleDependentName(styleName)

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

Return

DialogBox — the DialogBox itself, useful for chaining.

addStyleName(styleName)

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

Return

DialogBox — the DialogBox itself, useful for chaining.

clear()

Remove all widgets from the DialogBox.

Return

DialogBox — the DialogBox itself, useful for chaining.

getId()

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

Gets the text tag of this DialogBox.

Return

String — the text tag.

getType()

Gets the type of this object.

Return

String — the object type

hide()

Hides the popup.

Return

DialogBox — the DialogBox itself, useful for chaining.

setAnimationEnabled(animationEnabled)

Sets whether opening and closing the DialogBox is animated.

Parameters

Return

DialogBox — the DialogBox itself, useful for chaining.

setAutoHideEnabled(enabled)

Enable or disable the autoHide feature.

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

Parameters

Return

DialogBox — the DialogBox itself, useful for chaining.

setGlassEnabled(enabled)

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

Parameters

Return

DialogBox — the DialogBox itself, useful for chaining.

setHTML(html)

Sets the HTML content of this DialogBox.

Parameters

Return

DialogBox — the DialogBox itself, useful for chaining.

setHeight(height)

Sets the height of this DialogBox.

Parameters

Return

DialogBox — the DialogBox itself, useful for chaining.

setId(id)

Sets the id of this DialogBox.

Parameters

Return

DialogBox — the DialogBox itself, useful for chaining.

setModal(modal)

Sets whether this DialogBox is in "modal" mode.

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

Parameters

Return

DialogBox — the DialogBox itself, useful for chaining.

setPixelSize(width, height)

Sets the size of this DialogBox in pixels.

Parameters

Return

DialogBox — the DialogBox itself, useful for chaining.

setPopupPosition(left, top)

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

The popup's position may be set before calling show().

Parameters

Return

DialogBox — the DialogBox itself, useful for chaining.

setPreviewingAllNativeEvents(previewing)

When enabled, the DialogBox 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 DialogBox 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.

Parameters

Return

DialogBox — the DialogBox itself, useful for chaining.

setSize(width, height)

Sets the size of this DialogBox.

Parameters

Return

DialogBox — the DialogBox itself, useful for chaining.

setStyleAttribute(attribute, value)

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

Return

DialogBox — the DialogBox itself, useful for chaining.

setStyleAttributes(attributes)

Sets this DialogBox'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

Return

DialogBox — the DialogBox itself, useful for chaining.

setStyleName(styleName)

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

Return

DialogBox — the DialogBox itself, useful for chaining.

setStylePrimaryName(styleName)

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

Return

DialogBox — the DialogBox itself, useful for chaining.

setTag(tag)

Sets the text tag of this DialogBox.

Parameters

Return

DialogBox — the DialogBox itself, useful for chaining.

setText(text)

Sets the text inside the caption.

Parameters

Return

DialogBox — the DialogBox itself, useful for chaining.

setTitle(title)

Sets the hover title of this DialogBox.

Not all browsers will show this.

Parameters

Return

DialogBox — the DialogBox itself, useful for chaining.

setVisible(visible)

Sets whether this DialogBox is visible.

Parameters

Return

DialogBox — the DialogBox itself, useful for chaining.

setWidget(widget)

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

Parameters

Return

DialogBox — the DialogBox itself, useful for chaining.

setWidth(width)

Sets the width of this DialogBox.

Parameters

Return

DialogBox — the DialogBox itself, useful for chaining.

show()

Shows the popup.

Return

DialogBox — the DialogBox itself, useful for chaining.