DialogBox

Class Overview

A form of popup that has a caption area at the top and can be dragged by the user. Unlike a PopupPanel, calls to setWidth(String) and setHeight(String) will set the width and height of the dialog box itself, even if a widget has not been added as yet.

CSS Style Rules

• .gwt-DialogBox { the outside of the dialog }
• .gwt-DialogBox .Caption { the caption }
• .gwt-DialogBox .dialogContent { the wrapper around the content }
• .gwt-DialogBox .dialogTopLeft { the top left cell }
• .gwt-DialogBox .dialogTopLeftInner { the inner element of the cell }
• .gwt-DialogBox .dialogTopCenter { the top center cell, where the caption is located }
• .gwt-DialogBox .dialogTopCenterInner { the inner element of the cell }
• .gwt-DialogBox .dialogTopRight { the top right cell }
• .gwt-DialogBox .dialogTopRightInner { the inner element of the cell }
• .gwt-DialogBox .dialogMiddleLeft { the middle left cell }
• .gwt-DialogBox .dialogMiddleLeftInner { the inner element of the cell }
• .gwt-DialogBox .dialogMiddleCenter { the middle center cell, where the content is located }
• .gwt-DialogBox .dialogMiddleCenterInner { the inner element of the cell }
• .gwt-DialogBox .dialogMiddleRight { the middle right cell }
• .gwt-DialogBox .dialogMiddleRightInner { the inner element of the cell }
• .gwt-DialogBox .dialogBottomLeft { the bottom left cell }
• .gwt-DialogBox .dialogBottomLeftInner { the inner element of the cell }
• .gwt-DialogBox .dialogBottomCenter { the bottom center cell }
• .gwt-DialogBox .dialogBottomCenterInner { the inner element of the cell }
• .gwt-DialogBox .dialogBottomRight { the bottom right cell }
• .gwt-DialogBox .dialogBottomRightInner { the inner element of the cell }

Example

Use in UiBinder Templates

DialogBox elements in UiBinder templates can have one widget child and one <g:caption> child. (Note the lower case "c", meant to signal that the caption is not a runtime object, and so cannot have a ui:field attribute.) The body of the caption can be html.

For example:

 <g:DialogBox autoHide="true" modal="true">
   <g:caption><b>Caption text</b></g:caption>
   <g:HTMLPanel>
     Body text
     <g:Button ui:field='cancelButton'>Cancel</g:Button>
     <g:Button ui:field='okButton'>Okay</g:Button>
   </g:HTMLPanel>
 </g:DialogBox>
 

Summary

[Expand] Inherited Constants
From class com.google.gwt.user.client.ui.UIObject String DEBUG_ID_PREFIX

