blob: bf52cefefe17f5bd0096fd78aa5982ef70e5bf77 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
|
/*
* Copyright 2000-2014 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;
}
}
|
