com.whitestein.lsps.vaadin.ui.components

Class UIFileUpload

java.lang.Object

com.vaadin.server.AbstractClientConnector

com.vaadin.ui.AbstractComponent

com.vaadin.ui.Upload

com.whitestein.lsps.vaadin.ui.components.UIFileUpload

All Implemented Interfaces:

com.vaadin.data.Property.Editor, com.vaadin.data.Property.Viewer, com.vaadin.event.ConnectorEventListener, com.vaadin.event.ContextClickEvent.ContextClickNotifier, com.vaadin.event.MethodEventSource, com.vaadin.server.ClientConnector, com.vaadin.server.Sizeable, com.vaadin.server.VariableOwner, com.vaadin.shared.Connector, com.vaadin.ui.Component, com.vaadin.ui.Component.Focusable, com.vaadin.ui.LegacyComponent, com.vaadin.ui.Upload.FailedListener, com.vaadin.ui.Upload.Receiver, com.vaadin.ui.Upload.StartedListener, com.vaadin.ui.Upload.SucceededListener, UIComponent, UIComponentWithHints2, Serializable, EventListener

public class UIFileUpload
extends com.vaadin.ui.Upload
implements UIComponentWithHints2, com.vaadin.data.Property.Editor, com.vaadin.ui.Upload.StartedListener, com.vaadin.ui.Upload.SucceededListener, com.vaadin.ui.Upload.FailedListener, com.vaadin.ui.Upload.Receiver

Standard Vaadin component for "ui::FileUpload".

Author:

mbj

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	UIFileUpload.AcceptMimeExtension Component extension that allows to access the accept attribute of the upload input.

Nested classes/interfaces inherited from class com.vaadin.ui.Upload

com.vaadin.ui.Upload.ChangeEvent, com.vaadin.ui.Upload.ChangeListener, com.vaadin.ui.Upload.FailedEvent, com.vaadin.ui.Upload.FailedListener, com.vaadin.ui.Upload.FinishedEvent, com.vaadin.ui.Upload.FinishedListener, com.vaadin.ui.Upload.NoInputStreamEvent, com.vaadin.ui.Upload.NoOutputStreamEvent, com.vaadin.ui.Upload.ProgressListener, com.vaadin.ui.Upload.Receiver, com.vaadin.ui.Upload.StartedEvent, com.vaadin.ui.Upload.StartedListener, com.vaadin.ui.Upload.SucceededEvent, com.vaadin.ui.Upload.SucceededListener

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

Modifier and Type	Field and Description
protected ByteArrayOutputStream	uploadedContent Last file uploaded via this component
protected boolean	uploadToMemory If true, this component will use memory to store uploaded files before they get committed.

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
UIFileUpload(UIComponentData componentData)

Method Summary

Modifier and Type	Method and Description
boolean	applyHint(String hintName, Variant<Object> newValue, Variant<Object> oldValue) Applies the given hint to this component.
UIComponentData	getComponentData() Returns the component definition (LSPS RecordHolder instance which is subtype of "ui::Component") associated with this Vaadin component.
com.vaadin.data.Property	getPropertyDataSource()
com.vaadin.ui.AbstractComponent	getWidget() Returns the Vaadin widget which implements the UI part of this component.
OutputStream	receiveUpload(String filename, String mimeType)
void	refresh() This method is called from LSPS rendering engine.
void	setPropertyDataSource(com.vaadin.data.Property newDataSource)
String	toString()
boolean	unapplyHint(String hintName, Variant<Object> oldValue) The hint has been removed from the hint map.
void	uploadFailed(com.vaadin.ui.Upload.FailedEvent event)
void	uploadStarted(com.vaadin.ui.Upload.StartedEvent event)
void	uploadSucceeded(com.vaadin.ui.Upload.SucceededEvent event)

Methods inherited from class com.vaadin.ui.Upload

addChangeListener, addFailedListener, addFinishedListener, addListener, addListener, addListener, addListener, addListener, addProgressListener, addStartedListener, addSucceededListener, changeVariables, fireNoInputStream, fireNoOutputStream, fireStarted, fireUpdateProgress, fireUploadInterrupted, fireUploadInterrupted, fireUploadSuccess, focus, getButtonCaption, getBytesRead, getListeners, getReceiver, getState, getStreamVariable, getTabIndex, getUploadSize, interruptUpload, isUploading, markAsDirty, paintContent, removeChangeListener, removeFailedListener, removeFinishedListener, removeListener, removeListener, removeListener, removeListener, removeListener, removeProgressListener, removeStartedListener, removeSucceededListener, setButtonCaption, setReceiver, setTabIndex, startUpload, submitUpload

Methods inherited from class com.vaadin.ui.AbstractComponent

