Package io.jmix.webdavflowui.component

Class WebdavDocumentUploadField

java.lang.Object

com.vaadin.flow.component.Component

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

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

io.jmix.flowui.kit.component.upload.JmixFileStorageUploadField<WebdavDocumentUploadField,WebdavDocument>

io.jmix.webdavflowui.component.WebdavDocumentUploadField

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<WebdavDocumentUploadField,WebdavDocument>,WebdavDocument>, com.vaadin.flow.component.HasValueAndElement<com.vaadin.flow.component.AbstractField.ComponentValueChangeEvent<WebdavDocumentUploadField,WebdavDocument>,WebdavDocument>, com.vaadin.flow.component.shared.HasTooltip, com.vaadin.flow.component.shared.HasValidationProperties, HasRequired, SupportsStatusChangeHandler<WebdavDocumentUploadField>, SupportsValidation<WebdavDocument>, SupportsValueSource<WebdavDocument>, Serializable, org.springframework.beans.factory.Aware, org.springframework.beans.factory.InitializingBean, org.springframework.context.ApplicationContextAware

public class WebdavDocumentUploadField
extends JmixFileStorageUploadField<WebdavDocumentUploadField,WebdavDocument>
implements SupportsValueSource<WebdavDocument>, SupportsValidation<WebdavDocument>, HasRequired, SupportsStatusChangeHandler<WebdavDocumentUploadField>, org.springframework.beans.factory.InitializingBean, org.springframework.context.ApplicationContextAware

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 extends Object>

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

com.vaadin.flow.component.HasValue.ValueChangeEvent<V extends Object>, 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 com.vaadin.flow.component.button.Button	clearButton
protected Dialogs	dialogs
protected WebdavDocumentsManagementService	documentsManagementService
protected com.vaadin.flow.component.button.Button	downloadButton
protected Downloader	downloader
protected FieldDelegate<WebdavDocumentUploadField,WebdavDocument,WebdavDocument>	fieldDelegate
protected FileStorage	fileStorage
protected FileStorageLocator	fileStorageLocator
protected Messages	messages
protected org.springframework.beans.factory.ObjectProvider<org.springframework.boot.autoconfigure.web.servlet.MultipartProperties>	multipartPropertiesProvider
static final String	NAME
protected Notifications	notifications
protected com.vaadin.flow.component.html.Span	placeHolder
protected boolean	showFileName
protected TemporaryStorage	temporaryStorage
protected UiComponents	uiComponents
protected WebdavDocumentLink	webdavDocumentLink
protected WebdavProperties	webdavProperties
protected WebdavTools	webdavTools

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
WebdavDocumentUploadField()

Method Summary

Modifier and Type	Method	Description
protected Consumer<ActionPerformedEvent>	actionUnderDocumentLock(Consumer<ActionPerformedEvent> handler)
com.vaadin.flow.shared.Registration	addValidator(Validator<? super WebdavDocument> validator)
void	afterPropertiesSet()
protected void	applyI18nDefaults()
protected void	autowireDependencies()
protected void	checkFileStorageInitialized()
protected FieldDelegate<WebdavDocumentUploadField,WebdavDocument,WebdavDocument>	createFieldDelegate()
protected void	deleteTempFile()
void	executeValidators()
protected String	getDefaultUploadText()
protected String	getDownloadButtonText()
String	getRequiredMessage()
ValueSource<WebdavDocument>	getValueSource()
protected void	handleJmixUploadInternalError(String fileName)
protected void	initComponent()
boolean	isFileNameVisible()
boolean	isInvalid()
protected boolean	isVersioningEnabled()
protected void	onAttach(com.vaadin.flow.component.AttachEvent attachEvent)
protected void	onDownloadButtonClick(com.vaadin.flow.component.ClickEvent<?> event)
protected void	onFailedEvent(com.vaadin.flow.component.upload.FailedEvent event)
protected void	onFileRejectedEvent(com.vaadin.flow.component.upload.FileRejectedEvent event)
protected void	onSucceededEvent(com.vaadin.flow.component.upload.SucceededEvent event)
protected void	onValueChange(com.vaadin.flow.component.AbstractField.ComponentValueChangeEvent<WebdavDocumentUploadField,WebdavDocument> event)
protected void	saveFile(com.vaadin.flow.component.upload.SucceededEvent event)
void	setApplicationContext(org.springframework.context.ApplicationContext applicationContext)
void	setClearButtonIcon(String icon)
void	setDownloadButtonIcon(String icon)
void	setDownloadButtonText(String text)
void	setDownloadButtonVisible(boolean downloadButtonVisible)
void	setFileNameVisible(boolean visible)	Enables or disables displaying name of uploaded file.
void	setFileNotSelectedText(String fileNotSelectedText)	Sets text that is shown when file is not uploaded.
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)
void	setRequiredIndicatorVisible(boolean requiredIndicatorVisible)
void	setRequiredMessage(String requiredMessage)
void	setStatusChangeHandler(Consumer<SupportsStatusChangeHandler.StatusContext<WebdavDocumentUploadField>> handler)	Sets a callback to be used to handle component status changes, e.g.
void	setValue(WebdavDocument value)
void	setValueSource(ValueSource<WebdavDocument> valueSource)
protected void	showUploadErrorNotification(String fileName)
protected WebdavDocument	updateLink(WebdavDocument webdavDocument)
protected void	validate()

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

