no.g9.client.spreadsheet

Interface SpreadsheetService

All Known Implementing Classes:

DefaultSpreadsheetService

@BeanID(value="spreadsheetService")
 @G9PropertyName(value="SpreadsheetService")
public interface SpreadsheetService

The interface handles export to spreadsheets, such as Excel.
The implementation to be used at runtime can be controlled by configuring a "spreadsheetService" Spring bean, or by setting the "SpreadsheetService" property in the "g9.config.properties" file.
The default is to use no.g9.client.spreadsheet.DefaultSpreadsheetService.

Method Summary

Modifier and Type	Method and Description
SpreadsheetExporter	exportToSpreadsheet(ObjectSelection os, DialogConstant targetDialog, File file) Export data from the given dialog to a spreadsheet.
SpreadsheetExporter	exportToSpreadsheet(ObjectSelection os, DialogConstant targetDialog, File file, ClientContext ctx) Export data from the given dialog to a spreadsheet.
SpreadsheetExporter	exportToSpreadsheet(ObjectSelection os, DialogConstant targetDialog, OutputStream outputStream) Export data from the given dialog to a spreadsheet.
SpreadsheetExporter	exportToSpreadsheet(ObjectSelection os, DialogConstant targetDialog, OutputStream outputStream, ClientContext ctx) Export data from the given dialog to a spreadsheet.
String	getFileSuffix()
String	getMimeType()

Method Detail

exportToSpreadsheet

SpreadsheetExporter exportToSpreadsheet(ObjectSelection os,
                                        DialogConstant targetDialog,
                                        File file)

Export data from the given dialog to a spreadsheet. The dialog data is transferred in the os parameter.

Parameters:

os - The dialog data to export

targetDialog - The dialog to export

file - The resulting spreadsheet file

Returns:

An object containing the exported workbook

exportToSpreadsheet

SpreadsheetExporter exportToSpreadsheet(ObjectSelection os,
                                        DialogConstant targetDialog,
                                        OutputStream outputStream)

Export data from the given dialog to a spreadsheet. The dialog data is transferred in the os parameter.

Parameters:

os - The dialog data to export

targetDialog - The dialog to export

outputStream - The output stream for the exported data

Returns:

An object containing the exported workbook

exportToSpreadsheet

SpreadsheetExporter exportToSpreadsheet(ObjectSelection os,
                                        DialogConstant targetDialog,
                                        File file,
                                        ClientContext ctx)

Export data from the given dialog to a spreadsheet. The dialog data is transferred in the os parameter.

Parameters:

os - The dialog data to export

targetDialog - The dialog to export

file - The resulting spreadsheet file

ctx - The client context, which may be used to send exporter parameters

Returns:

An object containing the exported workbook

exportToSpreadsheet

SpreadsheetExporter exportToSpreadsheet(ObjectSelection os,
                                        DialogConstant targetDialog,
                                        OutputStream outputStream,
                                        ClientContext ctx)

Export data from the given dialog to a spreadsheet. The dialog data is transferred in the os parameter.

Parameters:

os - The dialog data to export

targetDialog - The dialog to export

outputStream - The output stream for the exported data

ctx - The client context, which may be used to send exporter parameters

Returns:

An object containing the exported workbook

getFileSuffix

String getFileSuffix()

Returns:

the file suffix used for the exported data

getMimeType

String getMimeType()

Returns:

the MIME type used for the exported data