com.vaadin.v7.ui

Class ProgressBar

java.lang.Object

com.vaadin.server.AbstractClientConnector

com.vaadin.ui.AbstractComponent

com.vaadin.v7.ui.AbstractLegacyComponent

com.vaadin.v7.ui.AbstractField<Float>

com.vaadin.v7.ui.ProgressBar

All Implemented Interfaces:

Action.ShortcutNotifier, ContextClickEvent.ContextClickNotifier, MethodEventSource, ClientConnector, Sizeable, com.vaadin.shared.Connector, Component, Component.Focusable, Buffered, BufferedValidatable, Property<Float>, Property.Editor, Property.ReadOnlyStatusChangeListener, Property.ReadOnlyStatusChangeNotifier, Property.ValueChangeListener, Property.ValueChangeNotifier, Property.Viewer, Validatable, Field<Float>, Serializable

Direct Known Subclasses:

ProgressIndicator

Deprecated.

As of 8.0 replaced by ProgressBar based on the new data binding API

@Deprecated
public class ProgressBar
extends AbstractField<Float>

Shows the current progress of a long running task.

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

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.vaadin.v7.ui.AbstractField

AbstractField.FocusShortcut, AbstractField.ReadOnlyStatusChangeEvent

Nested classes/interfaces inherited from interface com.vaadin.v7.ui.Field

Field.ValueChangeEvent

Nested classes/interfaces inherited from interface com.vaadin.ui.Component

Component.ErrorEvent, Component.Event, Component.Focusable, Component.Listener

Nested classes/interfaces inherited from interface com.vaadin.server.ClientConnector

ClientConnector.AttachEvent, ClientConnector.AttachListener, ClientConnector.ConnectorErrorEvent, ClientConnector.DetachEvent, ClientConnector.DetachListener

Nested classes/interfaces inherited from interface com.vaadin.server.Sizeable

Sizeable.Unit

Nested classes/interfaces inherited from interface com.vaadin.v7.data.Buffered

Buffered.SourceException

Nested classes/interfaces inherited from interface com.vaadin.v7.data.Property

Property.Editor, Property.ReadOnlyException, Property.ReadOnlyStatusChangeListener, Property.ReadOnlyStatusChangeNotifier, Property.Transactional<T>, Property.ValueChangeListener, Property.ValueChangeNotifier, Property.Viewer

Field Summary

Fields inherited from class com.vaadin.ui.AbstractComponent

DESIGN_ATTR_PLAIN_TEXT

Fields inherited from interface com.vaadin.server.Sizeable

SIZE_UNDEFINED, UNITS_CM, UNITS_EM, UNITS_EX, UNITS_INCH, UNITS_MM, UNITS_PERCENTAGE, UNITS_PICAS, UNITS_PIXELS, UNITS_POINTS

Constructor Summary

Constructors

Constructor and Description
ProgressBar() Deprecated. Creates a new progress bar initially set to 0% progress.
ProgressBar(float progress) Deprecated. Creates a new progress bar with the given initial value.
ProgressBar(Property<?> dataSource) Deprecated. Creates a new progress bar bound to the given data source.

Method Summary

Modifier and Type	Method and Description
void	beforeClientResponse(boolean initial) Deprecated.
void	clear() Deprecated. Clears the value of the field.
protected ProgressBarState	getState() Deprecated.
protected ProgressBarState	getState(boolean markAsDirty) Deprecated.
Class<Float>	getType() Deprecated. Returns the type of the Field.
Float	getValue() Deprecated. Gets the value of this progress bar.
boolean	isEmpty() Deprecated. Is the field empty? In general, "empty" state is same as null.
boolean	isIndeterminate() Deprecated. Gets whether or not this progress indicator is indeterminate.
void	readDesign(org.jsoup.nodes.Element design, DesignContext designContext) Deprecated.
void	setIndeterminate(boolean indeterminate) Deprecated. Sets whether or not this progress indicator is indeterminate.
protected void	setInternalValue(Float newValue) Deprecated. Sets the internal field value.
void	setValue(Float newValue) Deprecated. Sets the value of this progress bar.
void	writeDesign(org.jsoup.nodes.Element design, DesignContext designContext) Deprecated.

