Package io.jmix.flowui.kit.component.upload

Class JmixFileStorageUploadField<C extends AbstractSingleUploadField<C,V,EV>,V,EV>

java.lang.Object

com.vaadin.flow.component.Component

com.vaadin.flow.component.AbstractField<C,V>

io.jmix.flowui.kit.component.upload.AbstractSingleUploadField<C,V,EV>

io.jmix.flowui.kit.component.upload.JmixFileStorageUploadField<C,V,EV>

Type Parameters:

C - the type of the upload field

V - the value type of the upload field

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.HasValue<com.vaadin.flow.component.AbstractField.ComponentValueChangeEvent<C,V>,V>, com.vaadin.flow.component.HasValueAndElement<com.vaadin.flow.component.AbstractField.ComponentValueChangeEvent<C,V>,V>, com.vaadin.flow.component.shared.HasTooltip, Serializable

Direct Known Subclasses:

FileStorageUploadField, WebdavDocumentUploadField

public class JmixFileStorageUploadField<C extends AbstractSingleUploadField<C,V,EV>,V,EV>
extends AbstractSingleUploadField<C,V,EV>

JmixFileStorageUploadField is a component for file upload functionality that integrates with a file storage system. This field provides options for handling file upload operations and storing files into the file storage.

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<?>>

Field Summary

Fields

Modifier and Type	Field	Description
protected String	fileStorageName
protected FileStoragePutMode	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

Constructor Summary

Constructors

Constructor	Description
JmixFileStorageUploadField()
JmixFileStorageUploadField(V defaultValue)

Method Summary

Modifier and Type	Method	Description
protected com.vaadin.flow.server.streams.UploadHandler	createUploadHandler()
protected String	generateFileName()
protected String	getContentType(String fileName)
protected String	getDefaultUploadText()
String	getFileStorageName()
FileStoragePutMode	getFileStoragePutMode()
void	setFileStorageName(String fileStorageName)	Sets the name of FileStorage where the upload file will be placed.
void	setFileStoragePutMode(FileStoragePutMode putMode)	Sets mode which determines when file will be put into FileStorage.

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

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

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

bindValue, isEmpty, setModelValue, valueEquals

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 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.HasValue

clear, getOptionalValue

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

bindReadOnly, bindRequiredIndicatorVisible, isReadOnly, isRequiredIndicatorVisible, setRequiredIndicatorVisible

Field Details

fileStoragePutMode

protected FileStoragePutMode fileStoragePutMode

fileStorageName

protected String fileStorageName

Constructor Details

JmixFileStorageUploadField

public JmixFileStorageUploadField()

JmixFileStorageUploadField

public JmixFileStorageUploadField(V defaultValue)

Method Details

getFileStoragePutMode

public FileStoragePutMode getFileStoragePutMode()

Returns:

mode which determines when file will be put into FileStorage

setFileStoragePutMode

public void setFileStoragePutMode(FileStoragePutMode putMode)

Sets mode which determines when file will be put into FileStorage.

getFileStorageName

public String getFileStorageName()

Returns:

the name of FileStorage where the upload file will be placed

setFileStorageName

public void setFileStorageName(String fileStorageName)

Sets the name of FileStorage where the upload file will be placed. If not set, the default FileStorage will be used.

Parameters:

fileStorageName - the name of file storage

generateFileName

protected String generateFileName()

Specified by:

generateFileName in class AbstractSingleUploadField<C extends AbstractSingleUploadField<C,V,EV>,V,EV>

getDefaultUploadText

protected String getDefaultUploadText()

Specified by:

getDefaultUploadText in class AbstractSingleUploadField<C extends AbstractSingleUploadField<C,V,EV>,V,EV>

createUploadHandler

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

Specified by:

createUploadHandler in class AbstractSingleUploadField<C extends AbstractSingleUploadField<C,V,EV>,V,EV>

getContentType

protected String getContentType(String fileName)

Specified by:

getContentType in class AbstractSingleUploadField<C extends AbstractSingleUploadField<C,V,EV>,V,EV>