123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141 |
- /*
- * Copyright 2000-2018 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 org.jsoup.nodes.Element;
-
- import com.vaadin.shared.ui.progressindicator.ProgressBarState;
- import com.vaadin.ui.declarative.DesignAttributeHandler;
- import com.vaadin.ui.declarative.DesignContext;
-
- /**
- * A component for displaying progress.
- * <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 8.0
- * @author Vaadin Ltd
- */
- public class ProgressBar extends AbstractComponent {
-
- private static final float DEFAULT_VALUE = 0f;
-
- /**
- * Creates a new progress bar initially set to 0% progress.
- */
- public ProgressBar() {
- this(DEFAULT_VALUE);
- }
-
- /**
- * Creates a new progress bar with the given initial value.
- *
- * @param progress
- * the initial progress value
- */
- public ProgressBar(float progress) {
- setValue(Float.valueOf(progress));
- }
-
- /**
- * 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
- */
- public float getValue() {
- return getState(false).state;
- }
-
- /**
- * 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
- * @since 8.0
- */
- public void setValue(float newValue) {
- getState().state = newValue;
- }
-
- @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;
- }
-
- @Override
- public void readDesign(Element design, DesignContext designContext) {
- super.readDesign(design, designContext);
- if (design.hasAttr("value") && !design.attr("value").isEmpty()) {
- setValue(DesignAttributeHandler.readAttribute("value",
- design.attributes(), Float.class));
- }
- }
-
- @Override
- public void writeDesign(Element design, DesignContext designContext) {
- super.writeDesign(design, designContext);
- Float defaultValue = ((ProgressBar) designContext
- .getDefaultInstance(this)).getValue();
- DesignAttributeHandler.writeAttribute("value", design.attributes(),
- getValue(), defaultValue, Float.class, designContext);
- }
-
- /**
- * Resets the value of this component, effectively displaying zero progress.
- *
- * @since 8.0
- */
- public void reset() {
- setValue(DEFAULT_VALUE);
- }
- }
|