io.jmix.ui.widget

Class JmixFileUpload

java.lang.Object

com.vaadin.server.AbstractClientConnector

com.vaadin.ui.AbstractComponent

io.jmix.ui.widget.JmixFileUpload

All Implemented Interfaces:

com.vaadin.event.ConnectorEventListener, com.vaadin.event.ContextClickEvent.ContextClickNotifier, com.vaadin.event.MethodEventSource, com.vaadin.event.SerializableEventListener, 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.Component.HasContextHelp, com.vaadin.ui.LegacyComponent, UploadComponent, java.io.Serializable, java.util.EventListener

public class JmixFileUpload
extends com.vaadin.ui.AbstractComponent
implements com.vaadin.ui.Component.Focusable, UploadComponent, com.vaadin.ui.LegacyComponent

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	JmixFileUpload.FailedEvent JmixFileUpload.FailedEvent event is sent when the upload is received, but the reception is interrupted for some reason.
static interface	JmixFileUpload.FailedListener Receives events when the uploads are finished, but unsuccessful.
static class	JmixFileUpload.FileExtensionNotAllowedEvent
static interface	JmixFileUpload.FileExtensionNotAllowedListener Receives events when the file extension is not included in getPermittedExtensions().
static class	JmixFileUpload.FileSizeLimitExceededEvent
static interface	JmixFileUpload.FileSizeLimitExceededListener Receives events when the file size is greater than getFileSizeLimit().
static class	JmixFileUpload.FinishedEvent JmixFileUpload.FinishedEvent is sent when the upload receives a file, regardless of whether the reception was successful or failed.
static interface	JmixFileUpload.FinishedListener Receives the events when the uploads are ready.
static class	JmixFileUpload.NoInputStreamEvent FailedEvent that indicates that an input stream could not be obtained.
static class	JmixFileUpload.NoOutputStreamEvent FailedEvent that indicates that an output stream could not be obtained.
static class	JmixFileUpload.QueueFinishedEvent JmixFileUpload.StartedEvent event is sent when the queue upload is finished.
static interface	JmixFileUpload.QueueFinishedListener
static interface	JmixFileUpload.Receiver Interface that must be implemented by the upload receivers to provide the JmixFileUpload component an output stream to write the uploaded data.
static class	JmixFileUpload.StartedEvent JmixFileUpload.StartedEvent event is sent when the upload is started to received.
static interface	JmixFileUpload.StartedListener Receives the events when the upload starts.
static class	JmixFileUpload.SucceededEvent JmixFileUpload.SucceededEvent event is sent when the upload is received successfully.
static interface	JmixFileUpload.SucceededListener Receives events when the uploads are successfully finished.

Nested classes/interfaces inherited from class com.vaadin.server.AbstractClientConnector

com.vaadin.server.AbstractClientConnector.IncorrectConcurrentAccessHandler

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.HasContextHelp, 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

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

com.vaadin.ui.Component.HasContextHelp.ContextHelpIconClickEvent, com.vaadin.ui.Component.HasContextHelp.ContextHelpIconClickListener

Field Summary

Fields

Modifier and Type	Field and Description
protected long	contentLength
protected boolean	interrupted
protected boolean	isUploading
protected java.util.Map<java.lang.String,java.lang.String>	mimeTypes
protected JmixFileUpload.Receiver	receiver The output of the upload is redirected to this receiver.
protected com.vaadin.server.StreamVariable	streamVariable

Fields inherited from class com.vaadin.ui.AbstractComponent

componentErrorProvider, DESIGN_ATTR_PLAIN_TEXT, requiredError

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
JmixFileUpload()

Method Summary

