Package io.jmix.flowui.component.upload

Class FileStorageUploadField

java.lang.Object

com.vaadin.flow.component.Component

com.vaadin.flow.component.AbstractField<FileStorageUploadField,FileRef>

io.jmix.flowui.kit.component.upload.AbstractSingleUploadField<FileStorageUploadField,FileRef,TemporaryStorage.FileInfo>

io.jmix.flowui.kit.component.upload.JmixFileStorageUploadField<FileStorageUploadField,FileRef,TemporaryStorage.FileInfo>

io.jmix.flowui.component.upload.FileStorageUploadField

All Implemented Interfaces:

com.vaadin.flow.component.AttachNotifier, com.vaadin.flow.component.DetachNotifier, com.vaadin.flow.component.HasElement, com.vaadin.flow.component.HasEnabled, com.vaadin.flow.component.HasHelper, com.vaadin.flow.component.HasLabel, com.vaadin.flow.component.HasSize, com.vaadin.flow.component.HasStyle, com.vaadin.flow.component.HasTheme, com.vaadin.flow.component.HasValidation, com.vaadin.flow.component.HasValue<com.vaadin.flow.component.AbstractField.ComponentValueChangeEvent<FileStorageUploadField,FileRef>,FileRef>, com.vaadin.flow.component.HasValueAndElement<com.vaadin.flow.component.AbstractField.ComponentValueChangeEvent<FileStorageUploadField,FileRef>,FileRef>, com.vaadin.flow.component.shared.HasTooltip, com.vaadin.flow.component.shared.HasValidationProperties, HasRequired, SupportsStatusChangeHandler<FileStorageUploadField>, SupportsValidation<FileRef>, SupportsValueSource<FileRef>, Serializable, org.springframework.beans.factory.Aware, org.springframework.beans.factory.InitializingBean, org.springframework.context.ApplicationContextAware

public class FileStorageUploadField
extends JmixFileStorageUploadField<FileStorageUploadField,FileRef,TemporaryStorage.FileInfo>
implements SupportsValueSource<FileRef>, SupportsValidation<FileRef>, HasRequired, SupportsStatusChangeHandler<FileStorageUploadField>, org.springframework.context.ApplicationContextAware, org.springframework.beans.factory.InitializingBean

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.vaadin.flow.component.AbstractField

com.vaadin.flow.component.AbstractField.ComponentValueChangeEvent<C extends com.vaadin.flow.component.Component,V>

Nested classes/interfaces inherited from interface com.vaadin.flow.component.HasValue

com.vaadin.flow.component.HasValue.ValueChangeEvent<V>, com.vaadin.flow.component.HasValue.ValueChangeListener<E extends com.vaadin.flow.component.HasValue.ValueChangeEvent<?>>

Nested classes/interfaces inherited from interface io.jmix.flowui.component.SupportsStatusChangeHandler

SupportsStatusChangeHandler.StatusContext<C extends com.vaadin.flow.component.Component>

Field Summary

Fields

Modifier and Type	Field	Description
protected org.springframework.context.ApplicationContext	applicationContext
protected Downloader	downloader
protected FileFieldDelegate<FileStorageUploadField,FileRef,FileRef>	fieldDelegate
protected FileStorage	fileStorage
protected FileStorageLocator	fileStorageLocator
protected Messages	messages
protected org.springframework.beans.factory.ObjectProvider<org.springframework.boot.servlet.autoconfigure.MultipartProperties>	multipartPropertiesProvider
protected Notifications	notifications
protected TemporaryStorage	temporaryStorage

Fields inherited from class io.jmix.flowui.kit.component.upload.JmixFileStorageUploadField

fileStorageName, fileStoragePutMode

Fields inherited from class io.jmix.flowui.kit.component.upload.AbstractSingleUploadField

CLEAR_COMPONENT_ARIA_LABEL, CLEAR_COMPONENT_CLASS_NAME, clearButtonVisible, clearComponent, content, FILE_NAME_COMPONENT_CLASS_NAME, FILE_NAME_COMPONENT_EMPTY_CLASS_NAME, FILE_NOT_SELECTED, fileNameComponent, fileNameVisible, fileNotSelectedText, FULL_WIDTH_THEME, INPUT_CONTAINER_CLASS_NAME, internalValue, NO_FILE_NAME_THEME, UPLOAD, uploadButton, uploadText

