org.esa.snap.ui.tooladapter.dialogs

Class ToolAdapterExecutionDialog

java.lang.Object

org.esa.snap.ui.AbstractDialog

org.esa.snap.ui.ModelessDialog

org.esa.snap.core.gpf.ui.SingleTargetProductDialog

org.esa.snap.ui.tooladapter.dialogs.ToolAdapterExecutionDialog

public class ToolAdapterExecutionDialog
extends org.esa.snap.core.gpf.ui.SingleTargetProductDialog

Form dialog for running a tool adapter operator.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	ToolAdapterExecutionDialog.OperatorTask Runnable for executing the operator.

Field Summary

Fields

Modifier and Type	Field and Description
static String	helpID
static String	SOURCE_PRODUCT_FIELD

Fields inherited from class org.esa.snap.core.gpf.ui.SingleTargetProductDialog

appContext, targetProductSelector

Fields inherited from class org.esa.snap.ui.ModelessDialog

ID_APPLY_CLOSE, ID_APPLY_CLOSE_HELP

Fields inherited from class org.esa.snap.ui.AbstractDialog

ID_APPLY, ID_CANCEL, ID_CLOSE, ID_HELP, ID_NO, ID_OK, ID_OTHER, ID_RESET, ID_YES

Constructor Summary

Constructors

Constructor and Description
ToolAdapterExecutionDialog(ToolAdapterOperatorDescriptor descriptor, AppContext appContext, String title) Constructor.

Method Summary

Modifier and Type	Method and Description
protected boolean	canApply()
protected Product	createTargetProduct() Creates the desired target product.
void	hide() Hides the dialog.
protected void	onApply() Called if the "Apply" button has been clicked.
protected void	onCancel() Called if the "Cancel" button has been clicked.
protected void	onClose() Called if the "Close" button has been clicked.
int	show() Shows the dialog.

Methods inherited from class org.esa.snap.core.gpf.ui.SingleTargetProductDialog

getAppContext, getTargetProductSelector, handleInitialisationError, handleProcessingError, showOpenInAppInfo, showSuppressibleInformationDialog

Methods inherited from class org.esa.snap.ui.ModelessDialog

close

Methods inherited from class org.esa.snap.ui.AbstractDialog

center, collectButtons, getButton, getButtonID, getButtonMask, getButtonPanel, getContent, getHelpID, getJDialog, getParent, getQualifiedPropertyName, getTitle, onHelp, onNo, onOK, onOther, onReset, onYes, registerButton, setButtonID, setContent, setContent, setHelpID, setTitle, showErrorDialog, showInformationDialog, showWarningDialog, verifyUserInput

Methods inherited from class java.lang.Object

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

Field Detail

SOURCE_PRODUCT_FIELD

public static final String SOURCE_PRODUCT_FIELD

See Also:

Constant Field Values

helpID

public static final String helpID

See Also:

Constant Field Values

Constructor Detail

ToolAdapterExecutionDialog

public ToolAdapterExecutionDialog(ToolAdapterOperatorDescriptor descriptor,
                                  AppContext appContext,
                                  String title)

Constructor.

Parameters:

descriptor - The operator descriptor

appContext - The application context

title - The dialog title

Method Detail

onApply

protected void onApply()

Description copied from class: AbstractDialog

Called if the "Apply" button has been clicked. The default implementation does nothing. Clients should override this method to implement meaningful behaviour.

Overrides:

onApply in class org.esa.snap.core.gpf.ui.SingleTargetProductDialog

show

public int show()

Description copied from class: AbstractDialog

Shows the dialog. Overrides shall call super.show() at the end.

Overrides:

show in class AbstractDialog

Returns:

the identifier of the last button pressed or zero if this is a modeless dialog.

hide

public void hide()

Description copied from class: AbstractDialog

Hides the dialog. Overrides shall call super.hide() at the end. This method does nothing else than hiding the underlying Swing dialog.

Overrides:

hide in class AbstractDialog

See Also:

AbstractDialog.getJDialog()

createTargetProduct

protected Product createTargetProduct()
                               throws Exception

Description copied from class: org.esa.snap.core.gpf.ui.SingleTargetProductDialog

Creates the desired target product. Usually, this method will be implemented by invoking one of the multiple GPF createProduct methods.

The method should throw a OperatorException in order to signal "nominal" processing errors, other exeption types are treated as internal errors.

Specified by:

createTargetProduct in class org.esa.snap.core.gpf.ui.SingleTargetProductDialog

Returns:

The target product.

Throws:

Exception - if an error occurs, an OperatorException is signaling "nominal" processing errors.

canApply

protected boolean canApply()

Overrides:

canApply in class org.esa.snap.core.gpf.ui.SingleTargetProductDialog

onCancel

protected void onCancel()

Description copied from class: AbstractDialog

Called if the "Cancel" button has been clicked. The default implementation calls AbstractDialog.hide(). Clients should override this method to implement meaningful behaviour.

Overrides:

onCancel in class AbstractDialog

onClose

protected void onClose()

Description copied from class: AbstractDialog

Called if the "Close" button has been clicked. The default implementation calls AbstractDialog.hide(). Clients should override this method to implement meaningful behaviour.

Overrides:

onClose in class AbstractDialog