Modifier and Type	Method and Description
void	addFailedListener(JmixFileUpload.FailedListener listener)
void	addFileExtensionNotAllowedListener(JmixFileUpload.FileExtensionNotAllowedListener listener)
void	addFileSizeLimitExceededListener(JmixFileUpload.FileSizeLimitExceededListener listener)
void	addFinishedListener(JmixFileUpload.FinishedListener listener)
void	addQueueUploadFinishedListener(JmixFileUpload.QueueFinishedListener listener)
void	addStartedListener(JmixFileUpload.StartedListener listener)
void	addSucceededListener(JmixFileUpload.SucceededListener listener)
void	changeVariables(java.lang.Object source, java.util.Map<java.lang.String,java.lang.Object> variables)
protected void	endUpload() Go into state where new uploading can begin.
protected void	fireFileExtensionNotAllowed(java.lang.String fileName)
protected void	fireFileSizeLimitExceeded(java.lang.String fileName)
protected void	fireNoInputStream(java.lang.String fileName, java.lang.String MIMEType, long length)
protected void	fireNoOutputStream(java.lang.String fileName, java.lang.String MIMEType, long length)
protected void	fireQueueUploadFinished()
protected void	fireStarted(java.lang.String fileName, java.lang.String MIMEType)
protected void	fireUploadInterrupted(java.lang.String fileName, java.lang.String MIMEType, long length, java.lang.Exception e)
protected void	fireUploadSuccess(java.lang.String fileName, java.lang.String MIMEType, long length)
void	focus()
java.lang.String	getAccept()
java.lang.String	getCancelButtonCaption()
com.vaadin.ui.Component	getDropZone()
java.lang.String	getDropZonePrompt()
double	getFileSizeLimit()
java.lang.String	getIconAlternateText() Returns the icon's alt text.
com.vaadin.ui.Component	getPasteZone()
java.util.Set<java.lang.String>	getPermittedExtensions()
java.lang.String	getProgressWindowCaption()
JmixFileUpload.Receiver	getReceiver()
protected JmixFileUploadState	getState()
protected JmixFileUploadState	getState(boolean markAsDirty)
protected com.vaadin.server.StreamVariable	getStreamVariable()
int	getTabIndex()
java.lang.String	getUnableToUploadFileMessage()
protected void	interruptUpload() Interrupts the upload currently being received.
boolean	isHtmlContentAllowed() Return HTML rendering setting
boolean	isMultiSelect()
void	paintContent(com.vaadin.server.PaintTarget target)
void	removeFailedListener(JmixFileUpload.FailedListener listener)
void	removeFileExtensionNotAllowedListener(JmixFileUpload.FileExtensionNotAllowedListener listener)
void	removeFileSizeLimitExceededListener(JmixFileUpload.FileSizeLimitExceededListener listener)
void	removeFinishedListener(JmixFileUpload.FinishedListener listener)
void	removeQueueUploadFinishedListener(JmixFileUpload.QueueFinishedListener listener)
void	removeStartedListener(JmixFileUpload.StartedListener listener)
void	removeSucceededListener(JmixFileUpload.SucceededListener listener)
protected void	resetUploadingErrorHandler()
void	setAccept(java.lang.String accept) Note: this is just a hint for browser, user may select files that do not meet this property
void	setCancelButtonCaption(java.lang.String cancelButtonCaption)
void	setDropZone(com.vaadin.ui.Component component)
void	setDropZonePrompt(java.lang.String dropZonePrompt)
void	setFileSizeLimit(long fileSizeLimit)
void	setHtmlContentAllowed(boolean htmlContentAllowed) Set whether the caption text is rendered as HTML or not.
void	setIcon(com.vaadin.server.Resource icon, java.lang.String iconAltText) Sets the component's icon and alt text.
void	setIconAlternateText(java.lang.String iconAltText)
void	setMultiSelect(boolean multiSelect)
void	setPasteZone(com.vaadin.ui.Component component)
void	setPermittedExtensions(java.util.Set<java.lang.String> permittedExtensions)
void	setProgressWindowCaption(java.lang.String progressWindowCaption)
void	setReceiver(JmixFileUpload.Receiver receiver)
void	setTabIndex(int tabIndex)
void	setUnableToUploadFileMessage(java.lang.String message)
protected void	setUploadingErrorHandler()
protected void	startUpload() Go into upload state.

Methods inherited from class com.vaadin.ui.AbstractComponent

addContextClickListener, addContextHelpIconClickListener, addListener, addShortcutListener, addStyleName, attach, beforeClientResponse, detach, ensureContextHelpInitialized, findAncestor, fireComponentErrorEvent, fireComponentEvent, fireContextHelpClick, getActionManager, getCaption, getComponentError, getComponentErrorProvider, getContextHelpText, getCustomAttributes, getData, getDebugId, getDescription, getErrorMessage, getHeight, getHeightUnits, getIcon, getId, getJTestId, getLocale, getParent, getPrimaryStyleName, getRequiredError, getStyleName, getWidth, getWidthUnits, isCaptionAsHtml, isConnectorEnabled, isContextHelpTextHtmlEnabled, isEnabled, isOrHasAncestor, isReadOnly, isRequiredIndicatorVisible, isResponsive, isVisible, readDesign, removeContextClickListener, removeListener, removeShortcutListener, removeStyleName, setCaption, setCaptionAsHtml, setComponentError, setComponentErrorProvider, setContextHelpText, setContextHelpTextHtmlEnabled, setData, setDebugId, setDescription, setDescription, setEnabled, setHeight, setHeight, setHeightFull, setHeightUndefined, setIcon, setId, setJTestId, setLocale, setParent, setPrimaryStyleName, setReadOnly, setRequiredError, setRequiredIndicatorVisible, setResponsive, setSizeFull, setSizeUndefined, setStyleName, setVisible, setWidth, setWidth, setWidthFull, setWidthUndefined, writeDesign

