io.jmix.ui.component.impl

Class AbstractFileStorageUploadField<T>

java.lang.Object

io.jmix.ui.component.impl.AbstractComponent<T>

io.jmix.ui.component.impl.AbstractValueComponent<T,P,V>

io.jmix.ui.component.impl.AbstractField<JmixFileUploadField,java.lang.String,R>

io.jmix.ui.component.impl.AbstractSingleFileUploadField<T>

io.jmix.ui.component.impl.AbstractFileStorageUploadField<T>

All Implemented Interfaces:

AttachNotifier, Buffered, Component, Component.BelongToFrame, Component.Editable, Component.Focusable, Component.HasCaption, Component.HasDescription, Component.HasIcon, Component.HasXmlDescriptor, Component.Wrapper, HasValueSource<T>, Field<T>, HasContextHelp, HasDebugId, HasHtmlCaption, HasHtmlDescription, HasHtmlSanitizer, HasValidator<T>, HasValue<T>, Requirable, SingleFileUploadField, UploadField, Validatable, org.springframework.beans.factory.InitializingBean

Direct Known Subclasses:

FileStorageUploadFieldImpl

public abstract class AbstractFileStorageUploadField<T>
extends AbstractSingleFileUploadField<T>

Nested Class Summary

Nested classes/interfaces inherited from class io.jmix.ui.component.impl.AbstractSingleFileUploadField

AbstractSingleFileUploadField.JmixSingleFileUploadField

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

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

HasValue.ValueChangeEvent<V>

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

HasContextHelp.ContextHelpIconClickEvent

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.UUID	fileId
protected io.jmix.core.FileStorage	fileStorage
protected io.jmix.core.FileStorageLocator	fileStorageLocator
protected java.lang.String	fileStorageName
protected boolean	internalValueChangedOnUpload
protected FileStorageUploadField.FileStoragePutMode	mode
protected java.util.UUID	tempFileId
protected TemporaryStorage	temporaryStorage

Fields inherited from class io.jmix.ui.component.impl.AbstractSingleFileUploadField

accept, BYTES_IN_MEGABYTE, componentProperties, contentProvider, downloader, dropZone, dropZonePrompt, fileName, fileSizeLimit, messages, pasteZone, permittedExtensions

Fields inherited from class io.jmix.ui.component.impl.AbstractField

editable, parentEditableChangeListener, validators, VALIDATORS_LIST_INITIAL_CAPACITY

Fields inherited from class io.jmix.ui.component.impl.AbstractValueComponent

internalValue, uiTestIdsSupport, valueBinding

Fields inherited from class io.jmix.ui.component.impl.AbstractComponent

alignment, applicationContext, component, contextHelpIconClickHandler, contextHelpIconClickListener, descriptionAsHtml, element, frame, htmlSanitizerEnabled, icon, ICON_STYLE, id, parent

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

AUTO_SIZE, AUTO_SIZE_PX, FULL_SIZE

Constructor Summary

Constructors

Constructor and Description
AbstractFileStorageUploadField()

Method Summary

Modifier and Type	Method and Description
protected void	checkFileStorageInitialized()
java.io.InputStream	getFileContent(io.jmix.core.FileRef fileRef)
java.util.UUID	getFileId()
java.lang.String	getFileName()
protected void	internalValueChanged(java.lang.Object newValue)
protected void	onUploadFailed(JmixFileUpload.FailedEvent event)
protected java.io.OutputStream	receiveUpload(java.lang.String fileName, java.lang.String MIMEType)
void	setFileStorageLocator(io.jmix.core.FileStorageLocator fileStorageLocator)
void	setTemporaryStorage(TemporaryStorage temporaryStorage)
protected void	valueBindingConnected(ValueSource<T> valueSource)

Methods inherited from class io.jmix.ui.component.impl.AbstractSingleFileUploadField

addAfterValueClearListener, addBeforeValueClearListener, addFileUploadErrorListener, addFileUploadFinishListener, addFileUploadStartListener, addFileUploadSucceedListener, afterPropertiesSet, clearButtonClicked, commit, createComponent, discard, fireFileUploadError, fireFileUploadFinish, fireFileUploadStart, fireFileUploadSucceed, focus, getAccept, getActualFileSizeLimit, getClearButtonCaption, getClearButtonDescription, getClearButtonIcon, getContentProvider, getDropZone, getDropZonePrompt, getFileSizeLimit, getFileSizeLimitString, getPasteZone, getPermittedExtensions, getTabIndex, getUploadButtonCaption, getUploadButtonDescription, getUploadButtonIcon, initComponent, isBuffered, isModified, isShowClearButton, isShowFileName, onFileExtensionNotAllowed, onFileNameClick, onFileSizeLimitExceeded, onUploadFinished, onUploadStarted, onUploadSucceeded, setAccept, setBuffered, setClearButtonCaption, setClearButtonDescription, setClearButtonIcon, setComponentProperties, setContentProvider, setDownloader, setDropZone, setDropZonePrompt, setFileSizeLimit, setMessages, setPasteZone, setPermittedExtensions, setShowClearButton, setShowFileName, setTabIndex, setUploadButtonCaption, setUploadButtonDescription, setUploadButtonIcon