[Expand] Inherited Methods
From class com.google.gwt.user.client.ui.DecoratedPopupPanel void clear() Removes all child widgets. void doAttachChildren() If a widget contains one or more child widgets that are not in the logical widget hierarchy (the child is physically connected only on the DOM level), it must override this method and call onAttach() for each of its child widgets. void doDetachChildren() If a widget contains one or more child widgets that are not in the logical widget hierarchy (the child is physically connected only on the DOM level), it must override this method and call onDetach() for each of its child widgets. Element getCellElement(int row, int cell) Get a specific Element from the panel. Widget getWidget() Gets the panel's child widget. Iterator<Widget> iterator() boolean remove(Widget w) Removes a child widget. void setWidget(Widget w) Sets this panel's widget.
From class com.google.gwt.user.client.ui.PopupPanel void addAutoHidePartner(Element partner) Mouse events that occur within an autoHide partner will not hide a panel set to autoHide. HandlerRegistration addCloseHandler(CloseHandler<PopupPanel> handler) void addPopupListener(PopupListener listener) This method is deprecated. Use addCloseHandler(CloseHandler) instead void center() Centers the popup in the browser window and shows it. Element getContainerElement() Override this method to specify that an element other than the root element be the container for the panel's child widget. Element getGlassElement() Get the glass element used by this PopupPanel. String getGlassStyleName() Gets the style name to be used on the glass element. int getOffsetHeight() Gets the panel's offset height in pixels. int getOffsetWidth() Gets the panel's offset width in pixels. int getPopupLeft() Gets the popup's left position relative to the browser's client area. int getPopupTop() Gets the popup's top position relative to the browser's client area. Element getStyleElement() Template method that returns the element to which style names will be applied. String getTitle() Gets the title associated with this object. void hide() Hides the popup and detaches it from the page. void hide(boolean autoClosed) Hides the popup and detaches it from the page. boolean isAnimationEnabled() Returns true if animations are enabled, false if not. boolean isAutoHideEnabled() Returns true if the popup should be automatically hidden when the user clicks outside of it. boolean isAutoHideOnHistoryEventsEnabled() Returns true if the popup should be automatically hidden when the history token changes, such as when the user presses the browser's back button. boolean isGlassEnabled() Returns true if a glass element will be displayed under the PopupPanel. boolean isModal() Returns true if keyboard or mouse events that do not target the PopupPanel or its children should be ignored. boolean isPreviewingAllNativeEvents() Returns true if the popup should preview all native events, even if the event has already been consumed by another popup. boolean isShowing() Determines whether or not this popup is showing. boolean isVisible() Determines whether or not this popup is visible. boolean onEventPreview(Event event) This method is deprecated. Use onPreviewNativeEvent(Event.NativePreviewEvent) instead boolean onKeyDownPreview(char key, int modifiers) This method is deprecated. Use onPreviewNativeEvent(Event.NativePreviewEvent) instead boolean onKeyPressPreview(char key, int modifiers) This method is deprecated. Use onPreviewNativeEvent(Event.NativePreviewEvent) instead boolean onKeyUpPreview(char key, int modifiers) This method is deprecated. Use onPreviewNativeEvent(Event.NativePreviewEvent) instead void onPreviewNativeEvent(Event.NativePreviewEvent event) void onUnload() This method is called immediately before a widget will be detached from the browser's document. void removeAutoHidePartner(Element partner) Remove an autoHide partner. void removePopupListener(PopupListener listener) This method is deprecated. Use the removeHandler() method on the object returned by addCloseHandler(CloseHandler) instead void setAnimationEnabled(boolean enable) Enable or disable animations. void setAutoHideEnabled(boolean autoHide) Enable or disable the autoHide feature. void setAutoHideOnHistoryEventsEnabled(boolean enabled) Enable or disable autoHide on history change events. void setGlassEnabled(boolean enabled) When enabled, the background will be blocked with a semi-transparent pane the next time it is shown. void setGlassStyleName(String glassStyleName) Sets the style name to be used on the glass element. void setHeight(String height) Sets the height of the panel's child widget. void setModal(boolean modal) When the popup is modal, keyboard or mouse events that do not target the PopupPanel or its children will be ignored. void setPopupPosition(int left, int top) Sets the popup's position relative to the browser's client area. void setPopupPositionAndShow(PopupPanel.PositionCallback callback) Sets the popup's position using a PopupPanel.PositionCallback, and shows the popup. void setPreviewingAllNativeEvents(boolean previewAllNativeEvents) When enabled, the popup will preview all native events, even if another popup was opened after this one. void setTitle(String title) Sets the title associated with this object. void setVisible(boolean visible) Sets whether this object is visible. void setWidget(Widget w) Sets this panel's widget. void setWidth(String width) Sets the width of the panel's child widget. void show() Shows the popup and attach it to the page. final void showRelativeTo(UIObject target) Normally, the popup is positioned directly below the relative target, with its left edge aligned with the left edge of the target.
From class com.google.gwt.user.client.ui.SimplePanel void add(Widget w) Adds a widget to this panel. Element getContainerElement() Override this method to specify that an element other than the root element be the container for the panel's child widget. Widget getWidget() Gets the panel's child widget. Iterator<Widget> iterator() boolean remove(Widget w) Removes a child widget. void setWidget(IsWidget w) Set the only widget of the receiver, replacing the previous widget if there was one. void setWidget(Widget w) Sets this panel's widget.
From class com.google.gwt.user.client.ui.Panel void add(IsWidget child) void add(Widget child) Adds a child widget. final void adopt(Widget child) Finalize the attachment of a Widget to this Panel. void adopt(Widget w, Element container) This method is deprecated. Use adopt(Widget). void clear() Removes all child widgets. void disown(Widget w) This method is deprecated. Use orphan(Widget). void doAttachChildren() If a widget contains one or more child widgets that are not in the logical widget hierarchy (the child is physically connected only on the DOM level), it must override this method and call onAttach() for each of its child widgets. void doDetachChildren() If a widget contains one or more child widgets that are not in the logical widget hierarchy (the child is physically connected only on the DOM level), it must override this method and call onDetach() for each of its child widgets. final void orphan(Widget child) This method must be called as part of the remove method of any Panel. abstract boolean remove(Widget child) Removes a child widget. boolean remove(IsWidget child)
From class com.google.gwt.user.client.ui.Widget HandlerRegistration addAttachHandler(AttachEvent.Handler handler) Adds an AttachEvent handler. final <H extends EventHandler> HandlerRegistration addDomHandler(H handler, Type<H> type) Adds a native event handler to the widget and sinks the corresponding native event. final <H extends EventHandler> HandlerRegistration addHandler(H handler, Type<H> type) Adds this handler to the widget. Widget asWidget() Returns the Widget aspect of the receiver. static Widget asWidgetOrNull(IsWidget w) This convenience method makes a null-safe call to asWidget(). HandlerManager createHandlerManager() Creates the HandlerManager used by this Widget. void delegateEvent(Widget target, GwtEvent<?> event) Fires an event on a child widget. void doAttachChildren() If a widget contains one or more child widgets that are not in the logical widget hierarchy (the child is physically connected only on the DOM level), it must override this method and call onAttach() for each of its child widgets. void doDetachChildren() If a widget contains one or more child widgets that are not in the logical widget hierarchy (the child is physically connected only on the DOM level), it must override this method and call onDetach() for each of its child widgets. void fireEvent(GwtEvent<?> event) Fires the given event to the handlers listening to the event's type. int getHandlerCount(Type<?> type) Gets the number of handlers listening to the event type. Object getLayoutData() Gets the panel-defined layout data associated with this widget. Widget getParent() Gets this widget's parent panel. boolean isAttached() Determines whether this widget is currently attached to the browser's document (i.e., there is an unbroken chain of widgets between this widget and the underlying browser document). final boolean isOrWasAttached() Has this widget ever been attached? void onAttach() This method is called when a widget is attached to the browser's document. void onBrowserEvent(Event event) Fired whenever a browser event is received. void onDetach() This method is called when a widget is detached from the browser's document. void onLoad() This method is called immediately after a widget becomes attached to the browser's document. void onUnload() This method is called immediately before a widget will be detached from the browser's document. void removeFromParent() Removes this widget from its parent widget, if one exists. void setLayoutData(Object layoutData) Sets the panel-defined layout data associated with this widget. void sinkEvents(int eventBitsToAdd) Overridden to defer the call to super.sinkEvents until the first time this widget is attached to the dom, as a performance enhancement.
From class com.google.gwt.user.client.ui.UIObject void addStyleDependentName(String styleSuffix) Adds a dependent style name by specifying the style name's suffix. void addStyleName(String style) Adds a secondary or dependent style name to this object. static void ensureDebugId(Element elem, String baseID, String id) Set the debug id of a specific element. final void ensureDebugId(String id) Ensure that the main Element for this UIObject has an ID property set, which allows it to integrate with third-party libraries and test tools. static void ensureDebugId(Element elem, String id) Ensure that elem has an ID property set, which allows it to integrate with third-party libraries and test tools. int getAbsoluteLeft() Gets the object's absolute left position in pixels, as measured from the browser window's client area. int getAbsoluteTop() Gets the object's absolute top position in pixels, as measured from the browser window's client area. Element getElement() Gets a handle to the object's underlying DOM element. int getOffsetHeight() Gets the object's offset height in pixels. int getOffsetWidth() Gets the object's offset width in pixels. Element getStyleElement() Template method that returns the element to which style names will be applied. String getStyleName() Gets all of the object's style names, as a space-separated list. static String getStyleName(Element elem) Gets all of the element's style names, as a space-separated list. String getStylePrimaryName() Gets the primary style name associated with the object. static String getStylePrimaryName(Element elem) Gets the element's primary style name. String getTitle() Gets the title associated with this object. boolean isVisible() Determines whether or not this object is visible. static boolean isVisible(Element elem) void onEnsureDebugId(String baseID) Called when the user sets the id using the ensureDebugId(String) method. void removeStyleDependentName(String styleSuffix) Removes a dependent style name by specifying the style name's suffix. void removeStyleName(String style) Removes a style name. final void setElement(Element elem) Sets this object's browser element. void setElement(Element elem) Sets this object's browser element. 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 setSize(String width, String height) Sets the object's size. void setStyleDependentName(String styleSuffix, boolean add) Adds or removes a dependent style name by specifying the style name's suffix. static void setStyleName(Element elem, String styleName) Clears all of the element's style names and sets it to the given style. static void setStyleName(Element elem, String style, boolean add) This convenience method adds or removes a style name for a given element. void setStyleName(String style) Clears all of the object's style names and sets it to the given style. void setStyleName(String style, boolean add) Adds or removes a style name. void setStylePrimaryName(String style) Sets the object's primary style name and updates all dependent style names. static void setStylePrimaryName(Element elem, String style) Sets the element's primary style name and updates all dependent style names. void setTitle(String title) Sets the title associated with this object. void setVisible(boolean visible) Sets whether this object is visible. static void setVisible(Element elem, boolean visible) void setWidth(String width) Sets the object's width. void sinkEvents(int eventBitsToAdd) Adds a set of events to be sunk by this object. String toString() This method is overridden so that any object can be viewed in the debugger as an HTML snippet. void unsinkEvents(int eventBitsToRemove) Removes a set of events from this object's event list.
From class java.lang.Object Object clone() boolean equals(Object arg0) void finalize() final Class<?> getClass() int hashCode() final void notify() final void notifyAll() String toString() final void wait() final void wait(long arg0, int arg1) final void wait(long arg0)
From interface com.google.gwt.event.logical.shared.HasAttachHandlers abstract HandlerRegistration addAttachHandler(AttachEvent.Handler handler) Adds an AttachEvent handler.
From interface com.google.gwt.event.logical.shared.HasCloseHandlers abstract HandlerRegistration addCloseHandler(CloseHandler<T> handler) Adds a CloseEvent handler.
From interface com.google.gwt.event.shared.HasHandlers abstract void fireEvent(GwtEvent<?> event) Fires the given event to the handlers listening to the event's type.
From interface com.google.gwt.safehtml.client.HasSafeHtml abstract void setHTML(SafeHtml html) Sets this object's contents via known-safe HTML.
From interface com.google.gwt.user.client.EventListener abstract void onBrowserEvent(Event event) Fired whenever a browser event is received.
From interface com.google.gwt.user.client.EventPreview abstract boolean onEventPreview(Event event) This method is deprecated. replaced by onPreviewNativeEvent(com.google.gwt.user.client.Event.NativePreviewEvent)
From interface com.google.gwt.user.client.ui.AcceptsOneWidget abstract void setWidget(IsWidget w) Set the only widget of the receiver, replacing the previous widget if there was one.
From interface com.google.gwt.user.client.ui.HasAnimation abstract boolean isAnimationEnabled() Returns true if animations are enabled, false if not. abstract void setAnimationEnabled(boolean enable) Enable or disable animations.
From interface com.google.gwt.user.client.ui.HasHTML abstract String getHTML() Gets this object's contents as HTML. abstract void setHTML(String html) Sets this object's contents via HTML.
From interface com.google.gwt.user.client.ui.HasOneWidget abstract Widget getWidget() Gets the panel's child widget. abstract void setWidget(Widget w) Sets this panel's widget.
From interface com.google.gwt.user.client.ui.HasText abstract String getText() Gets this object's text. abstract void setText(String text) Sets this object's text.
From interface com.google.gwt.user.client.ui.HasWidgets abstract void add(Widget w) Adds a child widget. abstract void clear() Removes all child widgets. abstract Iterator<Widget> iterator() Gets an iterator for the contained widgets. abstract boolean remove(Widget w) Removes a child widget.
From interface com.google.gwt.user.client.ui.HasWidgets.ForIsWidget abstract void add(IsWidget w) abstract boolean remove(IsWidget w)
From interface com.google.gwt.user.client.ui.IsWidget abstract Widget asWidget() Returns the Widget aspect of the receiver.
From interface com.google.gwt.user.client.ui.MouseListener abstract void onMouseDown(Widget sender, int x, int y) This method is deprecated. use onMouseDown(com.google.gwt.event.dom.client.MouseDownEvent) instead abstract void onMouseEnter(Widget sender) This method is deprecated. use onMouseOver(com.google.gwt.event.dom.client.MouseOverEvent) instead abstract void onMouseLeave(Widget sender) This method is deprecated. use onMouseOut(com.google.gwt.event.dom.client.MouseOutEvent) instead abstract void onMouseMove(Widget sender, int x, int y) This method is deprecated. use onMouseMove(com.google.gwt.event.dom.client.MouseMoveEvent) instead abstract void onMouseUp(Widget sender, int x, int y) This method is deprecated. use onMouseUp(com.google.gwt.event.dom.client.MouseUpEvent) instead
From interface com.google.gwt.user.client.ui.SourcesPopupEvents abstract void addPopupListener(PopupListener listener) This method is deprecated. use addCloseHandler(CloseHandler) instead abstract void removePopupListener(PopupListener listener) This method is deprecated. Use the removeHandler() method on the object returned by addCloseHandler(CloseHandler) instead
From interface java.lang.Iterable abstract Iterator<T> iterator()