Fields inherited from interface io.jmix.flowui.component.HasRequired

PROPERTY_REQUIRED

Fields inherited from interface io.jmix.flowui.component.SupportsValidation

PROPERTY_ERROR_MESSAGE

Constructor Summary

Constructors

Constructor	Description
FileStorageUploadField()

Method Summary

Modifier and Type	Method	Description
com.vaadin.flow.shared.Registration	addFileUploadSucceededListener(com.vaadin.flow.component.ComponentEventListener<FileUploadSucceededEvent<FileStorageUploadField,TemporaryStorage.FileInfo>> listener)	Adds a succeeded listener that is informed on upload succeeded.
com.vaadin.flow.shared.Registration	addValidator(Validator<? super FileRef> validator)	Adds a validator to the list of validators for the component.
void	afterPropertiesSet()
protected void	applyI18nDefaults()
protected void	attachValueChangeListener(com.vaadin.flow.component.HasValue.ValueChangeListener<com.vaadin.flow.component.AbstractField.ComponentValueChangeEvent<FileStorageUploadField,FileRef>> listener)
protected void	autowireDependencies()
protected void	checkFileExistsInStorage(FileRef value)
protected void	checkFileStorageInitialized()
protected FileFieldDelegate<FileStorageUploadField,FileRef,FileRef>	createFieldDelegate()
protected com.vaadin.flow.server.streams.UploadHandler	createUploadHandler()
protected void	deleteTempFile()
void	executeValidators()	Executes all registered validators against the current value of the component.
protected String	generateFileName()
protected String	getContentType(String fileName)
protected String	getDefaultUploadText()
@Nullable String	getRequiredMessage()	Returns the custom validation message to be displayed if the component is marked as required and the validation fails due to a missing value.
@Nullable ValueSource<FileRef>	getValueSource()	Returns the current ValueSource associated with this component.
protected void	handleJmixUploadInternalError(String fileName)
protected void	initComponent()
boolean	isInvalid()
protected void	onFailed(com.vaadin.flow.server.streams.TransferContext context, IOException reason)
protected void	onFileNameClick(com.vaadin.flow.component.ClickEvent<?> clickEvent)
protected void	onFileRejectedEvent(com.vaadin.flow.component.upload.FileRejectedEvent event)
protected void	onSucceeded(SupportUploadSuccessHandler.UploadSuccessContext<TemporaryStorage.FileInfo> context)
protected void	onValueChange(com.vaadin.flow.component.AbstractField.ComponentValueChangeEvent<FileStorageUploadField,FileRef> event)
protected void	saveFile(SupportUploadSuccessHandler.UploadSuccessContext<TemporaryStorage.FileInfo> context)
void	setApplicationContext(org.springframework.context.ApplicationContext applicationContext)
void	setEnabled(boolean enabled)
void	setInvalid(boolean invalid)	Sets invalid state to the field considering result of field validation.
void	setMaxFileSize(int maxFileSize)	Specify the maximum file size in bytes allowed to upload.
void	setReadOnly(boolean readOnly)
void	setRequired(boolean required)	Sets the required property for the component.
void	setRequiredIndicatorVisible(boolean requiredIndicatorVisible)
void	setRequiredMessage(@Nullable String requiredMessage)	Sets a message that will be displayed or logged when a required field or input is not provided.
void	setStatusChangeHandler(@Nullable Consumer<SupportsStatusChangeHandler.StatusContext<FileStorageUploadField>> handler)	Sets a callback to be used to handle component status changes, e.g.
void	setValueSource(@Nullable ValueSource<FileRef> valueSource)	Sets a ValueSource for this component, allowing it to bind its value to a specified data source.
protected void	showUploadErrorNotification(String fileName)
protected void	validate()
protected boolean	valueEquals(FileRef value1, FileRef value2)

Methods inherited from class io.jmix.flowui.kit.component.upload.JmixFileStorageUploadField

