com.vaadin.ui.
Interface ReconnectDialogConfiguration
-
All Superinterfaces:
public interface ReconnectDialogConfiguration extends Serializable
Provides method for configuring the reconnect dialog.
Since:
7.6
Author:
Vaadin Ltd
-
-
Method Summary
All Methods Modifier and Type Method Description int
getDialogGracePeriod()
Gets the timeout (in milliseconds) between noticing a loss of connection and showing the dialog.
String
getDialogText()
Gets the text to show in the reconnect dialog when trying to re-establish the server connection.
String
getDialogTextGaveUp()
Gets the text to show in the reconnect dialog after giving up trying to reconnect (
getReconnectAttempts()
reached).int
getReconnectAttempts()
Gets the number of times to try to reconnect to the server before giving up.
int
getReconnectInterval()
Gets the interval (in milliseconds) between reconnect attempts.
boolean
isDialogModal()
Checks the modality of the dialog.
void
setDialogGracePeriod(int dialogGracePeriod)
Sets the timeout (in milliseconds) between noticing a loss of connection and showing the dialog.
void
setDialogModal(boolean dialogModal)
Sets the modality of the dialog.
void
setDialogText(String dialogText)
Sets the text to show in the reconnect dialog when trying to re-establish.
void
setDialogTextGaveUp(String dialogTextGaveUp)
Sets the text to show in the reconnect dialog after giving up trying to reconnect (
getReconnectAttempts()
reached).void
setReconnectAttempts(int reconnectAttempts)
Sets the number of times to try to reconnect to the server before giving up.
void
setReconnectInterval(int reconnectInterval)
Sets the interval (in milliseconds) between reconnect attempts.
-
-
-
Method Detail
-
getDialogText
String getDialogText()
Gets the text to show in the reconnect dialog when trying to re-establish the server connection.
Returns:
the text to show in the reconnect dialog
-
setDialogText
void setDialogText(String dialogText)
Sets the text to show in the reconnect dialog when trying to re-establish. the server connection
Parameters:
dialogText
- the text to show in the reconnect dialog
-
getDialogTextGaveUp
String getDialogTextGaveUp()
Gets the text to show in the reconnect dialog after giving up trying to reconnect (
getReconnectAttempts()
reached).Returns:
the text to show in the reconnect dialog after giving up
-
setDialogTextGaveUp
void setDialogTextGaveUp(String dialogTextGaveUp)
Sets the text to show in the reconnect dialog after giving up trying to reconnect (
getReconnectAttempts()
reached).Parameters:
dialogTextGaveUp
- the text to show in the reconnect dialog after giving up
-
getReconnectAttempts
int getReconnectAttempts()
Gets the number of times to try to reconnect to the server before giving up.
Returns:
the number of times to try to reconnect
-
setReconnectAttempts
void setReconnectAttempts(int reconnectAttempts)
Sets the number of times to try to reconnect to the server before giving up.
Parameters:
reconnectAttempts
- the number of times to try to reconnect
-
getReconnectInterval
int getReconnectInterval()
Gets the interval (in milliseconds) between reconnect attempts.
Returns:
the interval (in ms) between reconnect attempts
-
setReconnectInterval
void setReconnectInterval(int reconnectInterval)
Sets the interval (in milliseconds) between reconnect attempts.
Parameters:
reconnectInterval
- the interval (in ms) between reconnect attempts
-
getDialogGracePeriod
int getDialogGracePeriod()
Gets the timeout (in milliseconds) between noticing a loss of connection and showing the dialog.
Returns:
the time to wait before showing a dialog
-
setDialogGracePeriod
void setDialogGracePeriod(int dialogGracePeriod)
Sets the timeout (in milliseconds) between noticing a loss of connection and showing the dialog.
Parameters:
dialogGracePeriod
- the time to wait before showing a dialog
-
setDialogModal
void setDialogModal(boolean dialogModal)
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.
Parameters:
dialogModal
- true to make the dialog modal, false otherwise
-
isDialogModal
boolean isDialogModal()
Checks the modality of the dialog.
Returns:
true if the dialog is modal, false otherwise
See Also:
-
-