org.xwiki.gwt.user.client.ui

Class ComplexDialogBox

java.lang.Object

com.google.gwt.user.client.ui.UIObject

com.google.gwt.user.client.ui.Widget

com.google.gwt.user.client.ui.Composite

org.xwiki.gwt.user.client.ui.CompositeDialogBox

org.xwiki.gwt.user.client.ui.ComplexDialogBox

All Implemented Interfaces:

com.google.gwt.event.logical.shared.CloseHandler<com.google.gwt.user.client.ui.PopupPanel>, com.google.gwt.event.logical.shared.HasAttachHandlers, com.google.gwt.event.logical.shared.HasCloseHandlers<CompositeDialogBox>, com.google.gwt.event.shared.EventHandler, com.google.gwt.event.shared.HasHandlers, com.google.gwt.user.client.EventListener, com.google.gwt.user.client.ui.HasVisibility, com.google.gwt.user.client.ui.IsRenderable, com.google.gwt.user.client.ui.IsWidget

Direct Known Subclasses:

WizardDialog

public class ComplexDialogBox
extends CompositeDialogBox

A dialog box that can be part of a wizard and whose content is structured in three parts: the header, the body and the footer. The header usually contains the title of the dialog and optional wizard navigation buttons (back and forth). The body contains the widgets for acquiring user data. The footer usually contains buttons for closing the dialog or ending the wizard.

Version:

$Id: 9b5ba26576ee1a12930403ad492716303f6643c9 $

Nested Class Summary

Nested classes/interfaces inherited from class com.google.gwt.user.client.ui.UIObject

com.google.gwt.user.client.ui.UIObject.DebugIdImpl, com.google.gwt.user.client.ui.UIObject.DebugIdImplEnabled

Field Summary

Fields inherited from class com.google.gwt.user.client.ui.UIObject

DEBUG_ID_PREFIX

Constructor Summary

Constructors

Constructor and Description
ComplexDialogBox(boolean autoHide, boolean modal) Creates a new complex dialog box.

Method Summary

Modifier and Type	Method and Description
void	center() Centers this dialog on the screen.
protected com.google.gwt.user.client.ui.FlowPanel	getBody()
protected com.google.gwt.user.client.ui.FlowPanel	getFooter()
protected com.google.gwt.user.client.ui.FlowPanel	getHeader()
boolean	isCanceled()
protected boolean	isLoading()
protected void	setCanceled(boolean canceled) Sets the canceled state of this dialog.
protected void	setLoading(boolean loading) Puts the dialog in loading state or get it out of it.
protected void	showError(Throwable caught) If an error occurred on the server while fulfilling the request then this method can be used to display the error message to the user.

Methods inherited from class org.xwiki.gwt.user.client.ui.CompositeDialogBox

addCloseHandler, getDialog, hide, initWidget, isShowing, onClose

Methods inherited from class com.google.gwt.user.client.ui.Composite

claimElement, getWidget, initializeClaimedElement, isAttached, onAttach, onBrowserEvent, onDetach, render, render, resolvePotentialElement, setWidget

Methods inherited from class com.google.gwt.user.client.ui.Widget

addAttachHandler, addBitlessDomHandler, addDomHandler, addHandler, asWidget, asWidgetOrNull, createHandlerManager, delegateEvent, doAttachChildren, doDetachChildren, fireEvent, getHandlerCount, getLayoutData, getParent, isOrWasAttached, onLoad, onUnload, removeFromParent, setLayoutData, sinkEvents, unsinkEvents

Methods inherited from class com.google.gwt.user.client.ui.UIObject

addStyleDependentName, addStyleName, ensureDebugId, ensureDebugId, ensureDebugId, getAbsoluteLeft, getAbsoluteTop, getElement, getOffsetHeight, getOffsetWidth, getStyleElement, getStyleName, getStyleName, getStylePrimaryName, getStylePrimaryName, getTitle, isVisible, isVisible, onEnsureDebugId, removeStyleDependentName, removeStyleName, setElement, setElement, setHeight, setPixelSize, setSize, setStyleDependentName, setStyleName, setStyleName, setStyleName, setStyleName, setStylePrimaryName, setStylePrimaryName, setTitle, setVisible, setVisible, setWidth, sinkBitlessEvent, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.gwt.event.shared.HasHandlers

fireEvent

Constructor Detail

ComplexDialogBox

public ComplexDialogBox(boolean autoHide,
                        boolean modal)

Creates a new complex dialog box.

Parameters:

autoHide - Whether or not the dialog should auto hide when the user clicks outside of it.

modal - Specifies if the dialog box can loose focus.

Method Detail

getHeader

protected com.google.gwt.user.client.ui.FlowPanel getHeader()

Returns:

header

getBody

protected com.google.gwt.user.client.ui.FlowPanel getBody()

Returns:

body

getFooter

protected com.google.gwt.user.client.ui.FlowPanel getFooter()

Returns:

footer

center

public void center()

Description copied from class: CompositeDialogBox

Centers this dialog on the screen.

Overrides:

center in class CompositeDialogBox

See Also:

PopupPanel.center()

isCanceled

public boolean isCanceled()

Returns:

true if this dialog was canceled, false otherwise

setCanceled

protected void setCanceled(boolean canceled)

Sets the canceled state of this dialog.

Parameters:

canceled - true if the dialog was canceled, false otherwise

isLoading

protected boolean isLoading()

Returns:

true if the dialog is in loading state, false otherwise

setLoading

protected void setLoading(boolean loading)

Puts the dialog in loading state or get it out of it.

Parameters:

loading - true to put the dialog in loading state, false to get it out of it

showError

protected void showError(Throwable caught)

If an error occurred on the server while fulfilling the request then this method can be used to display the error message to the user.

Parameters:

caught - the exception that has been caught