io.jmix.ui.download

Class DownloaderImpl

java.lang.Object

io.jmix.ui.download.DownloaderImpl

All Implemented Interfaces:

Downloader

@Component(value="ui_Downloader")
 @Scope(value="prototype")
public class DownloaderImpl
extends java.lang.Object
implements Downloader

Shows exported data in the web browser or downloads it.

Field Summary

Fields

Modifier and Type	Field and Description
protected BackgroundWorker	backgroundWorker
protected io.jmix.core.CoreProperties	coreProperties
protected io.jmix.core.FileStorage	fileStorage
protected io.jmix.core.FileStorageLocator	fileStorageLocator
protected io.jmix.core.Messages	messages
protected boolean	newWindow
protected UiProperties	uiProperties
protected boolean	useViewList

Constructor Summary

Constructors

Constructor and Description
DownloaderImpl() Constructor with newWindow=false
DownloaderImpl(boolean newWindow)

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) Show/Download resource at client side
void	download(DownloadDataProvider dataProvider, java.lang.String resourceName, DownloadFormat downloadFormat) Show/Download resource at client side
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.
protected boolean	handleFileNotFoundException(java.lang.Exception exception, com.vaadin.server.VaadinResponse response)
boolean	isBrowserSupportsPopups()
protected boolean	isIOS()
boolean	isNewWindow() Deprecated. Use isShowNewWindow()
boolean	isShowNewWindow()
void	setFileStorage(io.jmix.core.FileStorage fileStorage) Sets a file storage where the files will be downloaded from.
void	setFileStorageLocator(io.jmix.core.FileStorageLocator fileStorageLocator)
void	setMessages(io.jmix.core.Messages messages)
void	setNewWindow(boolean newWindow) Deprecated. Use setShowNewWindow(boolean)
void	setShowNewWindow(boolean showNewWindow) Sets explicit new window option.
protected void	writeFileNotFoundException(com.vaadin.server.VaadinResponse response, java.lang.String message)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

backgroundWorker

@Autowired
protected BackgroundWorker backgroundWorker

uiProperties

@Autowired
protected UiProperties uiProperties

coreProperties

@Autowired
protected io.jmix.core.CoreProperties coreProperties

messages

protected io.jmix.core.Messages messages

fileStorageLocator

protected io.jmix.core.FileStorageLocator fileStorageLocator

fileStorage

protected io.jmix.core.FileStorage fileStorage

newWindow

protected boolean newWindow

useViewList

protected boolean useViewList

Constructor Detail

DownloaderImpl

public DownloaderImpl()

Constructor with newWindow=false

DownloaderImpl

public DownloaderImpl(boolean newWindow)

Parameters:

newWindow - if true, show data in the same browser window; if false, open new browser window

Method Detail

setMessages

@Autowired
public void setMessages(io.jmix.core.Messages messages)

setFileStorageLocator

@Autowired
public void setFileStorageLocator(io.jmix.core.FileStorageLocator fileStorageLocator)

download

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

Show/Download resource at client side

Specified by:

download in interface Downloader

Parameters:

dataProvider - DownloadDataProvider

resourceName - ResourceName for client side

downloadFormat - DownloadFormat

See Also:

FileDataProvider, ByteArrayDataProvider

download

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

Show/Download resource at client side

Specified by:

download in interface Downloader

Parameters:

dataProvider - DownloadDataProvider

resourceName - ResourceName for client side

See Also:

FileDataProvider, ByteArrayDataProvider

download

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

Description copied from interface: Downloader

Downloads a file from file storage.

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

Specified by:

download in interface Downloader

Parameters:

fileReference - file reference

download

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

Description copied from interface: Downloader

Downloads a file from file storage.

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

Specified by:

download in interface Downloader

Parameters:

fileReference - file reference

format - download format, can be null

download

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

Description copied from interface: Downloader

Downloads passed byte array.

Specified by:

download in interface Downloader

Parameters:

data - data in the form of byte array

resourceName - resource name

download

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

Description copied from interface: Downloader

Downloads passed byte array.

Specified by:

download in interface Downloader

Parameters:

data - data in the form of byte array

resourceName - resource name

format - download format, can be null

setFileStorage

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

Description copied from interface: Downloader

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

Specified by:

setFileStorage in interface Downloader

Parameters:

fileStorage - file storage

isShowNewWindow

public boolean isShowNewWindow()

Specified by:

isShowNewWindow in interface Downloader

Returns:

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

setShowNewWindow

public void setShowNewWindow(boolean showNewWindow)

Description copied from interface: Downloader

Sets explicit new window option.

Specified by:

setShowNewWindow in interface Downloader

Parameters:

showNewWindow - true if downloader opens new window, otherwise false

isNewWindow

@Deprecated
public boolean isNewWindow()

Deprecated. Use isShowNewWindow()

setNewWindow

@Deprecated
public void setNewWindow(boolean newWindow)

Deprecated. Use setShowNewWindow(boolean)

isBrowserSupportsPopups

public boolean isBrowserSupportsPopups()

isIOS

protected boolean isIOS()

handleFileNotFoundException

protected boolean handleFileNotFoundException(java.lang.Exception exception,
                                              com.vaadin.server.VaadinResponse response)

writeFileNotFoundException

protected void writeFileNotFoundException(com.vaadin.server.VaadinResponse response,
                                          java.lang.String message)
                                   throws java.io.IOException

Throws:

java.io.IOException