generateFileName, getFileStorageName, getFileStoragePutMode, setFileStorageName, setFileStoragePutMode

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

addClassNames, addFileUploadFailedListener, addFileUploadFileRejectedListener, addFileUploadFinishedListener, addFileUploadProgressListener, addFileUploadStartedListener, addFileUploadSucceededListener, addThemeNames, addValueChangeListener, attachContent, attachUploadEvents, createClearComponent, createContentComponent, createFileNameComponent, createUploadButtonComponent, createUploadComponent, createUploadReceiver, getAcceptedFileTypes, getClearButtonAriaLabel, getContent, getEmptyValue, getFileNotSelectedText, getI18n, getMaxFileSize, getUploadIcon, getUploadText, getValue, initClearComponent, initContentComponent, initFileNameComponent, initUploadButtonComponent, initUploadComponent, isClearButtonVisible, isDropAllowed, onClearButtonClick, onFinishedEvent, onJmixUploadInternalError, onProgressEvent, onStartedEvent, removeClassNames, removeThemeNames, setAcceptedFileTypes, setClearButtonAriaLabel, setClearButtonVisible, setComponentAriaLabel, setComponentClickListener, setComponentEnabled, setComponentText, setDropAllowed, setEnabled, setI18n, setInternalValue, setInternalValue, setPresentationValue, setUploadIcon, setUploadText, updateComponentsVisibility

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

isEmpty, setModelValue, valueEquals

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

addListener, findAncestor, fireEvent, from, get, getChildren, getElement, getEventBus, getId, getListeners, getLocale, getParent, getTranslation, getTranslation, getTranslation, getTranslation, getTranslation, getTranslation, getUI, hasListener, isAttached, isTemplateMapped, isVisible, onDetach, onEnabledStateChanged, removeFromParent, scrollIntoView, scrollIntoView, set, setElement, setId, 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

isEnabled

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

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

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, getClassName, getClassNames, getStyle, hasClassName, removeClassName, removeClassNames, setClassName, setClassName

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

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

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

getTooltip, setTooltipText

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

clear, getOptionalValue

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

isReadOnly, isRequiredIndicatorVisible

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

getErrorMessage, setErrorMessage

Field Details

NAME

public static final String NAME

See Also:

• Constant Field Values

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.autoconfigure.web.servlet.MultipartProperties> multipartPropertiesProvider

fileStorage

protected FileStorage fileStorage

documentsManagementService

protected WebdavDocumentsManagementService documentsManagementService

webdavProperties

protected WebdavProperties webdavProperties

uiComponents

protected UiComponents uiComponents

dialogs

protected Dialogs dialogs

webdavTools

protected WebdavTools webdavTools

fieldDelegate

protected FieldDelegate<WebdavDocumentUploadField,WebdavDocument,WebdavDocument> fieldDelegate

webdavDocumentLink

protected WebdavDocumentLink webdavDocumentLink

placeHolder

protected com.vaadin.flow.component.html.Span placeHolder

downloadButton

protected com.vaadin.flow.component.button.Button downloadButton

clearButton

protected com.vaadin.flow.component.button.Button clearButton

showFileName

protected boolean showFileName

Constructor Details

WebdavDocumentUploadField

public WebdavDocumentUploadField()

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()

Specified by:

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

autowireDependencies

protected void autowireDependencies()

createFieldDelegate

protected FieldDelegate<WebdavDocumentUploadField,WebdavDocument,WebdavDocument> 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)

Specified by:

setRequired in interface HasRequired

setRequiredIndicatorVisible

public void setRequiredIndicatorVisible(boolean requiredIndicatorVisible)

Specified by:

setRequiredIndicatorVisible in interface com.vaadin.flow.component.HasValue<com.vaadin.flow.component.AbstractField.ComponentValueChangeEvent<WebdavDocumentUploadField,WebdavDocument>,WebdavDocument>

Specified by:

setRequiredIndicatorVisible in interface com.vaadin.flow.component.HasValueAndElement<com.vaadin.flow.component.AbstractField.ComponentValueChangeEvent<WebdavDocumentUploadField,WebdavDocument>,WebdavDocument>

getRequiredMessage

@Nullable
public String getRequiredMessage()

Specified by:

getRequiredMessage in interface HasRequired

setRequiredMessage

public void setRequiredMessage(@Nullable
 String requiredMessage)

Specified by:

setRequiredMessage in interface HasRequired

addValidator

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

Specified by:

addValidator in interface SupportsValidation<WebdavDocument>

executeValidators

public void executeValidators()
                       throws ValidationException

Specified by:

executeValidators in interface SupportsValidation<WebdavDocument>

Throws:

ValidationException

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

Parameters:

invalid - whether field should be invalid

validate

protected void validate()

getValueSource

