org.esa.snap.ui

Class ModalDialog

java.lang.Object

org.esa.snap.ui.AbstractDialog

org.esa.snap.ui.ModalDialog

Direct Known Subclasses:

AbstractAdapterEditor, BandChooser, CreateFilteredBandDialog, ExportLegendImageAction.ImageLegendDialog, FeatureCrsDialog, ModuleSuiteDialog, NewBandDialog, NewProductDialog, PlacemarkDialog, ProductChooser, ProductSubsetDialog, ProjectionParamsDialog, PropagateUncertaintyDialog, SpectrumChooser, SystemDependentVariableEditorDialog, TemplateParameterEditorDialog, ToolParameterEditorDialog

public class ModalDialog
extends AbstractDialog

A helper class used to implement standard modal dialogs.

The dialog can be used directly or the class is used as base class in order to override the methods AbstractDialog.onOK(), AbstractDialog.onCancel() etc. which are called if a user presses the corresponding button.

Since:

BEAM 1.0

Field Summary

Fields

Modifier and Type	Field and Description
static int	ID_OK_APPLY_CANCEL
static int	ID_OK_APPLY_CANCEL_HELP
static int	ID_OK_CANCEL
static int	ID_OK_CANCEL_HELP
static int	ID_YES_NO
static int	ID_YES_NO_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
ModalDialog(Window parent, String title, int buttonMask, Object[] otherButtons, String helpID)
ModalDialog(Window parent, String title, int buttonMask, String helpID)
ModalDialog(Window parent, String title, Object content, int buttonMask, Object[] otherButtons, String helpID)
ModalDialog(Window parent, String title, Object content, int buttonMask, String helpID)

Method Summary

Modifier and Type	Method and Description
void	close() This method is called, when the user clicks the "cancel" button or the "close" button of the top bar of the dialog window.

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

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

Methods inherited from class java.lang.Object

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

Field Detail

ID_OK_CANCEL

public static final int ID_OK_CANCEL

See Also:

Constant Field Values

ID_OK_CANCEL_HELP

public static final int ID_OK_CANCEL_HELP

See Also:

Constant Field Values

ID_OK_APPLY_CANCEL

public static final int ID_OK_APPLY_CANCEL

See Also:

Constant Field Values

ID_OK_APPLY_CANCEL_HELP

public static final int ID_OK_APPLY_CANCEL_HELP

See Also:

Constant Field Values

ID_YES_NO

public static final int ID_YES_NO

See Also:

Constant Field Values

ID_YES_NO_HELP

public static final int ID_YES_NO_HELP

See Also:

Constant Field Values

Constructor Detail

ModalDialog

public ModalDialog(Window parent,
                   String title,
                   int buttonMask,
                   String helpID)

ModalDialog

public ModalDialog(Window parent,
                   String title,
                   Object content,
                   int buttonMask,
                   String helpID)

ModalDialog

public ModalDialog(Window parent,
                   String title,
                   Object content,
                   int buttonMask,
                   Object[] otherButtons,
                   String helpID)

ModalDialog

public ModalDialog(Window parent,
                   String title,
                   int buttonMask,
                   Object[] otherButtons,
                   String helpID)

Method Detail

close

public void close()

This method is called, when the user clicks the "cancel" button or the "close" button of the top bar of the dialog window. It can also be called directly. The method sets the button identifier to AbstractDialog.ID_CANCEL and calls AbstractDialog.onCancel().

Specified by:

close in class AbstractDialog