Package org.eclipse.nebula.widgets.nattable.export

Interface ITableExporter

All Superinterfaces:

IExporter

All Known Implementing Classes:

ImageExporter

public interface ITableExporter
extends IExporter

Interface for an exporter that can be used to export a NatTable. This type of exporter gives the implementor full control on how the export should be done. In comparison the ILayerExporter is used to export a NatTable data driven by iterating over the content.

Since:

1.5

Method Summary

Modifier and Type	Method	Description
void	exportTable(org.eclipse.swt.widgets.Shell shell, org.eclipse.swt.widgets.ProgressBar progressBar, OutputStream outputStream, ILayer layer, IConfigRegistry configRegistry)	Export a given ILayer to the given OutputStream.

Methods inherited from interface org.eclipse.nebula.widgets.nattable.export.IExporter

getOutputStream, getResult

Method Details

exportTable

void exportTable(org.eclipse.swt.widgets.Shell shell,
 org.eclipse.swt.widgets.ProgressBar progressBar,
 OutputStream outputStream,
 ILayer layer,
 IConfigRegistry configRegistry)
          throws IOException

Export a given ILayer to the given OutputStream.

Parameters:

shell - The current active Shell.

progressBar - The ProgressBar that can be used to report the export progress to the user.

outputStream - The OutputStream to write the export to. Typically previously retrieved by calling IExporter.getOutputStream(Shell).

layer - The ILayer to export, typically a NatTable instance.

configRegistry - The IConfigRegistry used to retrieve configuration information on exporting.

Throws:

IOException - If an error occurs while exporting.