com.vaadin.client.communication

Class DefaultReconnectDialog

java.lang.Object

com.vaadin.client.communication.DefaultReconnectDialog

All Implemented Interfaces:

ReconnectDialog

public class DefaultReconnectDialog
extends Object
implements ReconnectDialog

The default implementation of the reconnect dialog

Since:

1.0

Author:

Vaadin Ltd

Constructor Summary

Constructors

Constructor and Description
DefaultReconnectDialog() Creates a new instance.

Method Summary

Modifier and Type	Method and Description
void	hide() Hides the dialog from the user.
boolean	isModal() Checks the modality of the dialog.
boolean	isVisible() Checks if the reconnect dialog is visible to the user.
void	preload() Called once after initialization to allow the reconnect dialog to preload required resources, which might not be available when the server connection is gone.
void	setModal(boolean modal) Sets the modality of the dialog.
void	setReconnecting(boolean reconnecting) Sets the reconnecting state, which is true if we are trying to re-establish a connection with the server.
void	setText(String text) Sets the main text shown in the dialog.
void	show() Shows the dialog to the user.

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultReconnectDialog

public DefaultReconnectDialog()

Creates a new instance.

Method Detail

setText

public void setText(String text)

Description copied from interface: ReconnectDialog

Sets the main text shown in the dialog.

Specified by:

setText in interface ReconnectDialog

Parameters:

text - the text to show

setReconnecting

public void setReconnecting(boolean reconnecting)

Description copied from interface: ReconnectDialog

Sets the reconnecting state, which is true if we are trying to re-establish a connection with the server.

Specified by:

setReconnecting in interface ReconnectDialog

Parameters:

reconnecting - true if we are trying to re-establish the server connection, false if we have given up

show

public void show()

Description copied from interface: ReconnectDialog

Shows the dialog to the user.

Specified by:

show in interface ReconnectDialog

preload

public void preload()

Description copied from interface: ReconnectDialog

Called once after initialization to allow the reconnect dialog to preload required resources, which might not be available when the server connection is gone.

Specified by:

preload in interface ReconnectDialog

isVisible

public boolean isVisible()

Description copied from interface: ReconnectDialog

Checks if the reconnect dialog is visible to the user.

Specified by:

isVisible in interface ReconnectDialog

Returns:

true if the user can see the dialog, false otherwise

hide

public void hide()

Description copied from interface: ReconnectDialog

Hides the dialog from the user.

Specified by:

hide in interface ReconnectDialog

setModal

public void setModal(boolean modal)

Description copied from interface: ReconnectDialog

Sets the modality of the dialog. If the dialog is set to modal, it will prevent the usage of the application while the dialog is being shown. If not modal, the user can continue to use the application as normally and all server events will be queued until connection has been re-established.

Specified by:

setModal in interface ReconnectDialog

Parameters:

modal - true to make the dialog modal, false to allow usage while dialog is shown

isModal

public boolean isModal()

Description copied from interface: ReconnectDialog

Checks the modality of the dialog.

Specified by:

isModal in interface ReconnectDialog

Returns:

true if the dialog is modal, false otherwise

See Also:

ReconnectDialog.setModal(boolean)