Package com.vaadin.flow.component.upload

Class GeneratedVaadinUploadFile<R extends GeneratedVaadinUploadFile<R>>

java.lang.Object

com.vaadin.flow.component.Component

com.vaadin.flow.component.upload.GeneratedVaadinUploadFile<R>

All Implemented Interfaces:

AttachNotifier, DetachNotifier, HasElement, HasStyle, Serializable

@Tag("vaadin-upload-file")
@NpmPackage(value="@vaadin/polymer-legacy-adapter",
            version="23.2.17")
@JsModule("@vaadin/polymer-legacy-adapter/style-modules.js") @JsModule("@vaadin/upload/src/vaadin-upload-file.js")
public abstract class GeneratedVaadinUploadFile<R extends GeneratedVaadinUploadFile<R>>
extends Component
implements HasStyle

Description copied from corresponding location in WebComponent:

<vaadin-upload-file> element represents a file in the file list of <vaadin-upload>.

Styling

The following shadow DOM parts are available for styling:

Part name	Description
row	File container
info	Container for file status icon, file name, status and error messages
done-icon	File done status icon
warning-icon	File warning status icon
meta	Container for file name, status and error messages
name	File name
error	Error message, shown when error happens
status	Status message
commands	Container for file command icons
start-button	Start file upload button
retry-button	Retry file upload button
clear-button	Clear file button
progress	Progress bar

The following state attributes are available for styling:

Attribute	Description	Part name
error	An error has happened during uploading	:host
indeterminate	Uploading is in progress, but the progress value is unknown	:host
uploading	Uploading is in progress	:host
complete	Uploading has finished successfully	:host

See ThemableMixin – how to apply styles for shadow parts

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	GeneratedVaadinUploadFile.FileAbortEvent<R extends GeneratedVaadinUploadFile<R>>
static class	GeneratedVaadinUploadFile.FileRemoveEvent<R extends GeneratedVaadinUploadFile<R>>
static class	GeneratedVaadinUploadFile.FileRetryEvent<R extends GeneratedVaadinUploadFile<R>>
static class	GeneratedVaadinUploadFile.FileStartEvent<R extends GeneratedVaadinUploadFile<R>>

Constructor Summary

Constructors

Constructor	Description
GeneratedVaadinUploadFile()

Method Summary

Modifier and Type	Method	Description
protected Registration	addFileAbortListener(ComponentEventListener<GeneratedVaadinUploadFile.FileAbortEvent<R>> listener)	Adds a listener for file-abort events fired by the webcomponent.
protected Registration	addFileRemoveListener(ComponentEventListener<GeneratedVaadinUploadFile.FileRemoveEvent<R>> listener)	Adds a listener for file-remove events fired by the webcomponent.
protected Registration	addFileRetryListener(ComponentEventListener<GeneratedVaadinUploadFile.FileRetryEvent<R>> listener)	Adds a listener for file-retry events fired by the webcomponent.
protected Registration	addFileStartListener(ComponentEventListener<GeneratedVaadinUploadFile.FileStartEvent<R>> listener)	Adds a listener for file-start events fired by the webcomponent.
protected elemental.json.JsonObject	getFileJsonObject()	This property is not synchronized automatically from the client side, so the returned value may not be the same as in client side.
protected void	setFile(elemental.json.JsonObject file)

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, onAttach, onDetach, onEnabledStateChanged, 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.HasStyle

addClassName, addClassNames, getClassName, getClassNames, getStyle, hasClassName, removeClassName, removeClassNames, setClassName, setClassName

Constructor Detail

GeneratedVaadinUploadFile

public GeneratedVaadinUploadFile()

Method Detail

getFileJsonObject

protected elemental.json.JsonObject getFileJsonObject()

This property is not synchronized automatically from the client side, so the returned value may not be the same as in client side.

Returns:

the file property from the webcomponent

setFile

protected void setFile(elemental.json.JsonObject file)

Parameters:

file - the JsonObject value to set

addFileAbortListener

protected Registration addFileAbortListener(ComponentEventListener<GeneratedVaadinUploadFile.FileAbortEvent<R>> listener)

Adds a listener for file-abort events fired by the webcomponent.

Parameters:

listener - the listener

Returns:

a Registration for removing the event listener

addFileRemoveListener

protected Registration addFileRemoveListener(ComponentEventListener<GeneratedVaadinUploadFile.FileRemoveEvent<R>> listener)

Adds a listener for file-remove events fired by the webcomponent.

Parameters:

listener - the listener

Returns:

a Registration for removing the event listener

addFileRetryListener

protected Registration addFileRetryListener(ComponentEventListener<GeneratedVaadinUploadFile.FileRetryEvent<R>> listener)

Adds a listener for file-retry events fired by the webcomponent.

Parameters:

listener - the listener

Returns:

a Registration for removing the event listener

addFileStartListener

protected Registration addFileStartListener(ComponentEventListener<GeneratedVaadinUploadFile.FileStartEvent<R>> listener)

Adds a listener for file-start events fired by the webcomponent.

Parameters:

listener - the listener

Returns:

a Registration for removing the event listener