From c844d94b81b2645f2800e17557fe6e300e85de96 Mon Sep 17 00:00:00 2001 From: Artur Signell Date: Mon, 22 Apr 2013 14:18:32 +0300 Subject: Renamed loading indicator states to 'first','second','third' (#11668) Change-Id: I127070e2014bebf8aa09778b2dffee5481845ab4 --- .../src/com/vaadin/client/VLoadingIndicator.java | 113 +++++++++++---------- .../src/com/vaadin/client/ui/ui/UIConnector.java | 12 +-- .../vaadin/ui/LoadingIndicatorConfiguration.java | 77 +++++++------- shared/src/com/vaadin/shared/ui/ui/UIState.java | 9 +- .../ui/LoadingIndicatorConfigurationTest.java | 38 +++---- 5 files changed, 129 insertions(+), 120 deletions(-) diff --git a/client/src/com/vaadin/client/VLoadingIndicator.java b/client/src/com/vaadin/client/VLoadingIndicator.java index 0ef85925cd..fcce35781d 100644 --- a/client/src/com/vaadin/client/VLoadingIndicator.java +++ b/client/src/com/vaadin/client/VLoadingIndicator.java @@ -24,7 +24,7 @@ import com.google.gwt.user.client.Timer; /** * Class representing the loading indicator for Vaadin applications. The loading - * indicator has four states: "triggered", "initial", "delay" and "wait". When + * indicator has four states: "triggered", "first", "second" and "third". When * {@link #trigger()} is called the indicator moves to its "triggered" state and * then transitions from one state to the next when the timeouts specified using * the set*StateDelay methods occur. @@ -38,9 +38,9 @@ public class VLoadingIndicator { private ApplicationConnection connection; - private int initialStateDelay = 300; - private int delayStateDelay = 1500; - private int waitStateDelay = 5000; + private int firstDelay = 300; + private int secondDelay = 1500; + private int thirdDelay = 5000; /** * Timer with method for checking if it has been cancelled. This class is a @@ -81,7 +81,7 @@ public class VLoadingIndicator { } } - private Timer initialTimer = new LoadingIndicatorTimer() { + private Timer firstTimer = new LoadingIndicatorTimer() { @Override public void run() { if (isCancelled()) { @@ -91,24 +91,30 @@ public class VLoadingIndicator { show(); } }; - private Timer delayStateTimer = new LoadingIndicatorTimer() { + private Timer secondTimer = new LoadingIndicatorTimer() { @Override public void run() { if (isCancelled()) { // IE8 does not properly cancel the timer in all cases. return; } - getElement().setClassName(PRIMARY_STYLE_NAME + "-delay"); + getElement().setClassName(PRIMARY_STYLE_NAME); + getElement().addClassName("second"); + // For backwards compatibility only + getElement().addClassName(PRIMARY_STYLE_NAME + "-delay"); } }; - private Timer waitStateTimer = new LoadingIndicatorTimer() { + private Timer thirdTimer = new LoadingIndicatorTimer() { @Override public void run() { if (isCancelled()) { // IE8 does not properly cancel the timer in all cases. return; } - getElement().setClassName(PRIMARY_STYLE_NAME + "-wait"); + getElement().setClassName(PRIMARY_STYLE_NAME); + getElement().addClassName("third"); + // For backwards compatibility only + getElement().addClassName(PRIMARY_STYLE_NAME + "-wait"); } }; @@ -116,107 +122,108 @@ public class VLoadingIndicator { /** * Returns the delay (in ms) which must pass before the loading indicator - * moves into the "initial" state and is shown to the user + * moves into the "first" state and is shown to the user * - * @return The delay (in ms) until moving into the "initial" state. Counted + * @return The delay (in ms) until moving into the "first" state. Counted * from when {@link #trigger()} is called. */ - public int getInitialStateDelay() { - return initialStateDelay; + public int getFirstDelay() { + return firstDelay; } /** * Sets the delay (in ms) which must pass before the loading indicator moves - * into the "initial" state and is shown to the user + * into the "first" state and is shown to the user * - * @param initialStateDelay - * The delay (in ms) until moving into the "initial" state. - * Counted from when {@link #trigger()} is called. + * @param firstDelay + * The delay (in ms) until moving into the "first" state. Counted + * from when {@link #trigger()} is called. */ - public void setInitialStateDelay(int initialStateDelay) { - this.initialStateDelay = initialStateDelay; + public void setFirstDelay(int firstDelay) { + this.firstDelay = firstDelay; } /** * Returns the delay (in ms) which must pass before the loading indicator - * moves to its "delay" state. + * moves to its "second" state. * * @return The delay (in ms) until the loading indicator moves into its - * "delay" state. Counted from when {@link #trigger()} is called. + * "second" state. Counted from when {@link #trigger()} is called. */ - public int getDelayStateDelay() { - return delayStateDelay; + public int getSecondDelay() { + return secondDelay; } /** * Sets the delay (in ms) which must pass before the loading indicator moves - * to its "delay" state. + * to its "second" state. * - * @param delayStateDelay + * @param secondDelay * The delay (in ms) until the loading indicator moves into its - * "delay" state. Counted from when {@link #trigger()} is called. + * "second" state. Counted from when {@link #trigger()} is + * called. */ - public void setDelayStateDelay(int delayStateDelay) { - this.delayStateDelay = delayStateDelay; + public void setSecondDelay(int secondDelay) { + this.secondDelay = secondDelay; } /** * Returns the delay (in ms) which must pass before the loading indicator - * moves to its "wait" state. + * moves to its "third" state. * * @return The delay (in ms) until the loading indicator moves into its - * "wait" state. Counted from when {@link #trigger()} is called. + * "third" state. Counted from when {@link #trigger()} is called. */ - public int getWaitStateDelay() { - return waitStateDelay; + public int getThirdDelay() { + return thirdDelay; } /** * Sets the delay (in ms) which must pass before the loading indicator moves - * to its "wait" state. + * to its "third" state. * - * @param loadingIndicatorThirdDelay + * @param thirdDelay * The delay (in ms) from the event until changing the loading - * indicator into its "wait" state. Counted from when + * indicator into its "third" state. Counted from when * {@link #trigger()} is called. */ - public void setWaitStateDelay(int loadingIndicatorThirdDelay) { - waitStateDelay = loadingIndicatorThirdDelay; + public void setThirdDelay(int thirdDelay) { + this.thirdDelay = thirdDelay; } /** * Triggers displaying of this loading indicator. The loading indicator will - * actually be shown by {@link #show()} when the initial delay (as specified - * by {@link #getInitialStateDelay()}) has passed. + * actually be shown by {@link #show()} when the "first" delay (as specified + * by {@link #getFirstDelay()}) has passed. *

* The loading indicator will be hidden if shown when calling this method. *

*/ public void trigger() { hide(); - initialTimer.schedule(getInitialStateDelay()); + firstTimer.schedule(getFirstDelay()); } /** * Shows the loading indicator in its standard state and triggers timers for - * transitioning into the "delay" and "wait" states. + * transitioning into the "second" and "third" states. */ public void show() { // Reset possible style name and display mode getElement().setClassName(PRIMARY_STYLE_NAME); + getElement().addClassName("first"); getElement().getStyle().setDisplay(Display.BLOCK); - // Schedule the "delay" loading indicator - int delayStateTimerDelay = getDelayStateDelay() - - getInitialStateDelay(); - if (delayStateTimerDelay >= 0) { - delayStateTimer.schedule(delayStateTimerDelay); + // Schedule the "second" loading indicator + int secondTimerDelay = getSecondDelay() - getFirstDelay(); + if (secondTimerDelay >= 0) { + secondTimer.schedule(secondTimerDelay); } - // Schedule the "wait" loading indicator - int waitStateTimerDelay = getWaitStateDelay() - getInitialStateDelay(); - if (waitStateTimerDelay >= 0) { - waitStateTimer.schedule(waitStateTimerDelay); + // Schedule the "third" loading indicator + int thirdTimerDelay = getThirdDelay() - getFirstDelay(); + if (thirdTimerDelay >= 0) { + thirdTimer.schedule(thirdTimerDelay); } } @@ -246,9 +253,9 @@ public class VLoadingIndicator { * timers. */ public void hide() { - initialTimer.cancel(); - delayStateTimer.cancel(); - waitStateTimer.cancel(); + firstTimer.cancel(); + secondTimer.cancel(); + thirdTimer.cancel(); getElement().getStyle().setDisplay(Display.NONE); } diff --git a/client/src/com/vaadin/client/ui/ui/UIConnector.java b/client/src/com/vaadin/client/ui/ui/UIConnector.java index 26ca6b559a..e7c4c5b4a8 100644 --- a/client/src/com/vaadin/client/ui/ui/UIConnector.java +++ b/client/src/com/vaadin/client/ui/ui/UIConnector.java @@ -577,12 +577,12 @@ public class UIConnector extends AbstractSingleComponentContainerConnector if (stateChangeEvent .hasPropertyChanged("loadingIndicatorConfiguration")) { - getConnection().getLoadingIndicator().setInitialStateDelay( - getState().loadingIndicatorConfiguration.initialDelay); - getConnection().getLoadingIndicator().setWaitStateDelay( - getState().loadingIndicatorConfiguration.waitStateDelay); - getConnection().getLoadingIndicator().setDelayStateDelay( - getState().loadingIndicatorConfiguration.delayStateDelay); + getConnection().getLoadingIndicator().setFirstDelay( + getState().loadingIndicatorConfiguration.firstDelay); + getConnection().getLoadingIndicator().setSecondDelay( + getState().loadingIndicatorConfiguration.secondDelay); + getConnection().getLoadingIndicator().setThirdDelay( + getState().loadingIndicatorConfiguration.thirdDelay); } if (stateChangeEvent.hasPropertyChanged("pollInterval")) { diff --git a/server/src/com/vaadin/ui/LoadingIndicatorConfiguration.java b/server/src/com/vaadin/ui/LoadingIndicatorConfiguration.java index ca6c158aa5..57ccdc1b64 100644 --- a/server/src/com/vaadin/ui/LoadingIndicatorConfiguration.java +++ b/server/src/com/vaadin/ui/LoadingIndicatorConfiguration.java @@ -30,58 +30,59 @@ public interface LoadingIndicatorConfiguration extends Serializable { * Sets the delay before the loading indicator is shown. The default is * 300ms. * - * @param initialDelay - * The initial delay (in ms) + * @param firstDelay + * The first delay (in ms) */ - public void setInitialDelay(int initialDelay); + public void setFirstDelay(int firstDelay); /** * Returns the delay before the loading indicator is shown. * - * @return The initial delay (in ms) + * @return The first delay (in ms) */ - public int getInitialDelay(); + public int getFirstDelay(); /** - * Sets the delay before the loading indicator goes into the "delay" state. + * 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 delayStateDelay - * The delay before going into the "delay" state (in ms) + * @param secondDelay + * The delay before going into the "second" state (in ms) */ - public void setDelayStateDelay(int delayStateDelay); + public void setSecondDelay(int secondDelay); /** - * Returns the delay before the loading indicator goes into the "delay" + * 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 "delay" state (in ms) + * @return The delay before going into the "second" state (in ms) */ - public int getDelayStateDelay(); + public int getSecondDelay(); /** - * Sets the delay before the loading indicator goes into the "wait" state. + * 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 waitStateDelay - * The delay before going into the "wait" state (in ms) + * @param thirdDelay + * The delay before going into the "third" state (in ms) */ - public void setWaitStateDelay(int waitStateDelay); + public void setThirdDelay(int thirdDelay); /** - * Returns the delay before the loading indicator goes into the "wait" + * 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 "wait" state (in ms) + * @return The delay before going into the "third" state (in ms) */ - public int getWaitStateDelay(); + public int getThirdDelay(); } -class LoadingIndicatorConfigurationImpl implements LoadingIndicatorConfiguration { +class LoadingIndicatorConfigurationImpl implements + LoadingIndicatorConfiguration { private UI ui; public LoadingIndicatorConfigurationImpl(UI ui) { @@ -91,61 +92,61 @@ class LoadingIndicatorConfigurationImpl implements LoadingIndicatorConfiguration /* * (non-Javadoc) * - * @see com.vaadin.ui.LoadingIndicator#setInitialDelay(int) + * @see com.vaadin.ui.LoadingIndicator#setFirstDelay(int) */ @Override - public void setInitialDelay(int initialDelay) { - getState().initialDelay = initialDelay; + public void setFirstDelay(int firstDelay) { + getState().firstDelay = firstDelay; } /* * (non-Javadoc) * - * @see com.vaadin.ui.LoadingIndicator#getInitialDelay() + * @see com.vaadin.ui.LoadingIndicator#getFirstDelay() */ @Override - public int getInitialDelay() { - return getState(false).initialDelay; + public int getFirstDelay() { + return getState(false).firstDelay; } /* * (non-Javadoc) * - * @see com.vaadin.ui.LoadingIndicator#setDelayStateDelay(int) + * @see com.vaadin.ui.LoadingIndicator#setSecondDelay(int) */ @Override - public void setDelayStateDelay(int delayStateDelay) { - getState().delayStateDelay = delayStateDelay; + public void setSecondDelay(int secondDelay) { + getState().secondDelay = secondDelay; } /* * (non-Javadoc) * - * @see com.vaadin.ui.LoadingIndicator#getDelayStateDelay() + * @see com.vaadin.ui.LoadingIndicator#getSecondDelay() */ @Override - public int getDelayStateDelay() { - return getState(false).delayStateDelay; + public int getSecondDelay() { + return getState(false).secondDelay; } /* * (non-Javadoc) * - * @see com.vaadin.ui.LoadingIndicator#setWaitStateDelay(int) + * @see com.vaadin.ui.LoadingIndicator#setThirdDelay(int) */ @Override - public void setWaitStateDelay(int waitStateDelay) { - getState().waitStateDelay = waitStateDelay; + public void setThirdDelay(int thirdDelay) { + getState().thirdDelay = thirdDelay; } /* * (non-Javadoc) * - * @see com.vaadin.ui.LoadingIndicator#getWaitStateDelay() + * @see com.vaadin.ui.LoadingIndicator#getThirdDelay() */ @Override - public int getWaitStateDelay() { - return getState(false).waitStateDelay; + public int getThirdDelay() { + return getState(false).thirdDelay; } private LoadingIndicatorConfigurationState getState() { diff --git a/shared/src/com/vaadin/shared/ui/ui/UIState.java b/shared/src/com/vaadin/shared/ui/ui/UIState.java index ee3478f0a0..e8be9d674c 100644 --- a/shared/src/com/vaadin/shared/ui/ui/UIState.java +++ b/shared/src/com/vaadin/shared/ui/ui/UIState.java @@ -27,10 +27,11 @@ public class UIState extends TabIndexState { public PushMode pushMode = PushMode.DISABLED; - public static class LoadingIndicatorConfigurationState implements Serializable { - public int initialDelay = 300; - public int delayStateDelay = 1500; - public int waitStateDelay = 5000; + public static class LoadingIndicatorConfigurationState implements + Serializable { + public int firstDelay = 300; + public int secondDelay = 1500; + public int thirdDelay = 5000; } public static class TooltipConfigurationState implements Serializable { diff --git a/uitest/src/com/vaadin/tests/components/ui/LoadingIndicatorConfigurationTest.java b/uitest/src/com/vaadin/tests/components/ui/LoadingIndicatorConfigurationTest.java index 8917a1aa6d..0d962309e4 100644 --- a/uitest/src/com/vaadin/tests/components/ui/LoadingIndicatorConfigurationTest.java +++ b/uitest/src/com/vaadin/tests/components/ui/LoadingIndicatorConfigurationTest.java @@ -13,9 +13,9 @@ import com.vaadin.ui.TextField; public class LoadingIndicatorConfigurationTest extends AbstractTestUIWithLog { - private TextField initialDelay; - private TextField delayStateDelay; - private TextField waitStateDelay; + private TextField firstDelay; + private TextField secondDelay; + private TextField thirdDelay; @Override protected void setup(VaadinRequest request) { @@ -36,38 +36,38 @@ public class LoadingIndicatorConfigurationTest extends AbstractTestUIWithLog { } }); - initialDelay = createIntegerTextField("Initial delay (ms)", - getState().loadingIndicatorConfiguration.initialDelay); - initialDelay.addValueChangeListener(new Property.ValueChangeListener() { + firstDelay = createIntegerTextField("First delay (ms)", + getState().loadingIndicatorConfiguration.firstDelay); + firstDelay.addValueChangeListener(new Property.ValueChangeListener() { @Override public void valueChange(ValueChangeEvent event) { - getLoadingIndicatorConfiguration().setInitialDelay( - (Integer) initialDelay.getConvertedValue()); + getLoadingIndicatorConfiguration().setFirstDelay( + (Integer) firstDelay.getConvertedValue()); } }); - delayStateDelay = createIntegerTextField("Delay state delay (ms)", - getState().loadingIndicatorConfiguration.delayStateDelay); - delayStateDelay + secondDelay = createIntegerTextField("Second delay (ms)", + getState().loadingIndicatorConfiguration.secondDelay); + secondDelay .addValueChangeListener(new Property.ValueChangeListener() { @Override public void valueChange(ValueChangeEvent event) { - getLoadingIndicatorConfiguration().setDelayStateDelay( - (Integer) delayStateDelay.getConvertedValue()); + getLoadingIndicatorConfiguration().setSecondDelay( + (Integer) secondDelay.getConvertedValue()); } }); - waitStateDelay = createIntegerTextField("Wait state delay (ms)", - getState().loadingIndicatorConfiguration.waitStateDelay); - waitStateDelay + thirdDelay = createIntegerTextField("Third delay (ms)", + getState().loadingIndicatorConfiguration.thirdDelay); + thirdDelay .addValueChangeListener(new Property.ValueChangeListener() { @Override public void valueChange(ValueChangeEvent event) { - getLoadingIndicatorConfiguration().setWaitStateDelay( - (Integer) waitStateDelay.getConvertedValue()); + getLoadingIndicatorConfiguration().setThirdDelay( + (Integer) thirdDelay.getConvertedValue()); } }); getLayout() - .addComponents(initialDelay, delayStateDelay, waitStateDelay); + .addComponents(firstDelay, secondDelay, thirdDelay); HorizontalLayout hl = new HorizontalLayout(); hl.setMargin(true); -- cgit v1.2.3