Package io.jmix.ui.component

Interface FileStorageUploadField

All Superinterfaces:

Buffered, Component, Component.BelongToFrame, Component.Editable, Component.Focusable, Component.HasCaption, Component.HasDescription, Component.HasIcon, Field<FileRef>, HasContextHelp, HasHtmlCaption, HasHtmlDescription, HasHtmlSanitizer, HasValidator<FileRef>, HasValue<FileRef>, HasValueSource<FileRef>, Requirable, SingleFileUploadField, UploadField, Validatable

All Known Implementing Classes:

FileStorageUploadFieldImpl

@StudioComponent(xmlElement="fileStorageUpload",
                 category="Components",
                 icon="io/jmix/ui/icon/component/fileUpload.svg",
                 documentationURL="https://docs.jmix.io/jmix/%VERSION%/ui/vcl/components/file-storage-upload-field.html",
                 canvasBehaviour=BUTTON,
                 canvasText="Upload",
                 canvasTextProperty="uploadButtonCaption")
public interface FileStorageUploadField
extends SingleFileUploadField, Field<FileRef>

Component for uploading files to file storage.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static enum	FileStorageUploadField.FileStoragePutMode	Defines when file will be placed into FileStorage.

Nested classes/interfaces inherited from interface io.jmix.ui.component.Component

Component.Alignment, Component.BelongToFrame, Component.Disposable, Component.Editable, Component.Focusable, Component.HasCaption, Component.HasDescription, Component.HasIcon, Component.HasXmlDescriptor, Component.Wrapper

Nested classes/interfaces inherited from interface io.jmix.ui.component.HasContextHelp

HasContextHelp.ContextHelpIconClickEvent

Nested classes/interfaces inherited from interface io.jmix.ui.component.HasValue

HasValue.ValueChangeEvent<V>

Nested classes/interfaces inherited from interface io.jmix.ui.component.SingleFileUploadField

SingleFileUploadField.AfterValueClearEvent, SingleFileUploadField.BeforeValueClearEvent, SingleFileUploadField.FileUploadSucceedEvent

Nested classes/interfaces inherited from interface io.jmix.ui.component.UploadField

UploadField.DropZone, UploadField.FileUploadErrorEvent, UploadField.FileUploadEvent, UploadField.FileUploadFinishEvent, UploadField.FileUploadStartEvent

Field Summary

Fields

Modifier and Type	Field	Description
static final String	NAME

Fields inherited from interface io.jmix.ui.component.Component

AUTO_SIZE, AUTO_SIZE_PX, FULL_SIZE

Method Summary

Modifier and Type	Method	Description
UUID	getFileId()	Gets id for uploaded file in TemporaryStorage.
String	getFileName()
String	getFileStorageName()
FileStorageUploadField.FileStoragePutMode	getMode()
void	setFileStorageName(String fileStorageName)	Sets the name of FileStorage where the upload file will be placed.
void	setMode(FileStorageUploadField.FileStoragePutMode mode)	Sets mode which determines when file will be put into FileStorage.

Methods inherited from interface io.jmix.ui.component.Buffered

commit, discard, isBuffered, isModified, setBuffered

Methods inherited from interface io.jmix.ui.component.Component

addStyleName, getAlignment, getHeight, getHeightSizeUnit, getId, getParent, getStyleName, getWidth, getWidthSizeUnit, isEnabled, isEnabledRecursive, isResponsive, isVisible, isVisibleRecursive, removeStyleName, setAlignment, setEnabled, setHeight, setHeightAuto, setHeightFull, setId, setParent, setResponsive, setSizeAuto, setSizeFull, setStyleName, setVisible, setWidth, setWidthAuto, setWidthFull, unwrap, unwrapComposition, unwrapCompositionOrNull, unwrapOrNull, withUnwrapped, withUnwrappedComposition

Methods inherited from interface io.jmix.ui.component.Component.BelongToFrame

getFrame, setFrame

