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

Class ExportCommand

java.lang.Object
org.eclipse.nebula.widgets.nattable.command.AbstractContextFreeCommand
org.eclipse.nebula.widgets.nattable.export.command.ExportCommand
All Implemented Interfaces:
ILayerCommand
public class ExportCommand extends AbstractContextFreeCommand
Command to trigger export functionality.
See Also:

  • Constructor Details

    • ExportCommand

      public ExportCommand(IConfigRegistry configRegistry, org.eclipse.swt.widgets.Shell shell)
      Creates a new ExportCommand.
      Parameters:
      configRegistry - The IConfigRegistry that contains the necessary export configurations.
      shell - The Shell that should be used to open sub-dialogs and perform export operations in a background thread. Can be null 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 new ExportCommand.
      Parameters:
      configRegistry - The IConfigRegistry that contains the necessary export configurations.
      shell - The Shell that should be used to open sub-dialogs and perform export operations in a background thread. Can be null 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 a Shell is set.
      Since:
      1.6

    • ExportCommand

      public ExportCommand(IConfigRegistry configRegistry, org.eclipse.swt.widgets.Shell shell, boolean executeSynchronously, boolean useProgressDialog)
      Creates a new ExportCommand.
      Parameters:
      configRegistry - The IConfigRegistry that contains the necessary export configurations.
      shell - The Shell that should be used to open sub-dialogs and perform export operations in a background thread. Can be null 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 a Shell is set.
      useProgressDialog - Configure whether the progress should be reported via ProgressMonitorDialog. If set to false a custom shell with a ProgressBar will be shown if the shell parameter is not null.
      Since:
      2.3

    • ExportCommand

      public ExportCommand(IConfigRegistry configRegistry, org.eclipse.swt.widgets.Shell shell, boolean executeSynchronously, boolean useProgressDialog, ILayerExporter exporter)
      Creates a new ExportCommand.
      Parameters:
      configRegistry - The IConfigRegistry that contains the necessary export configurations.
      shell - The Shell that should be used to open sub-dialogs and perform export operations in a background thread. Can be null 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 a Shell is set.
      useProgressDialog - Configure whether the progress should be reported via ProgressMonitorDialog. If set to false a custom shell with a ProgressBar will be shown if the shell parameter is not null.
      exporter - The ILayerExporter that should be used. Can be null, which causes the usage of the exporter registered in the IConfigRegistry.
      Since:
      2.3

  • Method Details

    • getConfigRegistry

      public IConfigRegistry 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. Or null 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 a Shell is set.
      Since:
      1.6

    • isUseProgressDialog

      public boolean isUseProgressDialog()
      Returns:
      true if the progress should be reported via ProgressMonitorDialog.
      Since:
      2.3

    • getExporter

      public ILayerExporter getExporter()
      Returns:
      The ILayerExporter that should be used. Can be null, which causes the usage of the exporter registered in the IConfigRegistry.
      Since:
      2.3