getFileStorageName, getFileStoragePutMode, setFileStorageName, setFileStoragePutMode

Methods inherited from class io.jmix.flowui.kit.component.upload.AbstractSingleUploadField

addClassNames, addFileUploadFailedListener, addFileUploadFileRejectedListener, addFileUploadFinishedListener, addFileUploadProgressListener, addFileUploadStartedListener, addThemeNames, addValueChangeListener, attachContent, attachUploadEvents, createClearComponent, createContentComponent, createDefaultTransferProgressListener, createFileNameComponent, createUploadButtonComponent, createUploadComponent, getAcceptedFileTypes, getClearButtonAriaLabel, getContent, getEmptyValue, getFileNotSelectedText, getI18n, getMaxFileSize, getUploadIcon, getUploadText, getValue, initClearComponent, initContentComponent, initFileNameComponent, initUploadButtonComponent, initUploadComponent, isClearButtonVisible, isDropAllowed, isFileNameVisible, onClearButtonClick, onFinished, onJmixUploadInternalError, onProgressUpdate, onStarted, removeClassNames, removeThemeNames, setAcceptedFileTypes, setClearButtonAriaLabel, setClearButtonVisible, setComponentAriaLabel, setComponentClickListener, setComponentEnabled, setComponentText, setDropAllowed, setFileNameVisible, setFileNotSelectedText, setI18n, setInternalValue, setInternalValue, setPresentationValue, setUploadIcon, setUploadText, setValue, updateComponentsVisibility

Methods inherited from class com.vaadin.flow.component.AbstractField

bindValue, isEmpty, setModelValue

Methods inherited from class com.vaadin.flow.component.Component

addListener, bindVisible, findAncestor, fireEvent, from, get, getChildren, getElement, getEventBus, getId, getListeners, getLocale, getParent, getTestId, getTranslation, getTranslation, getTranslation, getTranslation, getTranslation, getTranslation, getUI, hasListener, isAttached, isTemplateMapped, isVisible, onAttach, onDetach, onEnabledStateChanged, removeFromParent, scrollIntoView, scrollIntoView, set, setElement, setId, setTestId, setVisible

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.vaadin.flow.component.AttachNotifier

addAttachListener

Methods inherited from interface com.vaadin.flow.component.DetachNotifier

addDetachListener

Methods inherited from interface com.vaadin.flow.component.HasElement

getElement

Methods inherited from interface com.vaadin.flow.component.HasEnabled

bindEnabled, isEnabled

Methods inherited from interface com.vaadin.flow.component.HasHelper

bindHelperText, getHelperComponent, getHelperText, setHelperComponent, setHelperText

Methods inherited from interface com.vaadin.flow.component.HasLabel

getLabel, setLabel

Methods inherited from interface io.jmix.flowui.component.HasRequired

isRequired

Methods inherited from interface com.vaadin.flow.component.HasSize

bindHeight, bindWidth, getHeight, getHeightUnit, getMaxHeight, getMaxWidth, getMinHeight, getMinWidth, getWidth, getWidthUnit, setHeight, setHeight, setHeightFull, setMaxHeight, setMaxHeight, setMaxWidth, setMaxWidth, setMinHeight, setMinHeight, setMinWidth, setMinWidth, setSizeFull, setSizeUndefined, setWidth, setWidth, setWidthFull

Methods inherited from interface com.vaadin.flow.component.HasStyle

addClassName, addClassNames, bindClassName, bindClassNames, getClassName, getClassNames, getStyle, hasClassName, removeClassName, removeClassNames, setClassName, setClassName

Methods inherited from interface com.vaadin.flow.component.HasTheme

addThemeName, addThemeNames, bindThemeName, bindThemeNames, getThemeName, getThemeNames, hasThemeName, removeThemeName, removeThemeNames, setThemeName, setThemeName

Methods inherited from interface com.vaadin.flow.component.shared.HasTooltip

getTooltip, setTooltipMarkdown, setTooltipText

Methods inherited from interface com.vaadin.flow.component.HasValidation

setManualValidation