Methods inherited from class io.jmix.ui.component.impl.AbstractField

addValidator, attachValueChangeListener, getDatatypeConversionErrorMsg, getErrorMessage, getRequiredMessage, getValidators, isEditable, isRequired, isValid, removeValidator, setEditable, setEditableToComponent, setParent, setRequired, setRequiredMessage, setupComponentErrorProvider, triggerValidators, validate

Methods inherited from class io.jmix.ui.component.impl.AbstractValueComponent

addValueChangeListener, componentValueChanged, convertToModel, convertToPresentation, fieldValueEquals, getValue, getValueSource, setUiTestId, setUiTestIdsSupport, setValue, setValueSource, setValueToPresentation, valueBindingActivated

Methods inherited from class io.jmix.ui.component.impl.AbstractComponent

addAttachListener, addDetachListener, addStyleName, assignDebugId, attached, detached, getAlignment, getCaption, getComponent, getComposition, getContextHelpIconClickHandler, getContextHelpText, getDebugId, getDescription, getEventHub, getFrame, getHeight, getHeightSizeUnit, getHtmlSanitizer, getIcon, getIconName, getIconResource, getId, getParent, getStyleName, getUiComponentProperties, getUiProperties, getWidth, getWidthSizeUnit, getXmlDescriptor, hasSubscriptions, hasValidationError, isAttached, isCaptionAsHtml, isContextHelpTextHtmlEnabled, isDescriptionAsHtml, isEnabled, isEnabledRecursive, isHtmlSanitizerEnabled, isResponsive, isVisible, isVisibleRecursive, onContextHelpIconClick, publish, removeStyleName, sanitize, setAlignment, setApplicationContext, setCaption, setCaptionAsHtml, setContextHelpIconClickHandler, setContextHelpText, setContextHelpTextHtmlEnabled, setDebugId, setDescription, setDescriptionAsHtml, setEnabled, setFrame, setHeight, setHtmlSanitizerEnabled, setIcon, setIconFromSet, setId, setResponsive, setStyleName, setValidationError, setVisible, setWidth, setXmlDescriptor, unsubscribe, unwrap, unwrapComposition, unwrapCompositionOrNull, unwrapOrNull, withUnwrapped, withUnwrappedComposition

Methods inherited from class java.lang.Object

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

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

getFileContent

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

getFrame, setFrame

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

getIcon, setIcon, setIconFromSet

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

isFocusable, setFocusable

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

isCaptionAsHtml, setCaptionAsHtml

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

isDescriptionAsHtml, setDescriptionAsHtml

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

isHtmlSanitizerEnabled, setHtmlSanitizerEnabled

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

getValueSource, setValueSource

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

addValueChangeListener, clear, getEmptyValue, getValue, isEmpty, setValue

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

isEditableWithParent

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

isValidateOnCommit

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

getContextHelpIconClickHandler, getContextHelpText, isContextHelpTextHtmlEnabled, setContextHelpIconClickHandler, setContextHelpText, setContextHelpTextHtmlEnabled

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

addValidators

Field Detail

temporaryStorage

protected TemporaryStorage temporaryStorage

fileStorageLocator

protected io.jmix.core.FileStorageLocator fileStorageLocator

fileStorage

protected io.jmix.core.FileStorage fileStorage

fileStorageName

protected java.lang.String fileStorageName

mode

protected FileStorageUploadField.FileStoragePutMode mode

fileId

protected java.util.UUID fileId

tempFileId

protected java.util.UUID tempFileId

internalValueChangedOnUpload

protected boolean internalValueChangedOnUpload

Constructor Detail

AbstractFileStorageUploadField

public AbstractFileStorageUploadField()

Method Detail

valueBindingConnected

protected void valueBindingConnected(ValueSource<T> valueSource)

Overrides:

valueBindingConnected in class AbstractValueComponent<JmixFileUploadField,java.lang.String,T>

setTemporaryStorage

@Autowired
public void setTemporaryStorage(TemporaryStorage temporaryStorage)

setFileStorageLocator

@Autowired
public void setFileStorageLocator(io.jmix.core.FileStorageLocator fileStorageLocator)

receiveUpload

protected java.io.OutputStream receiveUpload(java.lang.String fileName,
                                             java.lang.String MIMEType)

Specified by:

receiveUpload in class AbstractSingleFileUploadField<T>

internalValueChanged

protected void internalValueChanged(@Nullable
                                    java.lang.Object newValue)

Overrides:

internalValueChanged in class AbstractSingleFileUploadField<T>

onUploadFailed

protected void onUploadFailed(JmixFileUpload.FailedEvent event)

Overrides:

onUploadFailed in class AbstractSingleFileUploadField<T>

checkFileStorageInitialized

protected void checkFileStorageInitialized()

getFileContent

@Nullable
public java.io.InputStream getFileContent(@Nullable
                                                    io.jmix.core.FileRef fileRef)

getFileName

@Nullable
public java.lang.String getFileName()

Overrides:

getFileName in class AbstractSingleFileUploadField<T>

getFileId

@Nullable
public java.util.UUID getFileId()

Returns:

File id for uploaded file in TemporaryStorage