Methods inherited from class com.vaadin.server.AbstractClientConnector

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

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.jmix.ui.widget.UploadComponent

setDescription

Methods inherited from interface com.vaadin.ui.Component

addListener, addStyleName, addStyleNames, attach, getCaption, getDescription, getIcon, getId, getJTestId, getLocale, getParent, getPrimaryStyleName, getStyleName, getUI, isEnabled, isVisible, readDesign, removeListener, removeStyleName, removeStyleNames, setCaption, setEnabled, setIcon, setId, setJTestId, setParent, setPrimaryStyleName, setStyleName, setStyleName, setVisible, 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, setHeightFull, setHeightUndefined, setSizeFull, setSizeUndefined, setWidth, setWidth, setWidthFull, setWidthUndefined

Methods inherited from interface com.vaadin.ui.LegacyComponent

markAsDirty

Methods inherited from interface com.vaadin.server.VariableOwner

isEnabled

Field Detail

receiver

protected JmixFileUpload.Receiver receiver

The output of the upload is redirected to this receiver.

isUploading

protected boolean isUploading

contentLength

protected long contentLength

mimeTypes

protected java.util.Map<java.lang.String,java.lang.String> mimeTypes

interrupted

protected boolean interrupted

streamVariable

protected com.vaadin.server.StreamVariable streamVariable

Constructor Detail

JmixFileUpload

public JmixFileUpload()

Method Detail

setUploadingErrorHandler

protected void setUploadingErrorHandler()

resetUploadingErrorHandler

protected void resetUploadingErrorHandler()

getState

protected JmixFileUploadState getState()

Overrides:

getState in class com.vaadin.ui.AbstractComponent

getState

protected JmixFileUploadState getState(boolean markAsDirty)

Overrides:

getState in class com.vaadin.ui.AbstractComponent

getTabIndex

public int getTabIndex()

Specified by:

getTabIndex in interface com.vaadin.ui.Component.Focusable

setTabIndex

public void setTabIndex(int tabIndex)

Specified by:

setTabIndex in interface com.vaadin.ui.Component.Focusable

getIconAlternateText

public java.lang.String getIconAlternateText()

Returns the icon's alt text.

Returns:

String with the alt text

setIconAlternateText

public void setIconAlternateText(java.lang.String iconAltText)

isHtmlContentAllowed

public boolean isHtmlContentAllowed()

Return HTML rendering setting

Returns:

true if the caption text is to be rendered as HTML, false otherwise

setHtmlContentAllowed

public void setHtmlContentAllowed(boolean htmlContentAllowed)

Set whether the caption text is rendered as HTML or not. You might need to re-theme button to allow higher content than the original text style.

If set to true, the captions are passed to the browser as html and the developer is responsible for ensuring no harmful html is used. If set to false, the content is passed to the browser as plain text.

Parameters:

htmlContentAllowed - true if caption is rendered as HTML, false otherwise

setIcon

public void setIcon(com.vaadin.server.Resource icon,
                    java.lang.String iconAltText)

Sets the component's icon and alt text.

An alt text is shown when an image could not be loaded, and read by assistive devices.

Parameters:

icon - the icon to be shown with the component's caption.

iconAltText - String to use as alt text

isMultiSelect

public boolean isMultiSelect()

setMultiSelect

public void setMultiSelect(boolean multiSelect)

getUnableToUploadFileMessage

public java.lang.String getUnableToUploadFileMessage()

setUnableToUploadFileMessage

public void setUnableToUploadFileMessage(java.lang.String message)

getProgressWindowCaption

public java.lang.String getProgressWindowCaption()

setProgressWindowCaption

public void setProgressWindowCaption(java.lang.String progressWindowCaption)

getCancelButtonCaption

public java.lang.String getCancelButtonCaption()

setCancelButtonCaption

public void setCancelButtonCaption(java.lang.String cancelButtonCaption)

getAccept

@Nullable
public java.lang.String getAccept()

Specified by:

getAccept in interface UploadComponent

setAccept

public void setAccept(@Nullable
                      java.lang.String accept)

Note: this is just a hint for browser, user may select files that do not meet this property

Specified by:

setAccept in interface UploadComponent

Parameters:

accept - mime types, comma separated

getPermittedExtensions

@Nullable
public java.util.Set<java.lang.String> getPermittedExtensions()

setPermittedExtensions

public void setPermittedExtensions(@Nullable
                                   java.util.Set<java.lang.String> permittedExtensions)

getFileSizeLimit

public double getFileSizeLimit()

setFileSizeLimit

public void setFileSizeLimit(long fileSizeLimit)

