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

Class JmixFileUploadField<C extends AbstractSingleUploadField<C,byte[],byte[]>>

java.lang.Object

com.vaadin.flow.component.Component

com.vaadin.flow.component.AbstractField<C,byte[]>

io.jmix.flowui.kit.component.upload.AbstractSingleUploadField<C,byte[],byte[]>

io.jmix.flowui.kit.component.upload.JmixFileUploadField<C>

Type Parameters:

C - the type of the inheriting component that extends AbstractSingleUploadField

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

Direct Known Subclasses:

FileUploadField

public class JmixFileUploadField<C extends AbstractSingleUploadField<C,byte[],byte[]>>
extends AbstractSingleUploadField<C,byte[],byte[]>

A component for uploading files with support for displaying the uploaded file name and handling file upload events.

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	fileName
protected String	uploadedFileName

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
JmixFileUploadField()
JmixFileUploadField(byte[] defaultValue)

Method Summary

Modifier and Type	Method	Description
protected String	convertValueToFileName(byte[] value)
protected com.vaadin.flow.server.streams.UploadHandler	createUploadHandler()
protected String	generateFileName()
protected String	getContentType(String fileName)
protected String	getDefaultUploadText()
@Nullable String	getFileName()
@Nullable String	getUploadedFileName()
protected void	onSucceeded(SupportUploadSuccessHandler.UploadSuccessContext<byte[]> context)
protected void	saveFile(SupportUploadSuccessHandler.UploadSuccessContext<byte[]> context)
void	setFileName(@Nullable String fileName)	Sets file name to be shown in the component next to upload button.
protected void	setInternalValue(@org.jspecify.annotations.Nullable byte[] value, boolean fromClient)
protected boolean	valueEquals(@org.jspecify.annotations.Nullable byte[] a, @org.jspecify.annotations.Nullable byte[] b)

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, removeClassNames, removeThemeNames, setAcceptedFileTypes, setClearButtonAriaLabel, setClearButtonVisible, setComponentAriaLabel, setComponentClickListener, setComponentEnabled, setComponentText, setDropAllowed, setEnabled, setFileNameVisible, setFileNotSelectedText, setI18n, setInternalValue, setMaxFileSize, setPresentationValue, setReadOnly, setUploadIcon, setUploadText, setValue, updateComponentsVisibility

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

bindValue, isEmpty, setModelValue

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

fileName

protected String fileName

uploadedFileName

protected String uploadedFileName

Constructor Details

JmixFileUploadField

public JmixFileUploadField()

JmixFileUploadField

public JmixFileUploadField(byte[] defaultValue)

Method Details

getFileName

public @Nullable String getFileName()

Returns:

file name to be shown in the component next to upload button

setFileName

public void setFileName(@Nullable String fileName)

Sets file name to be shown in the component next to upload button. The file name of the newly uploaded file will rewrite the caption.

The default value is "attachment (file_size Kb)". See also message key "fileUploadField.noFileName".

Parameters:

fileName - file name to show

getUploadedFileName

public @Nullable String getUploadedFileName()

Returns:

name of the uploaded file or null if no file was uploaded using "Upload" button

generateFileName

protected String generateFileName()

Specified by:

generateFileName in class AbstractSingleUploadField<C extends AbstractSingleUploadField<C,byte[],byte[]>,byte[],byte[]>

convertValueToFileName

protected String convertValueToFileName(byte[] value)

getDefaultUploadText

protected String getDefaultUploadText()

Specified by:

getDefaultUploadText in class AbstractSingleUploadField<C extends AbstractSingleUploadField<C,byte[],byte[]>,byte[],byte[]>

onSucceeded

protected void onSucceeded(SupportUploadSuccessHandler.UploadSuccessContext<byte[]> context)

Overrides:

onSucceeded in class AbstractSingleUploadField<C extends AbstractSingleUploadField<C,byte[],byte[]>,byte[],byte[]>

saveFile

protected void saveFile(SupportUploadSuccessHandler.UploadSuccessContext<byte[]> context)

setInternalValue

protected void setInternalValue(@org.jspecify.annotations.Nullable byte[] value,
 boolean fromClient)

Overrides:

setInternalValue in class AbstractSingleUploadField<C extends AbstractSingleUploadField<C,byte[],byte[]>,byte[],byte[]>

valueEquals

protected boolean valueEquals(@org.jspecify.annotations.Nullable byte[] a,
 @org.jspecify.annotations.Nullable byte[] b)

Overrides:

valueEquals in class com.vaadin.flow.component.AbstractField<C extends AbstractSingleUploadField<C,byte[],byte[]>,byte[]>

createUploadHandler

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

Specified by:

createUploadHandler in class AbstractSingleUploadField<C extends AbstractSingleUploadField<C,byte[],byte[]>,byte[],byte[]>

getContentType

protected String getContentType(String fileName)

Specified by:

getContentType in class AbstractSingleUploadField<C extends AbstractSingleUploadField<C,byte[],byte[]>,byte[],byte[]>