Methods inherited from interface com.vaadin.flow.component.HasValue

clear, getOptionalValue

Methods inherited from interface com.vaadin.flow.component.HasValueAndElement

bindReadOnly, bindRequiredIndicatorVisible, isReadOnly, isRequiredIndicatorVisible

Methods inherited from interface io.jmix.flowui.component.SupportsValidation

getErrorMessage, setErrorMessage

Field Details

applicationContext

protected org.springframework.context.ApplicationContext applicationContext

temporaryStorage

protected TemporaryStorage temporaryStorage

fileStorageLocator

protected FileStorageLocator fileStorageLocator

downloader

protected Downloader downloader

notifications

protected Notifications notifications

messages

protected Messages messages

multipartPropertiesProvider

protected org.springframework.beans.factory.ObjectProvider<org.springframework.boot.servlet.autoconfigure.MultipartProperties> multipartPropertiesProvider

fieldDelegate

protected FileFieldDelegate<FileStorageUploadField,FileRef,FileRef> fieldDelegate

fileStorage

protected FileStorage fileStorage

Constructor Details

FileStorageUploadField

public FileStorageUploadField()

Method Details

setApplicationContext

public void setApplicationContext(org.springframework.context.ApplicationContext applicationContext)
                           throws org.springframework.beans.BeansException

Specified by:

setApplicationContext in interface org.springframework.context.ApplicationContextAware

Throws:

org.springframework.beans.BeansException

afterPropertiesSet

public void afterPropertiesSet()
                        throws Exception

Specified by:

afterPropertiesSet in interface org.springframework.beans.factory.InitializingBean

Throws:

Exception

autowireDependencies

protected void autowireDependencies()

initComponent

protected void initComponent()

createUploadHandler

protected com.vaadin.flow.server.streams.UploadHandler createUploadHandler()

Overrides:

createUploadHandler in class JmixFileStorageUploadField<FileStorageUploadField,FileRef,TemporaryStorage.FileInfo>

onSucceeded

protected void onSucceeded(SupportUploadSuccessHandler.UploadSuccessContext<TemporaryStorage.FileInfo> context)

Overrides:

onSucceeded in class AbstractSingleUploadField<FileStorageUploadField,FileRef,TemporaryStorage.FileInfo>

createFieldDelegate

protected FileFieldDelegate<FileStorageUploadField,FileRef,FileRef> createFieldDelegate()

isInvalid

public boolean isInvalid()

Specified by:

isInvalid in interface com.vaadin.flow.component.HasValidation

Specified by:

isInvalid in interface com.vaadin.flow.component.shared.HasValidationProperties

setRequired

public void setRequired(boolean required)

Description copied from interface: HasRequired

Sets the required property for the component. When a component is marked as required, it indicates that a value must be provided for the component in order to pass validation.

Specified by:

setRequired in interface HasRequired

Parameters:

required - a boolean value indicating whether the component is marked as required. true to mark the component as required, false otherwise.

setRequiredIndicatorVisible

public void setRequiredIndicatorVisible(boolean requiredIndicatorVisible)

Specified by:

setRequiredIndicatorVisible in interface com.vaadin.flow.component.HasValue<com.vaadin.flow.component.AbstractField.ComponentValueChangeEvent<FileStorageUploadField,FileRef>,FileRef>

Specified by:

setRequiredIndicatorVisible in interface com.vaadin.flow.component.HasValueAndElement<com.vaadin.flow.component.AbstractField.ComponentValueChangeEvent<FileStorageUploadField,FileRef>,FileRef>

getRequiredMessage

public @Nullable String getRequiredMessage()

Description copied from interface: HasRequired

Returns the custom validation message to be displayed if the component is marked as required and the validation fails due to a missing value.

Specified by:

getRequiredMessage in interface HasRequired

Returns:

the required message set for the component, or null if no message is defined

setRequiredMessage

public void setRequiredMessage(@Nullable String requiredMessage)

Description copied from interface: HasRequired

Sets a message that will be displayed or logged when a required field or input is not provided.

Specified by:

setRequiredMessage in interface HasRequired

Parameters:

requiredMessage - the message to be set for required fields. If null, the default message or no message will be used.

addValidator

public com.vaadin.flow.shared.Registration addValidator(Validator<? super FileRef> validator)

Description copied from interface: SupportsValidation

Adds a validator to the list of validators for the component. The provided validator will be used to validate the value of the component during validation execution.

Specified by:

addValidator in interface SupportsValidation<FileRef>

Parameters:

validator - the validator to be added; should not be null

Returns:

a Registration object that allows removing the added validator

executeValidators

public void executeValidators()
                       throws ValidationException

Description copied from interface: SupportsValidation

Executes all registered validators against the current value of the component. If any of the validators fail, a ValidationException is thrown to indicate the failure. The exact behavior and order of validation depend on the validators added.

Specified by:

executeValidators in interface SupportsValidation<FileRef>

Throws:

ValidationException - if validation fails for one or more validators

setInvalid

public void setInvalid(boolean invalid)

Description copied from interface: SupportsValidation

Sets invalid state to the field considering result of field validation.

• Invalid - false and validation passed - false = field is invalid
• Invalid - false and validation passed - true = field is valid
• Invalid - true and validation passed - false = field is invalid
• Invalid - true and validation passed - true = field is invalid

Specified by:

setInvalid in interface com.vaadin.flow.component.HasValidation

Specified by:

setInvalid in interface com.vaadin.flow.component.shared.HasValidationProperties

Specified by:

setInvalid in interface SupportsValidation<FileRef>

Parameters:

invalid - whether field should be invalid

validate

protected void validate()

setReadOnly

public void setReadOnly(boolean readOnly)

Specified by:

setReadOnly in interface com.vaadin.flow.component.HasValue<com.vaadin.flow.component.AbstractField.ComponentValueChangeEvent<FileStorageUploadField,FileRef>,FileRef>

Specified by:

setReadOnly in interface com.vaadin.flow.component.HasValueAndElement<com.vaadin.flow.component.AbstractField.ComponentValueChangeEvent<FileStorageUploadField,FileRef>,FileRef>

Overrides:

setReadOnly in class AbstractSingleUploadField<FileStorageUploadField,FileRef,TemporaryStorage.FileInfo>

setEnabled

public void setEnabled(boolean enabled)

Specified by:

setEnabled in interface com.vaadin.flow.component.HasEnabled

Overrides:

setEnabled in class AbstractSingleUploadField<FileStorageUploadField,FileRef,TemporaryStorage.FileInfo>

getValueSource

public @Nullable ValueSource<FileRef> getValueSource()

Description copied from interface: SupportsValueSource

Returns the current ValueSource associated with this component.

Specified by:

getValueSource in interface SupportsValueSource<FileRef>

Returns:

the associated ValueSource, or null if no value source is set

setValueSource

public void setValueSource(@Nullable ValueSource<FileRef> valueSource)

Description copied from interface: SupportsValueSource

Sets a ValueSource for this component, allowing it to bind its value to a specified data source.

Specified by:

setValueSource in interface SupportsValueSource<FileRef>

Parameters:

valueSource - the ValueSource to be associated with this component, or null to remove the current association

setStatusChangeHandler

public void setStatusChangeHandler(@Nullable Consumer<SupportsStatusChangeHandler.StatusContext<FileStorageUploadField>> handler)

Description copied from interface: SupportsStatusChangeHandler

Sets a callback to be used to handle component status changes, e.g. validation messages set by HasValidation.setErrorMessage(String).

Specified by:

setStatusChangeHandler in interface SupportsStatusChangeHandler<FileStorageUploadField>

Parameters:

handler - a handler to set

setMaxFileSize

public void setMaxFileSize(int maxFileSize)

Specify the maximum file size in bytes allowed to upload. Notice that it is a client-side constraint, which will be checked before sending the request.

Note if MultipartProperties is available, the default value will be set from MultipartProperties.getMaxFileSize() that is equal to 1Mb. To increase maximum file size for all fields in the application use MultipartProperties.getMaxFileSize() property.

Overrides:

setMaxFileSize in class AbstractSingleUploadField<FileStorageUploadField,FileRef,TemporaryStorage.FileInfo>

