io.jmix.ui.download

Interface Downloader

All Known Implementing Classes:

DownloaderImpl

public interface Downloader

Generic interface to download data from the system.

Method Summary

Modifier and Type	Method and Description
void	download(byte[] data, java.lang.String resourceName) Downloads passed byte array.
void	download(byte[] data, java.lang.String resourceName, DownloadFormat format) Downloads passed byte array.
void	download(DownloadDataProvider dataProvider, java.lang.String resourceName) Downloads an arbitrary resource defined by a DownloadDataProvider.
void	download(DownloadDataProvider dataProvider, java.lang.String resourceName, DownloadFormat format) Downloads an arbitrary resource defined by a DownloadDataProvider.
void	download(io.jmix.core.FileRef fileReference) Downloads a file from file storage.
void	download(io.jmix.core.FileRef fileReference, DownloadFormat format) Downloads a file from file storage.
boolean	isShowNewWindow()
void	setFileStorage(io.jmix.core.FileStorage fileStorage) Sets a file storage where the files will be downloaded from.
void	setShowNewWindow(boolean showNewWindow) Sets explicit new window option.

Method Detail

download

void download(DownloadDataProvider dataProvider,
              java.lang.String resourceName,
              @Nullable
              DownloadFormat format)

Downloads an arbitrary resource defined by a DownloadDataProvider.

Parameters:

dataProvider - resource provider

resourceName - resource name

format - download format, can be null

download

void download(DownloadDataProvider dataProvider,
              java.lang.String resourceName)

Downloads an arbitrary resource defined by a DownloadDataProvider.

Parameters:

dataProvider - resource provider

resourceName - resource name

download

void download(io.jmix.core.FileRef fileReference)

Downloads a file from file storage.

The default file storage of the system is used by default. Different file storage can be set in setFileStorage(FileStorage).

Parameters:

fileReference - file reference

download

void download(io.jmix.core.FileRef fileReference,
              @Nullable
              DownloadFormat format)

Downloads a file from file storage.

The default file storage of the system is used by default. Different file storage can be set in setFileStorage(FileStorage).

Parameters:

fileReference - file reference

format - download format, can be null

download

void download(byte[] data,
              java.lang.String resourceName)

Downloads passed byte array.

Parameters:

data - data in the form of byte array

resourceName - resource name

download

void download(byte[] data,
              java.lang.String resourceName,
              @Nullable
              DownloadFormat format)

Downloads passed byte array.

Parameters:

data - data in the form of byte array

resourceName - resource name

format - download format, can be null

setFileStorage

void setFileStorage(io.jmix.core.FileStorage fileStorage)

Sets a file storage where the files will be downloaded from.

Parameters:

fileStorage - file storage

isShowNewWindow

boolean isShowNewWindow()

Returns:

true if downloader should open a new window with the file content

setShowNewWindow

void setShowNewWindow(boolean showNewWindow)

Sets explicit new window option.

Parameters:

showNewWindow - true if downloader opens new window, otherwise false