Extract ProgressBar and deprecate ProgressIndicator (#11925)

Change-Id: Id9eaee65762b0dadd59f3e730d3ff11712ab87fe

2 files changed, 170 insertions, 87 deletions

diff --git a/server/src/com/vaadin/ui/ProgressBar.java b/server/src/com/vaadin/ui/ProgressBar.java
new file mode 100644
index 0000000000..3f8aab6d7c
--- /dev/null
+++ b/server/src/com/vaadin/ui/ProgressBar.java
@@ -0,0 +1,152 @@
+/*
+ * Copyright 2000-2013 Vaadin Ltd.
+ * 
+ * Licensed under the Apache License, Version 2.0 (the "License"); you may not
+ * use this file except in compliance with the License. You may obtain a copy of
+ * the License at
+ * 
+ * http://www.apache.org/licenses/LICENSE-2.0
+ * 
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+ * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+ * License for the specific language governing permissions and limitations under
+ * the License.
+ */
+
+package com.vaadin.ui;
+
+import com.vaadin.data.Property;
+import com.vaadin.shared.ui.progressindicator.ProgressBarState;
+
+/**
+ * Shows the current progress of a long running task.
+ * <p>
+ * The default mode is to show the current progress internally represented by a
+ * floating point value between 0 and 1 (inclusive). The progress bar can also
+ * be in an indeterminate mode showing an animation indicating that the task is
+ * running but without providing any information about the current progress.
+ * 
+ * @since 7.1
+ * @author Vaadin Ltd
+ */
+public class ProgressBar extends AbstractField<Float> implements
+        Property.Viewer, Property.ValueChangeListener {
+
+    /**
+     * Creates a new progress bar initially set to 0% progress.
+     */
+    public ProgressBar() {
+        this(0);
+    }
+
+    /**
+     * Creates a new progress bar with the given initial value.
+     * 
+     * @param progress
+     *            the initial progress value
+     */
+    public ProgressBar(float progress) {
+        setValue(Float.valueOf(progress));
+    }
+
+    /**
+     * Creates a new progress bar bound to the given data source.
+     * 
+     * @param dataSource
+     *            the property to bind this progress bar to
+     */
+    public ProgressBar(Property<?> dataSource) {
+        setPropertyDataSource(dataSource);
+    }
+
+    @Override
+    public void beforeClientResponse(boolean initial) {
+        super.beforeClientResponse(initial);
+
+        // Update value in state even if the property hasn't fired any event
+        getState().state = getValue();
+    }
+
+    /**
+     * Gets the value of this progress bar. The value is a <code>float</code>
+     * between 0 and 1 where 0 represents no progress at all and 1 represents
+     * fully completed.
+     * 
+     * @return the current progress value
+     */
+    @Override
+    public Float getValue() {
+        return super.getValue();
+    }
+
+    /**
+     * Sets the value of this progress bar. The value is a <code>float</code>
+     * between 0 and 1 where 0 represents no progress at all and 1 represents
+     * fully completed.
+     * 
+     * @param newValue
+     *            the current progress value
+     */
+    @Override
+    public void setValue(Float newValue) {
+        super.setValue(newValue);
+    }
+
+    @Override
+    public Class<Float> getType() {
+        return Float.class;
+    }
+
+    @Override
+    protected ProgressBarState getState() {
+        return (ProgressBarState) super.getState();
+    }
+
+    @Override
+    protected ProgressBarState getState(boolean markAsDirty) {
+        return (ProgressBarState) super.getState(markAsDirty);
+    }
+
+    /**
+     * Sets whether or not this progress indicator is indeterminate. In
+     * indeterminate mode there is an animation indicating that the task is
+     * running but without providing any information about the current progress.
+     * 
+     * @param indeterminate
+     *            <code>true</code> to set to indeterminate mode; otherwise
+     *            <code>false</code>
+     */
+    public void setIndeterminate(boolean indeterminate) {
+        getState().indeterminate = indeterminate;
+    }
+
+    /**
+     * Gets whether or not this progress indicator is indeterminate. In
+     * indeterminate mode there is an animation indicating that the task is
+     * running but without providing any information about the current progress.
+     * 
+     * @return <code>true</code> if set to indeterminate mode; otherwise
+     *         <code>false</code>
+     */
+    public boolean isIndeterminate() {
+        return getState(false).indeterminate;
+    }
+
+    /*
+     * Overridden to keep the shared state in sync with the AbstractField
+     * internal value. Should be removed once AbstractField is refactored to use
+     * shared state.
+     * 
+     * See tickets #10921 and #11064.
+     */
+    @Override
+    protected void setInternalValue(Float newValue) {
+        super.setInternalValue(newValue);
+        if (newValue == null) {
+            newValue = Float.valueOf(0);
+        }
+        getState().state = newValue;
+    }
+
+}
\ No newline at end of file
diff --git a/server/src/com/vaadin/ui/ProgressIndicator.java b/server/src/com/vaadin/ui/ProgressIndicator.java
index c481aa1e8f..6da18fc29d 100644
--- a/server/src/com/vaadin/ui/ProgressIndicator.java
+++ b/server/src/com/vaadin/ui/ProgressIndicator.java
@@ -17,24 +17,27 @@
 package com.vaadin.ui;
 
 import com.vaadin.data.Property;
+import com.vaadin.shared.communication.PushMode;
 import com.vaadin.shared.ui.progressindicator.ProgressIndicatorServerRpc;
 import com.vaadin.shared.ui.progressindicator.ProgressIndicatorState;
 
 /**
- * <code>ProgressIndicator</code> is component that shows user state of a
- * process (like long computing or file upload)
- * 
- * <code>ProgressIndicator</code> has two main modes. One for indeterminate
- * processes and other (default) for processes which progress can be measured
- * 
- * May view an other property that indicates progress 0...1
+ * A {@link ProgressBar} which polls the server for updates.
+ * <p>
+ * Polling in this way is generally not recommended since there is no
+ * centralized management of when messages are sent to the server. Furthermore,
+ * polling might not be needed at all if {@link UI#setPushMode(PushMode)} or
+ * {@link UI#setPollInterval(int)} is used.
  * 
  * @author Vaadin Ltd.
  * @since 4
+ * @deprecated as of 7.1, use {@link ProgressBar} combined with
+ *             {@link UI#setPushMode(PushMode)} or
+ *             {@link UI#setPollInterval(int)} instead.
  */
+@Deprecated
 @SuppressWarnings("serial")
-public class ProgressIndicator extends AbstractField<Float> implements
-        Property.Viewer, Property.ValueChangeListener {
+public class ProgressIndicator extends ProgressBar {
 
     private ProgressIndicatorServerRpc rpc = new ProgressIndicatorServerRpc() {
 
@@ -57,7 +60,7 @@ public class ProgressIndicator extends AbstractField<Float> implements
      * @param value
      */
     public ProgressIndicator(float value) {
-        setValue(value);
+        super(value);
         registerRpc(rpc);
     }
 
@@ -68,74 +71,18 @@ public class ProgressIndicator extends AbstractField<Float> implements
      * @param contentSource
      */
     public ProgressIndicator(Property contentSource) {
-        setPropertyDataSource(contentSource);
+        super(contentSource);
         registerRpc(rpc);
     }
 
     @Override
-    public void beforeClientResponse(boolean initial) {
-        super.beforeClientResponse(initial);
-
-        getState().state = getValue();
-    }
-
-    /**
-     * Gets the value of the ProgressIndicator. Value of the ProgressIndicator
-     * is Float between 0 and 1.
-     * 
-     * @return the Value of the ProgressIndicator.
-     * @see com.vaadin.ui.AbstractField#getValue()
-     */
-    @Override
-    public Float getValue() {
-        return super.getValue();
-    }
-
-    /**
-     * Sets the value of the ProgressIndicator. Value of the ProgressIndicator
-     * is the Float between 0 and 1.
-     * 
-     * @param newValue
-     *            the New value of the ProgressIndicator.
-     * @see com.vaadin.ui.AbstractField#setValue()
-     */
-    @Override
-    public void setValue(Float newValue) {
-        super.setValue(newValue);
-    }
-
-    /*
-     * (non-Javadoc)
-     * 
-     * @see com.vaadin.ui.AbstractField#getType()
-     */
-    @Override
-    public Class<Float> getType() {
-        return Float.class;
-    }
-
-    @Override
     protected ProgressIndicatorState getState() {
         return (ProgressIndicatorState) super.getState();
     }
 
-    /**
-     * Sets whether or not the ProgressIndicator is indeterminate.
-     * 
-     * @param indeterminate
-     *            true to set to indeterminate mode.
-     */
-    public void setIndeterminate(boolean indeterminate) {
-        getState().indeterminate = indeterminate;
-    }
-
-    /**
-     * Gets whether or not the ProgressIndicator is indeterminate.
-     * 
-     * @return true to set to indeterminate mode.
-     */
-    public boolean isIndeterminate() {
-        return getState().indeterminate;
+    @Override
+    protected ProgressIndicatorState getState(boolean markAsDirty) {
+        return (ProgressIndicatorState) super.getState(markAsDirty);
     }
 
     /**
@@ -154,22 +101,6 @@ public class ProgressIndicator extends AbstractField<Float> implements
      * @return the interval in milliseconds.
      */
     public int getPollingInterval() {
-        return getState().pollingInterval;
-    }
-
-    /*
-     * Overridden to keep the shared state in sync with the AbstractField
-     * internal value. Should be removed once AbstractField is refactored to use
-     * shared state.
-     * 
-     * See tickets #10921 and #11064.
-     */
-    @Override
-    protected void setInternalValue(Float newValue) {
-        super.setInternalValue(newValue);
-        if (newValue == null) {
-            newValue = 0.0f;
-        }
-        getState().state = newValue;
+        return getState(false).pollingInterval;
     }
 }