com.vaadin.ui.Html5File Maven / Gradle / Ivy
/*
* Copyright (C) 2000-2024 Vaadin Ltd
*
* This program is available under Vaadin Commercial License and Service Terms.
*
* See for the full
* license.
*/
package com.vaadin.ui;
import java.io.Serializable;
import com.vaadin.event.dd.DropHandler;
import com.vaadin.server.StreamVariable;
/**
* {@link DragAndDropWrapper} can receive also files from client computer if
* appropriate HTML 5 features are supported on client side. This class wraps
* information about dragged file on server side.
*/
public class Html5File implements Serializable {
private final String name;
private final long size;
private StreamVariable streamVariable;
private final String type;
/**
* Constructs a new Html5 file wrapper.
*
* @param name
* the file name
* @param size
* the size of the file
* @param mimeType
* the type of the file
*/
public Html5File(String name, long size, String mimeType) {
this.name = name;
this.size = size;
type = mimeType;
}
public String getFileName() {
return name;
}
public long getFileSize() {
return size;
}
public String getType() {
return type;
}
/**
* Sets the {@link StreamVariable} that into which the file contents will be
* written. Usage of StreamVariable is similar to {@link Upload} component.
*
* If the {@link StreamVariable} is not set in the {@link DropHandler} the
* file contents will not be sent to server.
*
* Note! receiving file contents is experimental feature depending
* on HTML 5 API's. It is supported only by modern web browsers like Firefox
* 3.6 and above and recent webkit based browsers (Safari 5, Chrome 6) at
* this time.
*
* @param streamVariable
* the callback that returns stream where the implementation
* writes the file contents as it arrives.
*/
public void setStreamVariable(StreamVariable streamVariable) {
this.streamVariable = streamVariable;
}
public StreamVariable getStreamVariable() {
return streamVariable;
}
}