Class ExportCommand
java.lang.Object
org.eclipse.nebula.widgets.nattable.command.AbstractContextFreeCommand
org.eclipse.nebula.widgets.nattable.export.command.ExportCommand
- All Implemented Interfaces:
ILayerCommand
Command to trigger export functionality.
- See Also:
-
Constructor Summary
ConstructorDescriptionExportCommand
(IConfigRegistry configRegistry, org.eclipse.swt.widgets.Shell shell) Creates a newExportCommand
.ExportCommand
(IConfigRegistry configRegistry, org.eclipse.swt.widgets.Shell shell, boolean executeSynchronously) Creates a newExportCommand
.ExportCommand
(IConfigRegistry configRegistry, org.eclipse.swt.widgets.Shell shell, boolean executeSynchronously, boolean useProgressDialog) Creates a newExportCommand
.ExportCommand
(IConfigRegistry configRegistry, org.eclipse.swt.widgets.Shell shell, boolean executeSynchronously, boolean useProgressDialog, ILayerExporter exporter) Creates a newExportCommand
. -
Method Summary
Methods inherited from class org.eclipse.nebula.widgets.nattable.command.AbstractContextFreeCommand
cloneCommand, convertToTargetLayer
-
Constructor Details
-
ExportCommand
Creates a newExportCommand
.- Parameters:
configRegistry
- TheIConfigRegistry
that contains the necessary export configurations.shell
- TheShell
that should be used to open sub-dialogs and perform export operations in a background thread. Can benull
which definitely leads to synchronous execution but could cause errors in case sub-dialogs should be opened before exporting.
-
ExportCommand
public ExportCommand(IConfigRegistry configRegistry, org.eclipse.swt.widgets.Shell shell, boolean executeSynchronously) Creates a newExportCommand
.- Parameters:
configRegistry
- TheIConfigRegistry
that contains the necessary export configurations.shell
- TheShell
that should be used to open sub-dialogs and perform export operations in a background thread. Can benull
which definitely leads to synchronous execution but could cause errors in case sub-dialogs should be opened before exporting.executeSynchronously
- Configure if the export should be performed synchronously even if aShell
is set.- Since:
- 1.6
-
ExportCommand
public ExportCommand(IConfigRegistry configRegistry, org.eclipse.swt.widgets.Shell shell, boolean executeSynchronously, boolean useProgressDialog) Creates a newExportCommand
.- Parameters:
configRegistry
- TheIConfigRegistry
that contains the necessary export configurations.shell
- TheShell
that should be used to open sub-dialogs and perform export operations in a background thread. Can benull
which definitely leads to synchronous execution but could cause errors in case sub-dialogs should be opened before exporting.executeSynchronously
- Configure if the export should be performed synchronously even if aShell
is set.useProgressDialog
- Configure whether the progress should be reported viaProgressMonitorDialog
. If set tofalse
a custom shell with aProgressBar
will be shown if the shell parameter is notnull
.- Since:
- 2.3
-
ExportCommand
public ExportCommand(IConfigRegistry configRegistry, org.eclipse.swt.widgets.Shell shell, boolean executeSynchronously, boolean useProgressDialog, ILayerExporter exporter) Creates a newExportCommand
.- Parameters:
configRegistry
- TheIConfigRegistry
that contains the necessary export configurations.shell
- TheShell
that should be used to open sub-dialogs and perform export operations in a background thread. Can benull
which definitely leads to synchronous execution but could cause errors in case sub-dialogs should be opened before exporting.executeSynchronously
- Configure if the export should be performed synchronously even if aShell
is set.useProgressDialog
- Configure whether the progress should be reported viaProgressMonitorDialog
. If set tofalse
a custom shell with aProgressBar
will be shown if the shell parameter is notnull
.exporter
- TheILayerExporter
that should be used. Can benull
, which causes the usage of the exporter registered in theIConfigRegistry
.- Since:
- 2.3
-
-
Method Details
-
getConfigRegistry
- Returns:
- The
IConfigRegistry
that contains the necessary export configurations.
-
getShell
public org.eclipse.swt.widgets.Shell getShell()- Returns:
- The
Shell
that should be used to open sub-dialogs and perform export operations in a background thread. Ornull
if the export should be performed synchronously and no sub-dialogs are needed in the process (e.g. to select the export destination).
-
isExecuteSynchronously
public boolean isExecuteSynchronously()- Returns:
true
if the export should be performed synchronously even if aShell
is set.- Since:
- 1.6
-
isUseProgressDialog
public boolean isUseProgressDialog()- Returns:
true
if the progress should be reported viaProgressMonitorDialog
.- Since:
- 2.3
-
getExporter
- Returns:
- The
ILayerExporter
that should be used. Can benull
, which causes the usage of the exporter registered in theIConfigRegistry
. - Since:
- 2.3
-