Package com.vaadin.flow.component.upload

Class ProgressUpdateEvent

java.lang.Object

java.util.EventObject

com.vaadin.flow.component.ComponentEvent<Upload>

com.vaadin.flow.component.upload.ProgressUpdateEvent

All Implemented Interfaces:

Serializable

public class ProgressUpdateEvent
extends ComponentEvent<Upload>

ProgressUpdateEvent is sent to track progress of upload.

Author:

Vaadin Ltd.

See Also:

• Serialized Form

Field Summary

Fields inherited from class java.util.EventObject

source

Constructor Summary

Constructors

Constructor	Description
ProgressUpdateEvent(Upload source, long readBytes, long contentLength)	Deprecated. since 24.4.
ProgressUpdateEvent(Upload source, long readBytes, long contentLength, String fileName)	Event constructor method to construct a new progress event.

Method Summary

Modifier and Type	Method	Description
long	getContentLength()	Get total file size.
String	getFileName()	Get the file name.
long	getReadBytes()	Get bytes transferred for this update.
Upload	getUpload()	Upload where the event occurred.

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

getSource, isFromClient, unregisterListener

Methods inherited from class java.util.EventObject

toString

Methods inherited from class java.lang.Object

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

Constructor Details

ProgressUpdateEvent

@Deprecated(since="24.4")
public ProgressUpdateEvent(Upload source,
 long readBytes,
 long contentLength)

Deprecated.

since 24.4. Use ProgressUpdateEvent(Upload, long, long, String)

Event constructor method to construct a new progress event.

Parameters:

source - the source of the file

readBytes - bytes transferred

contentLength - total size of file currently being uploaded, -1 if unknown

ProgressUpdateEvent

public ProgressUpdateEvent(Upload source,
 long readBytes,
 long contentLength,
 String fileName)

Event constructor method to construct a new progress event.

Parameters:

source - the source of the file

readBytes - bytes transferred

contentLength - total size of file currently being uploaded, -1 if unknown

fileName - name of file currently being uploaded

Method Details

getUpload

public Upload getUpload()

Upload where the event occurred.

Returns:

the Source of the event

getReadBytes

public long getReadBytes()

Get bytes transferred for this update.

Returns:

bytes transferred

getContentLength

public long getContentLength()

Get total file size.

Returns:

total file size or -1 if unknown

getFileName

public String getFileName()

Get the file name.

Returns:

file name