Methods inherited from interface io.jmix.ui.component.Component.Editable

isEditable, isEditableWithParent, setEditable

Methods inherited from interface io.jmix.ui.component.Component.Focusable

focus, getTabIndex, isFocusable, setFocusable, setTabIndex

Methods inherited from interface io.jmix.ui.component.Component.HasCaption

getCaption, setCaption

Methods inherited from interface io.jmix.ui.component.Component.HasDescription

getDescription, setDescription

Methods inherited from interface io.jmix.ui.component.Component.HasIcon

getIcon, setIcon, setIconFromSet

Methods inherited from interface io.jmix.ui.component.HasContextHelp

getContextHelpIconClickHandler, getContextHelpText, isContextHelpTextHtmlEnabled, setContextHelpIconClickHandler, setContextHelpText, setContextHelpTextHtmlEnabled

Methods inherited from interface io.jmix.ui.component.HasHtmlCaption

isCaptionAsHtml, setCaptionAsHtml

Methods inherited from interface io.jmix.ui.component.HasHtmlDescription

isDescriptionAsHtml, setDescriptionAsHtml

Methods inherited from interface io.jmix.ui.component.HasHtmlSanitizer

isHtmlSanitizerEnabled, setHtmlSanitizerEnabled

Methods inherited from interface io.jmix.ui.component.HasValidator

addValidator, addValidators, getValidators, removeValidator

Methods inherited from interface io.jmix.ui.component.HasValue

addValueChangeListener, clear, getEmptyValue, getValue, isEmpty, setValue

Methods inherited from interface io.jmix.ui.component.data.HasValueSource

getValueSource, setValueSource

Methods inherited from interface io.jmix.ui.component.Requirable

getRequiredMessage, isRequired, setRequired, setRequiredMessage

Methods inherited from interface io.jmix.ui.component.SingleFileUploadField

addAfterValueClearListener, addBeforeValueClearListener, addFileUploadSucceedListener, getClearButtonCaption, getClearButtonDescription, getClearButtonIcon, getContentProvider, getFileContent, getUploadButtonCaption, getUploadButtonDescription, getUploadButtonIcon, isShowClearButton, isShowFileName, setClearButtonCaption, setClearButtonDescription, setClearButtonIcon, setContentProvider, setShowClearButton, setShowFileName, setUploadButtonCaption, setUploadButtonDescription, setUploadButtonIcon

Methods inherited from interface io.jmix.ui.component.UploadField

addFileUploadErrorListener, addFileUploadFinishListener, addFileUploadStartListener, getAccept, getDropZone, getDropZonePrompt, getFileSizeLimit, getPasteZone, getPermittedExtensions, setAccept, setDropZone, setDropZonePrompt, setFileSizeLimit, setPasteZone, setPermittedExtensions

Methods inherited from interface io.jmix.ui.component.Validatable

isValid, isValidateOnCommit, validate

Field Details

NAME

static final String NAME

See Also:

• Constant Field Values

Method Details

getFileId

@Nullable
UUID getFileId()

Gets id for uploaded file in TemporaryStorage.

Returns:

File Id.

getFileName

@Nullable
String getFileName()

Returns:

caption to be shown in the file download link next to upload button

setMode

@StudioProperty(name="fileStoragePutMode",
                type=ENUMERATION,
                defaultValue="IMMEDIATE",
                required=true)
void setMode(FileStorageUploadField.FileStoragePutMode mode)

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

getMode

FileStorageUploadField.FileStoragePutMode getMode()

Returns:

mode which determines when file will be put into FileStorage.

setFileStorageName

@StudioProperty(name="fileStorage",
                type=STRING)
void setFileStorageName(@Nullable
 String fileStorageName)

Sets the name of FileStorage where the upload file will be placed.

Parameters:

fileStorageName - the name of file storage

getFileStorageName

@Nullable
String getFileStorageName()

Returns:

the name of FileStorage where the upload file will be placed