com.haulmont.cuba.web.filestorage

Class WebExportDisplay

java.lang.Object

com.haulmont.cuba.web.filestorage.WebExportDisplay

All Implemented Interfaces:

ExportDisplay

@Component(value="cuba_ExportDisplay")
 @Scope(value="prototype")
public class WebExportDisplay
extends java.lang.Object
implements ExportDisplay

Allows to show exported data in web browser or download it.

Field Summary

Fields

Modifier and Type	Field and Description
protected BackgroundWorker	backgroundWorker
protected Configuration	configuration
protected Messages	messages
protected boolean	newWindow
protected boolean	useViewList

Fields inherited from interface com.haulmont.cuba.gui.export.ExportDisplay

NAME

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
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	setFrame(Frame frame) INTERNAL.
void	setMessages(Messages messages)
void	setNewWindow(boolean newWindow) Deprecated. Use setShowNewWindow(boolean)
void	setShowNewWindow(boolean showNewWindow) Sets explicit new window option.
void	show(byte[] content, java.lang.String resourceName, ExportFormat format)
void	show(ExportDataProvider dataProvider, java.lang.String resourceName) Show/Download resource at client side
void	show(ExportDataProvider dataProvider, java.lang.String resourceName, ExportFormat exportFormat) Show/Download resource at client side
void	show(FileDescriptor fileDescriptor) Export a file from file storage.
void	show(FileDescriptor fileDescriptor, ExportFormat format) Export a file from file storage.
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

@Inject
protected BackgroundWorker backgroundWorker

configuration

@Inject
protected Configuration configuration

messages

protected Messages messages

newWindow

protected boolean newWindow

useViewList

protected boolean useViewList

Constructor Detail

WebExportDisplay

public WebExportDisplay()

Constructor with newWindow=false

WebExportDisplay

public WebExportDisplay(boolean newWindow)

Parameters:

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

Method Detail

setMessages

@Inject
public void setMessages(Messages messages)

show

public void show(ExportDataProvider dataProvider,
                 java.lang.String resourceName,
                 ExportFormat exportFormat)

Show/Download resource at client side

Specified by:

show in interface ExportDisplay

Parameters:

dataProvider - ExportDataProvider

resourceName - ResourceName for client side

exportFormat - ExportFormat

See Also:

FileDataProvider, ByteArrayDataProvider

show

public void show(ExportDataProvider dataProvider,
                 java.lang.String resourceName)

Show/Download resource at client side

Specified by:

show in interface ExportDisplay

Parameters:

dataProvider - ExportDataProvider

resourceName - ResourceName for client side

See Also:

FileDataProvider, ByteArrayDataProvider

show

public void show(FileDescriptor fileDescriptor,
                 ExportFormat format)

Description copied from interface: ExportDisplay

Export a file from file storage.

Specified by:

show in interface ExportDisplay

Parameters:

fileDescriptor - file descriptor

format - export format, can be null

setFrame

public void setFrame(Frame frame)

Description copied from interface: ExportDisplay

INTERNAL. Don't call from application code.

Specified by:

setFrame in interface ExportDisplay

isShowNewWindow

public boolean isShowNewWindow()

Specified by:

isShowNewWindow in interface ExportDisplay

Returns:

true if export display should open a new window with the file content

setShowNewWindow

public void setShowNewWindow(boolean showNewWindow)

Description copied from interface: ExportDisplay

Sets explicit new window option.

Specified by:

setShowNewWindow in interface ExportDisplay

Parameters:

showNewWindow - true if export display opens new window, false otherwise

show

public void show(FileDescriptor fileDescriptor)

Description copied from interface: ExportDisplay

Export a file from file storage.

Specified by:

show in interface ExportDisplay

Parameters:

fileDescriptor - file descriptor

show

public void show(byte[] content,
                 java.lang.String resourceName,
                 ExportFormat format)

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