com.vaadin.flow.component.page

Interface LoadingIndicatorConfiguration

All Superinterfaces:

Serializable

All Known Implementing Classes:

LoadingIndicatorConfigurationMap

public interface LoadingIndicatorConfiguration
extends Serializable

Provides method for configuring the loading indicator.

Since:

1.0

Author:

Vaadin Ltd

Method Summary

Modifier and Type	Method and 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.

Method Detail

setFirstDelay

void setFirstDelay(int firstDelay)

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

Parameters:

firstDelay - The first delay (in ms)

getFirstDelay

int getFirstDelay()

Returns the delay before the loading indicator is shown.

Returns:

The first delay (in ms)

setSecondDelay

void setSecondDelay(int secondDelay)

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.

Parameters:

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

getSecondDelay

int getSecondDelay()

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.

Returns:

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

setThirdDelay

void setThirdDelay(int thirdDelay)

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.

Parameters:

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

getThirdDelay

int getThirdDelay()

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.

Returns:

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

isApplyDefaultTheme

boolean isApplyDefaultTheme()

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.

Returns:

true for applying default theme, false for not

setApplyDefaultTheme

void setApplyDefaultTheme(boolean applyDefaultTheme)

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.

Parameters:

applyDefaultTheme - true to apply default theming, false for not