@StudioComponent(xmlElement="fileStorageUpload", category="Components", icon="io/jmix/ui/icon/component/fileUpload.svg", canvasBehaviour=BUTTON, canvasText="Upload", canvasTextProperty="uploadButtonCaption") public interface FileStorageUploadField extends SingleFileUploadField, Field<io.jmix.core.FileRef>
Modifier and Type | Interface and Description |
---|---|
static class |
FileStorageUploadField.FileStoragePutMode
Defines when file will be placed into FileStorage.
|
SingleFileUploadField.AfterValueClearEvent, SingleFileUploadField.BeforeValueClearEvent, SingleFileUploadField.FileUploadSucceedEvent
UploadField.DropZone, UploadField.FileUploadErrorEvent, UploadField.FileUploadEvent, UploadField.FileUploadFinishEvent, UploadField.FileUploadStartEvent
Component.Alignment, Component.BelongToFrame, Component.Disposable, Component.Editable, Component.Focusable, Component.HasCaption, Component.HasDescription, Component.HasIcon, Component.HasXmlDescriptor, Component.Wrapper
HasValue.ValueChangeEvent<V>
HasContextHelp.ContextHelpIconClickEvent
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
NAME |
AUTO_SIZE, AUTO_SIZE_PX, FULL_SIZE
Modifier and Type | Method and Description |
---|---|
java.util.UUID |
getFileId()
Gets id for uploaded file in
TemporaryStorage . |
java.lang.String |
getFileName() |
java.lang.String |
getFileStorageName() |
FileStorageUploadField.FileStoragePutMode |
getMode() |
void |
setFileStorageName(java.lang.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.
|
addAfterValueClearListener, addBeforeValueClearListener, addFileUploadSucceedListener, getClearButtonCaption, getClearButtonDescription, getClearButtonIcon, getContentProvider, getFileContent, getUploadButtonCaption, getUploadButtonDescription, getUploadButtonIcon, isShowClearButton, isShowFileName, setClearButtonCaption, setClearButtonDescription, setClearButtonIcon, setContentProvider, setShowClearButton, setShowFileName, setUploadButtonCaption, setUploadButtonDescription, setUploadButtonIcon
addFileUploadErrorListener, addFileUploadFinishListener, addFileUploadStartListener, getAccept, getDropZone, getDropZonePrompt, getFileSizeLimit, getPasteZone, getPermittedExtensions, setAccept, setDropZone, setDropZonePrompt, setFileSizeLimit, setPasteZone, setPermittedExtensions
getFrame, setFrame
getIcon, setIcon, setIconFromSet
focus, getTabIndex, isFocusable, setFocusable, setTabIndex
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
isCaptionAsHtml, setCaptionAsHtml
getCaption, setCaption
getDescription, setDescription
isDescriptionAsHtml, setDescriptionAsHtml
isHtmlSanitizerEnabled, setHtmlSanitizerEnabled
commit, discard, isBuffered, isModified, setBuffered
getValueSource, setValueSource
addValueChangeListener, clear, getEmptyValue, getValue, isEmpty, setValue
isEditable, isEditableWithParent, setEditable
isValid, isValidateOnCommit, validate
getContextHelpIconClickHandler, getContextHelpText, isContextHelpTextHtmlEnabled, setContextHelpIconClickHandler, setContextHelpText, setContextHelpTextHtmlEnabled
addValidator, addValidators, getValidators, removeValidator
getRequiredMessage, isRequired, setRequired, setRequiredMessage
static final java.lang.String NAME
@Nullable java.util.UUID getFileId()
TemporaryStorage
.@Nullable java.lang.String getFileName()
@StudioProperty(name="fileStoragePutMode", type=ENUMERATION, defaultValue="IMMEDIATE", required=true) void setMode(FileStorageUploadField.FileStoragePutMode mode)
FileStorageUploadField.FileStoragePutMode getMode()
@StudioProperty(name="fileStorage", type=STRING) void setFileStorageName(@Nullable java.lang.String fileStorageName)
fileStorageName
- the name of file storage@Nullable java.lang.String getFileStorageName()