Parameters:

maxFileSize - the maximum file size in bytes

See Also:

• Upload.setMaxFileSize(int)
• MultipartProperties.getMaxFileSize()
• MultipartProperties.getMaxRequestSize()

addFileUploadSucceededListener

public com.vaadin.flow.shared.Registration addFileUploadSucceededListener(com.vaadin.flow.component.ComponentEventListener<FileUploadSucceededEvent<FileStorageUploadField,TemporaryStorage.FileInfo>> listener)

Adds a succeeded listener that is informed on upload succeeded.

For instance, if component has FileStoragePutMode.MANUAL, we can handle the uploading, like the following:

 manuallyControlledField.addFileUploadSucceededListener(event -> {
     UUID fileId = event.getData().getId();
     File file = temporaryStorage.getFile(fileId);
     if (file != null) {
         notifications.create("File is uploaded to temporary storage at " +
                 file.getAbsolutePath()).show();

         FileRef fileRef = temporaryStorage.putFileIntoStorage(fileId, event.getFileName());
         manuallyControlledField.setValue(fileRef);

         notifications.create("Uploaded file: " + event.getFileName()).show();
     }
 });
 

Overrides:

addFileUploadSucceededListener in class AbstractSingleUploadField<FileStorageUploadField,FileRef,TemporaryStorage.FileInfo>

Parameters:

listener - listener to add

Returns:

registration for removal of listener

See Also:

• FileTemporaryStorageUploadHandler

saveFile

protected void saveFile(SupportUploadSuccessHandler.UploadSuccessContext<TemporaryStorage.FileInfo> context)

generateFileName

protected String generateFileName()

Overrides:

generateFileName in class JmixFileStorageUploadField<FileStorageUploadField,FileRef,TemporaryStorage.FileInfo>

getDefaultUploadText

protected String getDefaultUploadText()

Overrides:

getDefaultUploadText in class JmixFileStorageUploadField<FileStorageUploadField,FileRef,TemporaryStorage.FileInfo>

checkFileStorageInitialized

protected void checkFileStorageInitialized()

checkFileExistsInStorage

protected void checkFileExistsInStorage(FileRef value)

onFileNameClick

protected void onFileNameClick(com.vaadin.flow.component.ClickEvent<?> clickEvent)

handleJmixUploadInternalError

protected void handleJmixUploadInternalError(String fileName)

Overrides:

handleJmixUploadInternalError in class AbstractSingleUploadField<FileStorageUploadField,FileRef,TemporaryStorage.FileInfo>

showUploadErrorNotification

protected void showUploadErrorNotification(String fileName)

valueEquals

protected boolean valueEquals(FileRef value1,
 FileRef value2)

Overrides:

valueEquals in class com.vaadin.flow.component.AbstractField<FileStorageUploadField,FileRef>

attachValueChangeListener

protected void attachValueChangeListener(com.vaadin.flow.component.HasValue.ValueChangeListener<com.vaadin.flow.component.AbstractField.ComponentValueChangeEvent<FileStorageUploadField,FileRef>> listener)

onValueChange

protected void onValueChange(com.vaadin.flow.component.AbstractField.ComponentValueChangeEvent<FileStorageUploadField,FileRef> event)

onFileRejectedEvent

protected void onFileRejectedEvent(com.vaadin.flow.component.upload.FileRejectedEvent event)

Overrides:

onFileRejectedEvent in class AbstractSingleUploadField<FileStorageUploadField,FileRef,TemporaryStorage.FileInfo>

onFailed

protected void onFailed(com.vaadin.flow.server.streams.TransferContext context,
 IOException reason)

Overrides:

onFailed in class AbstractSingleUploadField<FileStorageUploadField,FileRef,TemporaryStorage.FileInfo>

deleteTempFile

protected void deleteTempFile()

applyI18nDefaults

protected void applyI18nDefaults()

getContentType

protected String getContentType(String fileName)

Overrides:

getContentType in class JmixFileStorageUploadField<FileStorageUploadField,FileRef,TemporaryStorage.FileInfo>