com.vaadin.ui.LoadingIndicatorConfiguration Maven / Gradle / Ivy
/*
* Copyright (C) 2000-2024 Vaadin Ltd
*
* This program is available under Vaadin Commercial License and Service Terms.
*
* See for the full
* license.
*/
package com.vaadin.ui;
import java.io.Serializable;
import com.vaadin.shared.ui.ui.UIState.LoadingIndicatorConfigurationState;
/**
* Provides method for configuring the loading indicator.
*
* @author Vaadin Ltd
* @since 7.1
*/
public interface LoadingIndicatorConfiguration extends Serializable {
/**
* Sets the delay before the loading indicator is shown. The default is
* 300ms.
*
* @param firstDelay
* The first delay (in ms)
*/
public void setFirstDelay(int firstDelay);
/**
* Returns the delay before the loading indicator is shown.
*
* @return The first delay (in ms)
*/
public int getFirstDelay();
/**
* 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.
*
* @param secondDelay
* The delay before going into the "second" state (in ms)
*/
public void setSecondDelay(int secondDelay);
/**
* 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.
*
* @return The delay before going into the "second" state (in ms)
*/
public int getSecondDelay();
/**
* 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.
*
* @param thirdDelay
* The delay before going into the "third" state (in ms)
*/
public void setThirdDelay(int thirdDelay);
/**
* 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.
*
* @return The delay before going into the "third" state (in ms)
*/
public int getThirdDelay();
}
class LoadingIndicatorConfigurationImpl
implements LoadingIndicatorConfiguration {
private final UI ui;
public LoadingIndicatorConfigurationImpl(UI ui) {
this.ui = ui;
}
/*
* (non-Javadoc)
*
* @see com.vaadin.ui.LoadingIndicator#setFirstDelay(int)
*/
@Override
public void setFirstDelay(int firstDelay) {
getState().firstDelay = firstDelay;
}
/*
* (non-Javadoc)
*
* @see com.vaadin.ui.LoadingIndicator#getFirstDelay()
*/
@Override
public int getFirstDelay() {
return getState(false).firstDelay;
}
/*
* (non-Javadoc)
*
* @see com.vaadin.ui.LoadingIndicator#setSecondDelay(int)
*/
@Override
public void setSecondDelay(int secondDelay) {
getState().secondDelay = secondDelay;
}
/*
* (non-Javadoc)
*
* @see com.vaadin.ui.LoadingIndicator#getSecondDelay()
*/
@Override
public int getSecondDelay() {
return getState(false).secondDelay;
}
/*
* (non-Javadoc)
*
* @see com.vaadin.ui.LoadingIndicator#setThirdDelay(int)
*/
@Override
public void setThirdDelay(int thirdDelay) {
getState().thirdDelay = thirdDelay;
}
/*
* (non-Javadoc)
*
* @see com.vaadin.ui.LoadingIndicator#getThirdDelay()
*/
@Override
public int getThirdDelay() {
return getState(false).thirdDelay;
}
private LoadingIndicatorConfigurationState getState() {
return ui.getState().loadingIndicatorConfiguration;
}
private LoadingIndicatorConfigurationState getState(boolean markAsDirty) {
return ui.getState(markAsDirty).loadingIndicatorConfiguration;
}
}