Package com.vaadin.flow.internal.nodefeature

Class LoadingIndicatorConfigurationMap

java.lang.Object

com.vaadin.flow.internal.nodefeature.NodeFeature

com.vaadin.flow.internal.nodefeature.NodeMap

com.vaadin.flow.internal.nodefeature.LoadingIndicatorConfigurationMap

All Implemented Interfaces:

LoadingIndicatorConfiguration, Serializable

public class LoadingIndicatorConfigurationMap
extends NodeMap
implements LoadingIndicatorConfiguration

Map for storing configuration for the loading indicator.

For internal use only. May be renamed or removed in a future release.

Since:

1.0

Author:

Vaadin Ltd

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final boolean	DEFAULT_THEME_APPLIED_DEFAULT
static final String	DEFAULT_THEME_APPLIED_KEY
static final int	FIRST_DELAY_DEFAULT
static final String	FIRST_DELAY_KEY
static final int	SECOND_DELAY_DEFAULT
static final String	SECOND_DELAY_KEY
static final int	THIRD_DELAY_DEFAULT
static final String	THIRD_DELAY_KEY

Constructor Summary

Constructors

Constructor	Description
LoadingIndicatorConfigurationMap(StateNode node)	Creates a new map for the given node.

Method Summary

Modifier and Type	Method	Description
int	getFirstDelay()	Returns the delay before the loading indicator is shown.
int	getSecondDelay()	Returns the delay before the loading indicator goes into the "second" state.
int	getThirdDelay()	Returns the delay before the loading indicator goes into the "third" state.
boolean	isApplyDefaultTheme()	Returns whether the default theming is applied for the loading indicator, making it visible for users.
void	setApplyDefaultTheme(boolean applyDefaultTheme)	Sets whether the default theming is applied for the loading indicator.
void	setFirstDelay(int firstDelay)	Sets the delay before the loading indicator is shown.
void	setSecondDelay(int secondDelay)	Sets the delay before the loading indicator goes into the "second" state.
void	setThirdDelay(int thirdDelay)	Sets the delay before the loading indicator goes into the "third" state.

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

Methods inherited from class java.lang.Object

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

Field Details

FIRST_DELAY_KEY

public static final String FIRST_DELAY_KEY

See Also:

• Constant Field Values

FIRST_DELAY_DEFAULT

public static final int FIRST_DELAY_DEFAULT

See Also:

• Constant Field Values

SECOND_DELAY_KEY

public static final String SECOND_DELAY_KEY

See Also:

• Constant Field Values

SECOND_DELAY_DEFAULT

public static final int SECOND_DELAY_DEFAULT

See Also:

• Constant Field Values

THIRD_DELAY_KEY

public static final String THIRD_DELAY_KEY

See Also:

• Constant Field Values

THIRD_DELAY_DEFAULT

public static final int THIRD_DELAY_DEFAULT

See Also:

• Constant Field Values

DEFAULT_THEME_APPLIED_KEY

public static final String DEFAULT_THEME_APPLIED_KEY

See Also:

• Constant Field Values

DEFAULT_THEME_APPLIED_DEFAULT

public static final boolean DEFAULT_THEME_APPLIED_DEFAULT

See Also:

• Constant Field Values

Constructor Details

LoadingIndicatorConfigurationMap

public LoadingIndicatorConfigurationMap(StateNode node)

Creates a new map for the given node.

Parameters:

node - the node that the map belongs to

Method Details

setFirstDelay

public void setFirstDelay(int firstDelay)

Description copied from interface: LoadingIndicatorConfiguration

Sets the delay before the loading indicator is shown. The default is 300ms.

Specified by:

setFirstDelay in interface LoadingIndicatorConfiguration

Parameters:

firstDelay - The first delay (in ms)

getFirstDelay

public int getFirstDelay()

Description copied from interface: LoadingIndicatorConfiguration

Returns the delay before the loading indicator is shown.

Specified by:

getFirstDelay in interface LoadingIndicatorConfiguration

Returns:

The first delay (in ms)

setSecondDelay

public void setSecondDelay(int secondDelay)

Description copied from interface: LoadingIndicatorConfiguration

Sets the delay before the loading indicator goes into the "second" state. The delay is calculated from the time when the loading indicator was triggered. The default is 1500ms.

Specified by:

setSecondDelay in interface LoadingIndicatorConfiguration

Parameters:

secondDelay - The delay before going into the "second" state (in ms)

getSecondDelay

public int getSecondDelay()

Description copied from interface: LoadingIndicatorConfiguration

Returns the delay before the loading indicator goes into the "second" state. The delay is calculated from the time when the loading indicator was triggered.

Specified by:

getSecondDelay in interface LoadingIndicatorConfiguration

Returns:

The delay before going into the "second" state (in ms)

setThirdDelay

public void setThirdDelay(int thirdDelay)

Description copied from interface: LoadingIndicatorConfiguration

Sets the delay before the loading indicator goes into the "third" state. The delay is calculated from the time when the loading indicator was triggered. The default is 5000ms.

Specified by:

setThirdDelay in interface LoadingIndicatorConfiguration

Parameters:

thirdDelay - The delay before going into the "third" state (in ms)

getThirdDelay

public int getThirdDelay()

Description copied from interface: LoadingIndicatorConfiguration

Returns the delay before the loading indicator goes into the "third" state. The delay is calculated from the time when the loading indicator was triggered.

Specified by:

getThirdDelay in interface LoadingIndicatorConfiguration

Returns:

The delay before going into the "third" state (in ms)

isApplyDefaultTheme

public boolean isApplyDefaultTheme()

Description copied from interface: LoadingIndicatorConfiguration

Returns whether the default theming is applied for the loading indicator, making it visible for users.

By default, it is shown (true) and there is a progress bar on top of the viewport shown after a delay to the users while there is an active server request in process.

Specified by:

isApplyDefaultTheme in interface LoadingIndicatorConfiguration

Returns:

true for applying default theme, false for not

setApplyDefaultTheme

public void setApplyDefaultTheme(boolean applyDefaultTheme)

Description copied from interface: LoadingIndicatorConfiguration

Sets whether the default theming is applied for the loading indicator.

By default, it is shown (true) and there is a progress bar on top of the viewport shown after a delay to the users while there is an active server request in process.

Specified by:

setApplyDefaultTheme in interface LoadingIndicatorConfiguration

Parameters:

applyDefaultTheme - true to apply default theming, false for not