Methods inherited from class com.vaadin.v7.ui.AbstractField

addListener, addListener, addReadOnlyStatusChangeListener, addValidator, addValueChangeListener, attach, commit, detach, discard, fireReadOnlyStatusChange, fireValueChange, focus, getConversionError, getConversionError, getConvertedValue, getConverter, getCurrentBufferedSourceException, getCustomAttributes, getErrorMessage, getInternalValue, getModelType, getPropertyDataSource, getRequiredError, getTabIndex, getValidators, isBuffered, isInvalidAllowed, isInvalidCommitted, isModified, isReadOnly, isRequired, isValid, isValidationVisible, readOnlyStatusChange, removeAllValidators, removeListener, removeListener, removeReadOnlyStatusChangeListener, removeValidator, removeValueChangeListener, setBuffered, setConversionError, setConvertedValue, setConverter, setConverter, setCurrentBufferedSourceException, setInvalidAllowed, setInvalidCommitted, setLocale, setPropertyDataSource, setReadOnly, setRequired, setRequiredError, setTabIndex, setValidationVisible, setValue, setValue, shouldHideErrors, validate, validate, valueChange

Methods inherited from class com.vaadin.v7.ui.AbstractLegacyComponent

getExplicitImmediateValue, isImmediate, setImmediate

Methods inherited from class com.vaadin.ui.AbstractComponent

addContextClickListener, addListener, addShortcutListener, addStyleName, findAncestor, fireComponentErrorEvent, fireComponentEvent, getActionManager, getCaption, getComponentError, getData, getDebugId, getDescription, getHeight, getHeightUnits, getIcon, getId, getLocale, getParent, getPrimaryStyleName, getStyleName, getWidth, getWidthUnits, isCaptionAsHtml, isConnectorEnabled, isEnabled, isOrHasAncestor, isRequiredIndicatorVisible, isResponsive, isVisible, removeContextClickListener, removeListener, removeShortcutListener, removeStyleName, setCaption, setCaptionAsHtml, setComponentError, setData, setDebugId, setDescription, setDescription, setEnabled, setHeight, setHeight, setHeightUndefined, setIcon, setId, setParent, setPrimaryStyleName, setRequiredIndicatorVisible, setResponsive, setSizeFull, setSizeUndefined, setStyleName, setVisible, setWidth, setWidth, setWidthUndefined

Methods inherited from class com.vaadin.server.AbstractClientConnector

addAttachListener, addDetachListener, addExtension, addListener, addListener, addListener, addMethodInvocationToQueue, createState, encodeState, equals, fireEvent, getAllChildrenIterable, getConnectorId, getErrorHandler, getExtensions, getListeners, getResource, getRpcManager, getRpcProxy, getSession, getStateType, getUI, handleConnectorRequest, hashCode, hasListeners, isAttached, isThis, markAsDirty, markAsDirtyRecursive, registerRpc, registerRpc, removeAttachListener, removeDetachListener, removeExtension, removeListener, removeListener, removeListener, removeListener, requestRepaint, requestRepaintAll, retrievePendingRpcCalls, setErrorHandler, setResource, updateDiffstate

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.vaadin.ui.Component

addListener, addStyleName, addStyleNames, getCaption, getDescription, getIcon, getId, getLocale, getParent, getPrimaryStyleName, getStyleName, getUI, isEnabled, isVisible, removeListener, removeStyleName, removeStyleNames, setCaption, setEnabled, setIcon, setId, setParent, setPrimaryStyleName, setStyleName, setStyleName, setVisible

Methods inherited from interface com.vaadin.server.ClientConnector

addAttachListener, addDetachListener, encodeState, getErrorHandler, getExtensions, getRpcManager, getStateType, handleConnectorRequest, isAttached, isConnectorEnabled, markAsDirty, markAsDirtyRecursive, removeAttachListener, removeDetachListener, removeExtension, requestRepaint, requestRepaintAll, retrievePendingRpcCalls, setErrorHandler

Methods inherited from interface com.vaadin.shared.Connector

getConnectorId

Methods inherited from interface com.vaadin.server.Sizeable