addContextClickListener, addListener, addShortcutListener, addStyleName, attach, beforeClientResponse, detach, findAncestor, fireComponentErrorEvent, fireComponentEvent, getActionManager, getCaption, getComponentError, getCustomAttributes, getData, getDebugId, getDescription, getErrorMessage, getExplicitImmediateValue, getHeight, getHeightUnits, getIcon, getId, getLocale, getParent, getPrimaryStyleName, getState, getStyleName, getWidth, getWidthUnits, isCaptionAsHtml, isConnectorEnabled, isEnabled, isImmediate, isOrHasAncestor, isReadOnly, isResponsive, isVisible, readDesign, removeContextClickListener, removeListener, removeShortcutListener, removeStyleName, setCaption, setCaptionAsHtml, setComponentError, setData, setDebugId, setDescription, setEnabled, setHeight, setHeight, setHeightUndefined, setIcon, setId, setImmediate, setLocale, setParent, setPrimaryStyleName, setReadOnly, setResponsive, setSizeFull, setSizeUndefined, setStyleName, setStyleName, setVisible, 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, getResource, getRpcManager, getRpcProxy, getSession, getStateType, getUI, handleConnectorRequest, hashCode, hasListeners, isAttached, isThis, 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, wait, wait, wait

Methods inherited from interface com.vaadin.server.VariableOwner

isEnabled, isImmediate

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, setVisible, writeDesign

Methods inherited from interface com.vaadin.server.ClientConnector

addAttachListener, addDetachListener, beforeClientResponse, detach, encodeState, getErrorHandler, getExtensions, getRpcManager, getStateType, handleConnectorRequest, isAttached, isConnectorEnabled, 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

Field Detail

uploadedContent

protected transient ByteArrayOutputStream uploadedContent

Last file uploaded via this component

uploadToMemory

protected final boolean uploadToMemory

If true, this component will use memory to store uploaded files before they get committed. If false, lsps system table will be used.

Constructor Detail

UIFileUpload

public UIFileUpload(UIComponentData componentData)

Parameters:

componentData -

Method Detail

refresh

public void refresh()

Description copied from interface: UIComponent

This method is called from LSPS rendering engine. It should load all information needed from component definition record holder and apply them accordingly.

Note that this method should not attempt to apply any hints - hints are applied automatically after the component is refreshed. You however may read the hints value here - it is guaranteed that you will receive freshly updated hint value by reading UIComponentData.getHints().

Specified by:

refresh in interface UIComponent

applyHint

public boolean applyHint(String hintName,
                         Variant<Object> newValue,
                         Variant<Object> oldValue)

Description copied from interface: UIComponentWithHints2

Applies the given hint to this component.

Specified by:

applyHint in interface UIComponentWithHints2

Parameters:

hintName - the hint name, not null.

newValue - variant containing the new hint value, never null, may contain null value.

oldValue - variant containing the previous hint value, never null, may contain null value if the hint was missing or the old value was null.

Returns:

true if the hint is supported and was applied, false if the hint is not known to this component.

unapplyHint

public boolean unapplyHint(String hintName,
                           Variant<Object> oldValue)

Description copied from interface: UIComponentWithHints2

The hint has been removed from the hint map. Unapply from the component and revert the value to the default one.

Specified by:

unapplyHint in interface UIComponentWithHints2

Parameters:

hintName - the the hint name, not null.

oldValue - variant containing the previous hint value, never null, may contain null value if the old value was null.

Returns:

true if the hint is supported and was applied, false if the hint is not known to this component.

getComponentData

public UIComponentData getComponentData()

Description copied from interface: UIComponent

Returns the component definition (LSPS RecordHolder instance which is subtype of "ui::Component") associated with this Vaadin component.

Specified by:

getComponentData in interface UIComponent

Returns:

component definition. The definition record instance must be present in root scope (screen context).

receiveUpload

public OutputStream receiveUpload(String filename,
                                  String mimeType)

Specified by:

receiveUpload in interface com.vaadin.ui.Upload.Receiver

uploadStarted

public void uploadStarted(com.vaadin.ui.Upload.StartedEvent event)

Specified by:

uploadStarted in interface com.vaadin.ui.Upload.StartedListener

uploadFailed

public void uploadFailed(com.vaadin.ui.Upload.FailedEvent event)

Specified by:

uploadFailed in interface com.vaadin.ui.Upload.FailedListener

uploadSucceeded

public void uploadSucceeded(com.vaadin.ui.Upload.SucceededEvent event)

Specified by:

uploadSucceeded in interface com.vaadin.ui.Upload.SucceededListener

setPropertyDataSource

public void setPropertyDataSource(com.vaadin.data.Property newDataSource)

Specified by:

setPropertyDataSource in interface com.vaadin.data.Property.Viewer

getPropertyDataSource

public com.vaadin.data.Property getPropertyDataSource()

Specified by:

getPropertyDataSource in interface com.vaadin.data.Property.Viewer

toString

public String toString()

Overrides:

toString in class Object

getWidget

public com.vaadin.ui.AbstractComponent getWidget()

Description copied from interface: UIComponent

Returns the Vaadin widget which implements the UI part of this component.

Specified by:

getWidget in interface UIComponent

Returns:

the widget, not null.