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:

ExportCommandHandler

Constructor Summary

Constructors

Constructor	Description
ExportCommand(IConfigRegistry configRegistry, org.eclipse.swt.widgets.Shell shell)	Creates a new ExportCommand.
ExportCommand(IConfigRegistry configRegistry, org.eclipse.swt.widgets.Shell shell, boolean executeSynchronously)	Creates a new ExportCommand.

Method Summary

Modifier and Type	Method	Description
IConfigRegistry	getConfigRegistry()
org.eclipse.swt.widgets.Shell	getShell()
boolean	isExecuteSynchronously()

Methods inherited from class org.eclipse.nebula.widgets.nattable.command.AbstractContextFreeCommand

cloneCommand, convertToTargetLayer

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

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

Method Detail

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