@Nullable
public ValueSource<WebdavDocument> getValueSource()

Specified by:

getValueSource in interface SupportsValueSource<WebdavDocument>

setValueSource

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

Specified by:

setValueSource in interface SupportsValueSource<WebdavDocument>

setStatusChangeHandler

public void setStatusChangeHandler(@Nullable
 Consumer<SupportsStatusChangeHandler.StatusContext<WebdavDocumentUploadField>> 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<WebdavDocumentUploadField>

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<WebdavDocumentUploadField,WebdavDocument>

Parameters:

maxFileSize - the maximum file size in bytes

See Also:

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

getDefaultUploadText

protected String getDefaultUploadText()

Overrides:

getDefaultUploadText in class JmixFileStorageUploadField<WebdavDocumentUploadField,WebdavDocument>

checkFileStorageInitialized

protected void checkFileStorageInitialized()

handleJmixUploadInternalError

protected void handleJmixUploadInternalError(String fileName)

Overrides:

handleJmixUploadInternalError in class AbstractSingleUploadField<WebdavDocumentUploadField,WebdavDocument>

showUploadErrorNotification

protected void showUploadErrorNotification(String fileName)

onValueChange

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

onFileRejectedEvent

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

Overrides:

onFileRejectedEvent in class AbstractSingleUploadField<WebdavDocumentUploadField,WebdavDocument>

onFailedEvent

protected void onFailedEvent(com.vaadin.flow.component.upload.FailedEvent event)

Overrides:

onFailedEvent in class AbstractSingleUploadField<WebdavDocumentUploadField,WebdavDocument>

deleteTempFile

protected void deleteTempFile()

applyI18nDefaults

protected void applyI18nDefaults()

onAttach

protected void onAttach(com.vaadin.flow.component.AttachEvent attachEvent)

Overrides:

onAttach in class com.vaadin.flow.component.Component

initComponent

protected void initComponent()

onDownloadButtonClick

protected void onDownloadButtonClick(com.vaadin.flow.component.ClickEvent<?> event)

updateLink

protected WebdavDocument updateLink(@Nullable
 WebdavDocument webdavDocument)

onSucceededEvent

protected void onSucceededEvent(com.vaadin.flow.component.upload.SucceededEvent event)

Overrides:

onSucceededEvent in class AbstractSingleUploadField<WebdavDocumentUploadField,WebdavDocument>

saveFile

protected void saveFile(com.vaadin.flow.component.upload.SucceededEvent event)

isVersioningEnabled

protected boolean isVersioningEnabled()

actionUnderDocumentLock

protected Consumer<ActionPerformedEvent> actionUnderDocumentLock(Consumer<ActionPerformedEvent> handler)

setReadOnly

public void setReadOnly(boolean readOnly)

Specified by:

setReadOnly in interface com.vaadin.flow.component.HasValue<com.vaadin.flow.component.AbstractField.ComponentValueChangeEvent<WebdavDocumentUploadField,WebdavDocument>,WebdavDocument>

Specified by:

setReadOnly in interface com.vaadin.flow.component.HasValueAndElement<com.vaadin.flow.component.AbstractField.ComponentValueChangeEvent<WebdavDocumentUploadField,WebdavDocument>,WebdavDocument>

Overrides:

setReadOnly in class AbstractSingleUploadField<WebdavDocumentUploadField,WebdavDocument>

setDownloadButtonIcon

public void setDownloadButtonIcon(@Nullable
 String icon)

setClearButtonIcon

public void setClearButtonIcon(@Nullable
 String icon)

setDownloadButtonText

public void setDownloadButtonText(String text)

getDownloadButtonText

protected String getDownloadButtonText()

setDownloadButtonVisible

public void setDownloadButtonVisible(boolean downloadButtonVisible)

setValue

public void setValue(@Nullable
 WebdavDocument value)

Specified by:

setValue in interface com.vaadin.flow.component.HasValue<com.vaadin.flow.component.AbstractField.ComponentValueChangeEvent<WebdavDocumentUploadField,WebdavDocument>,WebdavDocument>

Overrides:

setValue in class AbstractSingleUploadField<WebdavDocumentUploadField,WebdavDocument>

isFileNameVisible

public boolean isFileNameVisible()

Overrides:

isFileNameVisible in class AbstractSingleUploadField<WebdavDocumentUploadField,WebdavDocument>

Returns:

true if name of uploaded file is shown

setFileNameVisible

public void setFileNameVisible(boolean visible)

Description copied from class: AbstractSingleUploadField

Enables or disables displaying name of uploaded file.

The default value is false.

Overrides:

setFileNameVisible in class AbstractSingleUploadField<WebdavDocumentUploadField,WebdavDocument>

Parameters:

visible - whether file name should be shown

setFileNotSelectedText

public void setFileNotSelectedText(@Nullable
 String fileNotSelectedText)

Description copied from class: AbstractSingleUploadField

Sets text that is shown when file is not uploaded.

Overrides:

setFileNotSelectedText in class AbstractSingleUploadField<WebdavDocumentUploadField,WebdavDocument>

Parameters:

fileNotSelectedText - text to set