com.vaadin.client.communication

Class ReconnectDialogConfiguration

java.lang.Object

com.vaadin.client.communication.ReconnectDialogConfiguration

public class ReconnectDialogConfiguration
extends Object

Tracks the reconnect dialog configuration stored in the root node and provides it with an easier to use API.

Also triggers ConnectionStateHandler.configurationUpdated() whenever part of the configuration changes.

Since:

1.0

Author:

Vaadin Ltd

Constructor Summary

Constructors

Constructor and Description
ReconnectDialogConfiguration(Registry registry) Creates a new instance using the given registry.

Method Summary

Modifier and Type	Method and Description
static void	bind(ConnectionStateHandler connectionStateHandler) Binds this ReconnectDialogConfiguration to the given ConnectionStateHandler so that ConnectionStateHandler.configurationUpdated() is run whenever a relevant part of ReconnectDialogConfiguration changes.
int	getDialogGracePeriod() Gets the time in milliseconds to wait after noticing a loss of connection but before showing the reconnect dialog.
String	getDialogText() Gets the text to show in the reconnect dialog.
String	getDialogTextGaveUp() Gets the text to show in the reconnect dialog when no longer trying to reconnect.
int	getReconnectAttempts() Gets the number of reconnect attempts that should be performed before giving up.
int	getReconnectInterval() Gets the interval in milliseconds to wait between reconnect attempts.
boolean	isDialogModal() Checks whether the reconnect dialog should be modal, i.e.

Methods inherited from class java.lang.Object

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

Constructor Detail

ReconnectDialogConfiguration

public ReconnectDialogConfiguration(Registry registry)

Creates a new instance using the given registry.

Parameters:

registry - the registry

Method Detail

bind

public static void bind(ConnectionStateHandler connectionStateHandler)

Binds this ReconnectDialogConfiguration to the given ConnectionStateHandler so that ConnectionStateHandler.configurationUpdated() is run whenever a relevant part of ReconnectDialogConfiguration changes.

Parameters:

connectionStateHandler - the connection state handler to bind to

isDialogModal

public boolean isDialogModal()

Checks whether the reconnect dialog should be modal, i.e. prevent application usage while being shown.

Returns:

true if the dialog is modal, false otherwise

getDialogText

public String getDialogText()

Gets the text to show in the reconnect dialog.

Returns:

the text to show in the reconnect dialog.

getDialogTextGaveUp

public String getDialogTextGaveUp()

Gets the text to show in the reconnect dialog when no longer trying to reconnect.

Returns:

the text to show in the reconnect dialog when no longer trying to reconnect

getReconnectAttempts

public int getReconnectAttempts()

Gets the number of reconnect attempts that should be performed before giving up.

Returns:

the number of reconnect attempts to perform

getReconnectInterval

public int getReconnectInterval()

Gets the interval in milliseconds to wait between reconnect attempts.

Returns:

the interval in milliseconds to wait between reconnect attempts

getDialogGracePeriod

public int getDialogGracePeriod()

Gets the time in milliseconds to wait after noticing a loss of connection but before showing the reconnect dialog.

Returns:

the time in milliseconds to wait before showing the dialog