We use cookies to serve our customers and website visitors in the best possible way. Cookies are used for the proper functioning of the website and for improving the user experience, monitoring visitor traffic and marketing purposes. By continuing to browse the site, you agree to our use of cookies. You can read more about cookies here.
com.vaadin.flow.internal.nodefeature.
Class ReconnectDialogConfigurationMap
- java.lang.Object
-
- com.vaadin.flow.internal.nodefeature.NodeFeature
-
- com.vaadin.flow.internal.nodefeature.NodeMap
-
- com.vaadin.flow.internal.nodefeature.ReconnectDialogConfigurationMap
-
All Implemented Interfaces:
public class ReconnectDialogConfigurationMap extends NodeMap implements ReconnectDialogConfigurationMap for storing the reconnect dialog configuration for a UI.
For internal use only. May be renamed or removed in a future release.
Since:
1.0
Author:
Vaadin Ltd
See Also:
-
-
Field Summary
Fields Modifier and Type Field Description static StringDIALOG_TEXT_DEFAULTstatic StringDIALOG_TEXT_GAVE_UP_DEFAULTstatic StringDIALOG_TEXT_GAVE_UP_KEYstatic StringDIALOG_TEXT_KEYstatic intRECONNECT_ATTEMPTS_DEFAULTstatic StringRECONNECT_ATTEMPTS_KEYstatic intRECONNECT_INTERVAL_DEFAULTstatic StringRECONNECT_INTERVAL_KEY
-
Constructor Summary
Constructors Constructor Description ReconnectDialogConfigurationMap(StateNode node)Creates a new map for the given node.
-
Method Summary
All Methods Modifier and Type Method Description StringgetDialogText()Gets the text to show in the reconnect dialog when trying to re-establish the server connection.
StringgetDialogTextGaveUp()Gets the text to show in the reconnect dialog after giving up trying to reconnect (
ReconnectDialogConfiguration.getReconnectAttempts()reached).intgetReconnectAttempts()Gets the number of times to try to reconnect to the server before giving up.
intgetReconnectInterval()Gets the interval (in milliseconds) between reconnect attempts.
voidsetDialogText(String dialogText)Sets the text to show in the reconnect dialog when trying to re-establish the server connection.
voidsetDialogTextGaveUp(String dialogTextGaveUp)Sets the text to show in the reconnect dialog after giving up trying to reconnect (
ReconnectDialogConfiguration.getReconnectAttempts()reached).voidsetReconnectAttempts(int reconnectAttempts)Sets the number of times to try to reconnect to the server before giving up.
voidsetReconnectInterval(int reconnectInterval)Sets the interval (in milliseconds) between reconnect attempts.
-
Methods inherited from class com.vaadin.flow.internal.nodefeature.NodeMap
clear, collectChanges, contains, forEachChild, generateChangesFromEmpty, get, getOrDefault, getOrDefault, getOrDefault, keySet, mayUpdateFromClient, producePutChange, put, put, remove, updateFromClient
-
Methods inherited from class com.vaadin.flow.internal.nodefeature.NodeFeature
allowsChanges, attachPotentialChild, detatchPotentialChild, getNode, onAttach, onDetach
-
-
-
-
Field Detail
-
DIALOG_TEXT_KEY
public static final String DIALOG_TEXT_KEYSee Also:
-
DIALOG_TEXT_DEFAULT
public static final String DIALOG_TEXT_DEFAULTSee Also:
-
DIALOG_TEXT_GAVE_UP_KEY
public static final String DIALOG_TEXT_GAVE_UP_KEYSee Also:
-
DIALOG_TEXT_GAVE_UP_DEFAULT
public static final String DIALOG_TEXT_GAVE_UP_DEFAULTSee Also:
-
RECONNECT_ATTEMPTS_KEY
public static final String RECONNECT_ATTEMPTS_KEYSee Also:
-
RECONNECT_ATTEMPTS_DEFAULT
public static final int RECONNECT_ATTEMPTS_DEFAULTSee Also:
-
RECONNECT_INTERVAL_KEY
public static final String RECONNECT_INTERVAL_KEYSee Also:
-
RECONNECT_INTERVAL_DEFAULT
public static final int RECONNECT_INTERVAL_DEFAULTSee Also:
-
-
Constructor Detail
-
ReconnectDialogConfigurationMap
public ReconnectDialogConfigurationMap(StateNode node)Creates a new map for the given node.
Parameters:
node- the node that the map belongs to
-
-
Method Detail
-
getDialogText
public String getDialogText()Description copied from interface:
ReconnectDialogConfigurationGets the text to show in the reconnect dialog when trying to re-establish the server connection.
The default is "Connection lost, trying to reconnect..."
Specified by:
getDialogTextin interfaceReconnectDialogConfigurationReturns:
the text to show in the reconnect dialog
-
setDialogText
public void setDialogText(String dialogText)Description copied from interface:
ReconnectDialogConfigurationSets the text to show in the reconnect dialog when trying to re-establish the server connection.
Specified by:
setDialogTextin interfaceReconnectDialogConfigurationParameters:
dialogText- the text to show in the reconnect dialog
-
getDialogTextGaveUp
public String getDialogTextGaveUp()Description copied from interface:
ReconnectDialogConfigurationGets the text to show in the reconnect dialog after giving up trying to reconnect (
ReconnectDialogConfiguration.getReconnectAttempts()reached).The default is "Connection lost"
Specified by:
getDialogTextGaveUpin interfaceReconnectDialogConfigurationReturns:
the text to show in the reconnect dialog after giving up
-
setDialogTextGaveUp
public void setDialogTextGaveUp(String dialogTextGaveUp)Description copied from interface:
ReconnectDialogConfigurationSets the text to show in the reconnect dialog after giving up trying to reconnect (
ReconnectDialogConfiguration.getReconnectAttempts()reached).Specified by:
setDialogTextGaveUpin interfaceReconnectDialogConfigurationParameters:
dialogTextGaveUp- the text to show in the reconnect dialog after giving up
-
getReconnectAttempts
public int getReconnectAttempts()Description copied from interface:
ReconnectDialogConfigurationGets the number of times to try to reconnect to the server before giving up.
The default is 10000
Specified by:
getReconnectAttemptsin interfaceReconnectDialogConfigurationReturns:
the number of times to try to reconnect
-
setReconnectAttempts
public void setReconnectAttempts(int reconnectAttempts)Description copied from interface:
ReconnectDialogConfigurationSets the number of times to try to reconnect to the server before giving up.
Specified by:
setReconnectAttemptsin interfaceReconnectDialogConfigurationParameters:
reconnectAttempts- the number of times to try to reconnect
-
getReconnectInterval
public int getReconnectInterval()Description copied from interface:
ReconnectDialogConfigurationGets the interval (in milliseconds) between reconnect attempts.
The default is 5000
Specified by:
getReconnectIntervalin interfaceReconnectDialogConfigurationReturns:
the interval (in ms) between reconnect attempts
-
setReconnectInterval
public void setReconnectInterval(int reconnectInterval)Description copied from interface:
ReconnectDialogConfigurationSets the interval (in milliseconds) between reconnect attempts.
Specified by:
setReconnectIntervalin interfaceReconnectDialogConfigurationParameters:
reconnectInterval- the interval (in ms) between reconnect attempts
-
-