* Note, since Vaadin 24.8, this component can in some trivial cases be replaced with standard * features 🥳See Flow docs. *
** DynamicFileDownloadingDemoWithFlowAnchor class in test sources shows how to replace it and what * kind of limitations it has compared to this class. Some of the limitations are: *
* ** Note, that tooltips are only supported if the content of the link * supports them. For example, tooltips are supported if the * {@link #asButton()} method is called. * * @param text the tooltip text * @return the tooltip * @see HasTooltip#setTooltipText(String) */ @Override public Tooltip setTooltipText(String text) { // Anchor does not implement HasTooltip, hack to content // (often a Button) -> works HasTooltip component = (HasTooltip) getChildren().findFirst().get(); return component.setTooltipText(text); } @Override public Tooltip getTooltip() { HasTooltip component = (HasTooltip) getChildren().findFirst().get(); return component.getTooltip(); } /** * Configures the download to open in a new window and removes the download attribute and * content disposition headers instructing to download the target as a file. So essentially * we are giving the browser a chance to make a choise what should be done. This allows the component * to be used to generated e.g. PDF files on the fly and show them in browser by default. * * @return the same instance, fluent method */ public DynamicFileDownloader inNewWindow() { this.newWindow = true; return this; } /** * Writes the content of the downloaded file to the given output stream. */ @FunctionalInterface public interface ContentWriter extends Serializable { /** * Writes the content of the downloaded file to the given output * stream (~ output stream of there response). * * @param out the output stream to write to * @throws IOException if an IO error occurs */ void writeContent(OutputStream out) throws IOException; } /** * Generates name dynamically per request. Override for example to add * timestamps to the names of the downloaded files or to configure response * headers (executed during download, but before writing the actual response * body). */ @FunctionalInterface public interface FileNameGenerator extends Serializable { /** * Creates the filename for the downloaded files. *
* Called by the framework when download is requested by browser, just
* before the file body is generated.
*
* @param request the request object
* @return the file name to be used in the Content-Disposition header
*/
String getFileName(VaadinRequest request);
}
/**
* Generates the content of HTTP response header 'Content-Type'.
* If known, should be set to the MIME type of the content.
* Otherwise, the 'Content-Type' defaults to 'application/octet-stream'.
* This indicates content as "arbitrary binary data".
*
* @see RFC2046
*/
@FunctionalInterface
public interface ContentTypeGenerator extends Serializable {
/**
* Used as 'Content-Type' HTTP response header.
*
* @return MIME type of the content.
*/
String getContentType();
}
/**
* Event fired when the file download has been streamed to the client.
*/
public static class DownloadFinishedEvent extends ComponentEventtrue if the event originated from the
* client
*/
public DownloadFinishedEvent(DynamicFileDownloader source, boolean fromClient) {
super(source, fromClient);
}
}
/**
* Event fired when the file download has been streamed to the client.
*/
public static class DownloadStartedEvent extends ComponentEventtrue if the event originated from the
* client
*/
public DownloadStartedEvent(DynamicFileDownloader source, boolean fromClient) {
super(source, fromClient);
}
}
/**
* Event fired when the file download fails.
*/
public static class DownloadFailedEvent extends ComponentEvent