info.magnolia.ui.form.field.upload.basic

Class BasicUploadProgressIndicator

java.lang.Object

com.vaadin.server.AbstractClientConnector

com.vaadin.ui.AbstractComponent

com.vaadin.ui.CustomComponent

info.magnolia.ui.form.field.upload.basic.BasicUploadProgressIndicator

All Implemented Interfaces:

com.vaadin.event.MethodEventSource, com.vaadin.server.ClientConnector, com.vaadin.server.Sizeable, com.vaadin.shared.Connector, com.vaadin.ui.Component, com.vaadin.ui.HasComponents, UploadProgressIndicator, Serializable, Iterable<com.vaadin.ui.Component>

public class BasicUploadProgressIndicator
extends com.vaadin.ui.CustomComponent
implements UploadProgressIndicator

Custom Component used to create a custom display for the progress indicator.

This view normally contains a progress bar and a label indicating the uploaded percentage, filename...
Refreshing the view is done by calling refreshLayout(long, long, String)

Layout composition:

• Label.FileName
• ProgressBar
• Label.percentage
• Label.UploadexOfy

See Also:

Serialized Form

Nested Class Summary

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

com.vaadin.ui.HasComponents.ComponentAttachDetachNotifier, com.vaadin.ui.HasComponents.ComponentAttachEvent, com.vaadin.ui.HasComponents.ComponentAttachListener, com.vaadin.ui.HasComponents.ComponentDetachEvent, com.vaadin.ui.HasComponents.ComponentDetachListener

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

com.vaadin.ui.Component.ErrorEvent, com.vaadin.ui.Component.Event, com.vaadin.ui.Component.Focusable, com.vaadin.ui.Component.Listener

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

com.vaadin.server.ClientConnector.AttachEvent, com.vaadin.server.ClientConnector.AttachListener, com.vaadin.server.ClientConnector.ConnectorErrorEvent, com.vaadin.server.ClientConnector.DetachEvent, com.vaadin.server.ClientConnector.DetachListener

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

com.vaadin.server.Sizeable.Unit

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
BasicUploadProgressIndicator(String inProgressCaption, String inProgressRatioCaption, info.magnolia.i18nsystem.SimpleTranslator i18n)

Method Summary

Methods

Modifier and Type	Method and Description
com.vaadin.ui.Component	asVaadinComponent() Returns the Vaadin component used to display progress.
void	refreshLayout(long readBytes, long contentLength, String fileName) Refreshes the progress indicator layout.
void	setProgress(float progress) Sets the current progress.
void	setVisible(boolean visible) Set the Component Visible or not.

Methods inherited from class com.vaadin.ui.CustomComponent

getComponentCount, getCompositionRoot, iterator, setCompositionRoot

Methods inherited from class com.vaadin.ui.AbstractComponent

addListener, addShortcutListener, addStyleName, attach, beforeClientResponse, detach, findAncestor, fireComponentErrorEvent, fireComponentEvent, focus, getActionManager, getCaption, getComponentError, getCustomAttributes, getData, getDebugId, getDescription, getErrorMessage, getHeight, getHeightUnits, getIcon, getId, getLocale, getParent, getPrimaryStyleName, getState, getState, getStyleName, getWidth, getWidthUnits, isCaptionAsHtml, isConnectorEnabled, isEnabled, isImmediate, isOrHasAncestor, isReadOnly, isVisible, readDesign, removeListener, removeShortcutListener, removeStyleName, setCaption, setCaptionAsHtml, setComponentError, setData, setDebugId, setDescription, setEnabled, setHeight, setHeight, setHeightUndefined, setIcon, setId, setImmediate, setLocale, setParent, setPrimaryStyleName, setReadOnly, setSizeFull, setSizeUndefined, setStyleName, setWidth, setWidth, setWidthUndefined, writeDesign

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

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, attach, getCaption, getDescription, getIcon, getId, getLocale, getParent, getPrimaryStyleName, getStyleName, getUI, isEnabled, isReadOnly, isVisible, readDesign, removeListener, removeStyleName, setCaption, setEnabled, setIcon, setId, setParent, setPrimaryStyleName, setReadOnly, setStyleName, writeDesign

Methods inherited from interface com.vaadin.server.ClientConnector

addAttachListener, addDetachListener, beforeClientResponse, detach, 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

Constructor Detail

BasicUploadProgressIndicator

public BasicUploadProgressIndicator(String inProgressCaption,
                            String inProgressRatioCaption,
                            info.magnolia.i18nsystem.SimpleTranslator i18n)

Method Detail

refreshLayout

public void refreshLayout(long readBytes,
                 long contentLength,
                 String fileName)

Description copied from interface: UploadProgressIndicator

Refreshes the progress indicator layout.

Specified by:

refreshLayout in interface UploadProgressIndicator

setProgress

public void setProgress(float progress)

Description copied from interface: UploadProgressIndicator

Sets the current progress.

Specified by:

setProgress in interface UploadProgressIndicator

setVisible

public void setVisible(boolean visible)

Description copied from interface: UploadProgressIndicator

Set the Component Visible or not.

Specified by:

setVisible in interface com.vaadin.ui.Component

Specified by:

setVisible in interface UploadProgressIndicator

Overrides:

setVisible in class com.vaadin.ui.AbstractComponent

asVaadinComponent

public com.vaadin.ui.Component asVaadinComponent()

Description copied from interface: UploadProgressIndicator

Returns the Vaadin component used to display progress.

Specified by:

asVaadinComponent in interface UploadProgressIndicator