com.vaadin.flow.component.upload.ProgressUpdateEvent API 23.1.17 | Vaadin

You're viewing an older version of Vaadin JavaDoc. Please see version 24.7.0 for the latest.

com.vaadin.flow.component.upload.

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)`	Event constructor method to construct a new progress event.

Method Summary

All Methods
Modifier and Type	Method	Description
`long`	`getContentLength()`	Get total file size.
`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 Detail
  - ProgressUpdateEvent
```
public ProgressUpdateEvent(Upload source,
                           long readBytes,
                           long contentLength)
```
    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
- Method Detail
  - 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