Package io.jmix.ui.download

Interface Downloader

All Known Implementing Classes:
DownloaderImpl
public interface Downloader
Generic interface to download data from the system.

  • Method Details

    • download

      void download(DownloadDataProvider dataProvider, 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, String resourceName)
      Downloads an arbitrary resource defined by a DownloadDataProvider.
      Parameters:
      dataProvider - resource provider
      resourceName - resource name

    • download

      void download(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(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, String resourceName)
      Downloads passed byte array.
      Parameters:
      data - data in the form of byte array
      resourceName - resource name

    • download

      void download(byte[] data, 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(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