com.haulmont.cuba.gui.export

Interface ExportDisplay

All Known Implementing Classes:

WebExportDisplay

public interface ExportDisplay

Generic interface to show data exported from the system.
Use client-specific implementation obtained by AppConfig.createExportDisplay(Frame) or by injection into a screen controller.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	NAME

Method Summary

Modifier and Type	Method and Description
boolean	isShowNewWindow()
void	setFrame(Frame frame) INTERNAL.
void	setShowNewWindow(boolean showNewWindow) Sets explicit new window option.
void	show(ExportDataProvider dataProvider, java.lang.String resourceName) Export an arbitrary resource defined by a ExportDataProvider.
void	show(ExportDataProvider dataProvider, java.lang.String resourceName, ExportFormat format) Export an arbitrary resource defined by a ExportDataProvider.
void	show(FileDescriptor fileDescriptor) Export a file from file storage.
void	show(FileDescriptor fileDescriptor, ExportFormat format) Export a file from file storage.

Field Detail

NAME

static final java.lang.String NAME

See Also:

Constant Field Values

Method Detail

show

void show(ExportDataProvider dataProvider,
          java.lang.String resourceName,
          @Nullable
          ExportFormat format)

Export an arbitrary resource defined by a ExportDataProvider.

Parameters:

dataProvider - resource provider

resourceName - resource name

format - export format, can be null

show

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

Export an arbitrary resource defined by a ExportDataProvider.

Parameters:

dataProvider - resource provider

resourceName - resource name

show

void show(FileDescriptor fileDescriptor,
          @Nullable
          ExportFormat format)

Export a file from file storage.

Parameters:

fileDescriptor - file descriptor

format - export format, can be null

show

void show(FileDescriptor fileDescriptor)

Export a file from file storage.

Parameters:

fileDescriptor - file descriptor

isShowNewWindow

boolean isShowNewWindow()

Returns:

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

setShowNewWindow

void setShowNewWindow(boolean showNewWindow)

Sets explicit new window option.

Parameters:

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

setFrame

void setFrame(@Nullable
              Frame frame)

INTERNAL. Don't call from application code.