Parameters:

fileSizeLimit - file size limit in bytes

getReceiver

@Nullable
public JmixFileUpload.Receiver getReceiver()

setReceiver

public void setReceiver(@Nullable
                        JmixFileUpload.Receiver receiver)

getDropZone

@Nullable
public com.vaadin.ui.Component getDropZone()

setDropZone

public void setDropZone(@Nullable
                        com.vaadin.ui.Component component)

setPasteZone

public void setPasteZone(@Nullable
                         com.vaadin.ui.Component component)

getPasteZone

@Nullable
public com.vaadin.ui.Component getPasteZone()

getDropZonePrompt

@Nullable
public java.lang.String getDropZonePrompt()

setDropZonePrompt

public void setDropZonePrompt(@Nullable
                              java.lang.String dropZonePrompt)

getStreamVariable

protected com.vaadin.server.StreamVariable getStreamVariable()

startUpload

protected void startUpload()

Go into upload state. This is to prevent double uploading on same component.

Warning: this is an internal method used by the framework and should not be used by user of the Upload component. Using it results in the Upload component going in wrong state and not working. It is currently public because it is used by another class.

interruptUpload

protected void interruptUpload()

Interrupts the upload currently being received. The interruption will be done by the receiving thread so this method will return immediately and the actual interrupt will happen a bit later.

endUpload

protected void endUpload()

Go into state where new uploading can begin.

Warning: this is an internal method used by the framework and should not be used by user of the Upload component.

paintContent

public void paintContent(com.vaadin.server.PaintTarget target)
                  throws com.vaadin.server.PaintException

Specified by:

paintContent in interface com.vaadin.ui.LegacyComponent

Throws:

com.vaadin.server.PaintException

changeVariables

public void changeVariables(java.lang.Object source,
                            java.util.Map<java.lang.String,java.lang.Object> variables)

Specified by:

changeVariables in interface com.vaadin.server.VariableOwner

fireStarted

protected void fireStarted(java.lang.String fileName,
                           java.lang.String MIMEType)

fireNoInputStream

protected void fireNoInputStream(java.lang.String fileName,
                                 java.lang.String MIMEType,
                                 long length)

fireNoOutputStream

protected void fireNoOutputStream(java.lang.String fileName,
                                  java.lang.String MIMEType,
                                  long length)

fireUploadInterrupted

protected void fireUploadInterrupted(java.lang.String fileName,
                                     java.lang.String MIMEType,
                                     long length,
                                     java.lang.Exception e)

fireUploadSuccess

protected void fireUploadSuccess(java.lang.String fileName,
                                 java.lang.String MIMEType,
                                 long length)

fireFileSizeLimitExceeded

protected void fireFileSizeLimitExceeded(java.lang.String fileName)

fireFileExtensionNotAllowed

protected void fireFileExtensionNotAllowed(java.lang.String fileName)

fireQueueUploadFinished

protected void fireQueueUploadFinished()

addStartedListener

public void addStartedListener(JmixFileUpload.StartedListener listener)

removeStartedListener

public void removeStartedListener(JmixFileUpload.StartedListener listener)

addFinishedListener

public void addFinishedListener(JmixFileUpload.FinishedListener listener)

removeFinishedListener

public void removeFinishedListener(JmixFileUpload.FinishedListener listener)

addFailedListener

public void addFailedListener(JmixFileUpload.FailedListener listener)

removeFailedListener

public void removeFailedListener(JmixFileUpload.FailedListener listener)

addSucceededListener

public void addSucceededListener(JmixFileUpload.SucceededListener listener)

removeSucceededListener

public void removeSucceededListener(JmixFileUpload.SucceededListener listener)

addFileSizeLimitExceededListener

public void addFileSizeLimitExceededListener(JmixFileUpload.FileSizeLimitExceededListener listener)

addFileExtensionNotAllowedListener

public void addFileExtensionNotAllowedListener(JmixFileUpload.FileExtensionNotAllowedListener listener)

removeFileExtensionNotAllowedListener

public void removeFileExtensionNotAllowedListener(JmixFileUpload.FileExtensionNotAllowedListener listener)

removeFileSizeLimitExceededListener

public void removeFileSizeLimitExceededListener(JmixFileUpload.FileSizeLimitExceededListener listener)

addQueueUploadFinishedListener

public void addQueueUploadFinishedListener(JmixFileUpload.QueueFinishedListener listener)

removeQueueUploadFinishedListener

public void removeQueueUploadFinishedListener(JmixFileUpload.QueueFinishedListener listener)

focus

public void focus()

Specified by:

focus in interface com.vaadin.ui.Component.Focusable

Overrides:

focus in class com.vaadin.ui.AbstractComponent