getHeight, getHeightUnits, getWidth, getWidthUnits, setHeight, setHeight, setHeightUndefined, setSizeFull, setSizeUndefined, setWidth, setWidth, setWidthUndefined

Methods inherited from interface com.vaadin.event.Action.ShortcutNotifier

addShortcutListener, removeShortcutListener

Constructor Detail

ProgressBar

public ProgressBar()

Deprecated.

Creates a new progress bar initially set to 0% progress.

ProgressBar

public ProgressBar(float progress)

Deprecated.

Creates a new progress bar with the given initial value.

Parameters:

progress - the initial progress value

ProgressBar

public ProgressBar(Property<?> dataSource)

Deprecated.

Creates a new progress bar bound to the given data source.

Parameters:

dataSource - the property to bind this progress bar to

Method Detail

beforeClientResponse

public void beforeClientResponse(boolean initial)

Deprecated.

Specified by:

beforeClientResponse in interface ClientConnector

Overrides:

beforeClientResponse in class AbstractField<Float>

getValue

public Float getValue()

Deprecated.

Gets the value of this progress bar. The value is a float between 0 and 1 where 0 represents no progress at all and 1 represents fully completed.

Specified by:

getValue in interface Property<Float>

Overrides:

getValue in class AbstractField<Float>

Returns:

the current progress value

setValue

public void setValue(Float newValue)

Deprecated.

Sets the value of this progress bar. The value is a float between 0 and 1 where 0 represents no progress at all and 1 represents fully completed.

Specified by:

setValue in interface Property<Float>

Overrides:

setValue in class AbstractField<Float>

Parameters:

newValue - the current progress value

getType

public Class<Float> getType()

Deprecated.

Description copied from class: AbstractField

Returns the type of the Field. The methods getValue and setValue must be compatible with this type: one must be able to safely cast the value returned from getValue to the given type and pass any variable assignable to this type as an argument to setValue.

Specified by:

getType in interface Property<Float>

Specified by:

getType in class AbstractField<Float>

Returns:

the type of the Field

getState

protected ProgressBarState getState()

Deprecated.

Overrides:

getState in class AbstractField<Float>

getState

protected ProgressBarState getState(boolean markAsDirty)

Deprecated.

Overrides:

getState in class AbstractField<Float>

setIndeterminate

public void setIndeterminate(boolean indeterminate)

Deprecated.

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.

Parameters:

indeterminate - true to set to indeterminate mode; otherwise false

isIndeterminate

public boolean isIndeterminate()

Deprecated.

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.

Returns:

true if set to indeterminate mode; otherwise false

setInternalValue

protected void setInternalValue(Float newValue)

Deprecated.

Description copied from class: AbstractField

Sets the internal field value. This is purely used by AbstractField to change the internal Field value. It does not trigger valuechange events. It can be overridden by the inheriting classes to update all dependent variables. Subclasses can also override AbstractField.getInternalValue() if necessary.

Overrides:

setInternalValue in class AbstractField<Float>

Parameters:

newValue - the new value to be set.

readDesign

public void readDesign(org.jsoup.nodes.Element design,
                       DesignContext designContext)

Deprecated.

Specified by:

readDesign in interface Component

Overrides:

readDesign in class AbstractField<Float>

writeDesign

public void writeDesign(org.jsoup.nodes.Element design,
                        DesignContext designContext)

Deprecated.

Specified by:

writeDesign in interface Component

Overrides:

writeDesign in class AbstractField<Float>

clear

public void clear()

Deprecated.

Description copied from interface: Field

Clears the value of the field.

The field value is typically reset to the initial value of the field. Calling Field.isEmpty() on a cleared field must always returns true.

Specified by:

clear in interface Field<Float>

Overrides:

clear in class AbstractField<Float>

isEmpty

public boolean isEmpty()

Deprecated.

Description copied from interface: Field

Is the field empty? In general, "empty" state is same as null. As an exception, TextField also treats empty string as "empty".

Specified by:

isEmpty in interface Field<Float>

Overrides:

isEmpty in class AbstractField<Float>

Returns:

true if the field is empty, false otherwise