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

Class JmixUploadButton

java.lang.Object

com.vaadin.flow.component.Component

com.vaadin.flow.component.upload.Upload

io.jmix.flowui.kit.component.upload.JmixUploadButton

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.HasSize, com.vaadin.flow.component.HasStyle, com.vaadin.flow.component.HasTheme, com.vaadin.flow.component.shared.HasThemeVariant<com.vaadin.flow.component.upload.UploadVariant>, Serializable

@Tag("jmix-upload-button")
@JsModule("./src/upload-button/jmix-upload-button.js")
public class JmixUploadButton
extends com.vaadin.flow.component.upload.Upload

A custom upload button component that extends the Vaadin Upload. This component provides additional functionality, including integration with JmixUploadI18N and support for internal error handling.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	JmixUploadButton.JmixUploadInternalErrorEvent

Field Summary

Fields

Modifier and Type	Field	Description
protected JmixUploadI18N	i18n
protected static final String	JMIX_UPLOAD_BUTTON_CLASS_NAME
protected com.vaadin.flow.server.streams.UploadHandler	uploadHandler

Constructor Summary

Constructors

Constructor	Description
JmixUploadButton()

Method Summary

Modifier and Type	Method	Description
protected com.vaadin.flow.shared.Registration	addUploadInternalError(com.vaadin.flow.component.ComponentEventListener<JmixUploadButton.JmixUploadInternalErrorEvent> listener)
com.vaadin.flow.server.streams.UploadHandler	getUploadHandler()	Returns the upload handler to be used for this upload component.
void	setI18n(com.vaadin.flow.component.upload.UploadI18N i18n)
void	setUploadHandler(com.vaadin.flow.server.streams.UploadHandler handler)

Methods inherited from class com.vaadin.flow.component.upload.Upload

addAllFinishedListener, addFailedListener, addFileRejectedListener, addFileRemovedListener, addFinishedListener, addProgressListener, addStartedListener, addSucceededListener, clearFileList, fireUpdateProgress, fireUpdateProgress, getAcceptedFileTypes, getDropLabel, getDropLabelIcon, getI18n, getMaxFiles, getMaxFileSize, getReceiver, getUploadButton, interruptUpload, isAutoUpload, isDropAllowed, isUploading, setAcceptedFileTypes, setAutoUpload, setDropAllowed, setDropLabel, setDropLabelIcon, setMaxFiles, setMaxFileSize, setReceiver, setUploadButton, setUploadFormat, setUploadHandler

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, setEnabled

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

addThemeVariants, bindThemeVariant, removeThemeVariants, setThemeVariant, setThemeVariants, setThemeVariants

Field Details

i18n

protected JmixUploadI18N i18n

JMIX_UPLOAD_BUTTON_CLASS_NAME

protected static final String JMIX_UPLOAD_BUTTON_CLASS_NAME

See Also:

• Constant Field Values

uploadHandler

protected com.vaadin.flow.server.streams.UploadHandler uploadHandler

Constructor Details

JmixUploadButton

public JmixUploadButton()

Method Details

setI18n

public void setI18n(com.vaadin.flow.component.upload.UploadI18N i18n)

Overrides:

setI18n in class com.vaadin.flow.component.upload.Upload

addUploadInternalError

protected com.vaadin.flow.shared.Registration addUploadInternalError(com.vaadin.flow.component.ComponentEventListener<JmixUploadButton.JmixUploadInternalErrorEvent> listener)

getUploadHandler

public com.vaadin.flow.server.streams.UploadHandler getUploadHandler()

Returns the upload handler to be used for this upload component.

Returns:

the upload handler to be used for this upload component

setUploadHandler

public void setUploadHandler(com.vaadin.flow.server.streams.UploadHandler handler)

Overrides:

setUploadHandler in class com.vaadin.flow.component.upload.Upload