Package org.esa.snap.ui.loading

Class AbstractModalDialog

java.lang.Object

org.esa.snap.ui.AbstractDialog

org.esa.snap.ui.loading.AbstractModalDialog

All Implemented Interfaces:

MessageDialog

Direct Known Subclasses:

ProductAdvancedDialog

public abstract class AbstractModalDialog
extends AbstractDialog
implements MessageDialog

Created by jcoravu on 18/12/2018.

Field Summary

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

Modifier	Constructor	Description
protected	AbstractModalDialog(Window parent, String title, boolean isModal, String helpID)

Method Summary

Modifier and Type	Method	Description
protected void	addComponentToAllwaysEnabledList(JComponent component)
protected abstract JPanel	buildButtonsPanel(ActionListener cancelActionListener)
protected JPanel	buildButtonsPanel(String finishButtonText, ActionListener finishActionListener, String cancelButtonText, ActionListener cancelActionListener)
protected abstract JPanel	buildContentPanel(int gapBetweenColumns, int gapBetweenRows)
protected Insets	buildDefaultListItemMargins()
protected Insets	buildDefaultTextFieldMargins()
protected Border	buildDialogBorder(int margins)
protected JButton	buildDialogButton(String buttonText)
void	close()	This method is called, when the user clicks the close button of the dialog's top window bar.
protected static void	computePanelFirstColumn(JPanel contentPanel)
protected int	getDefaultContentPanelMargins()
protected int	getDefaultGapBetweenColumns()
protected int	getDefaultGapBetweenContentAndButtonPanels()
protected int	getDefaultGapBetweenRows()
protected LoadingIndicator	getLoadingIndicator()
protected int	getNewCurrentThreadId()
protected void	onAboutToShow()
protected void	registerEscapeKey(ActionListener cancelActionListener)
protected void	setEnabledComponentsWhileLoading(boolean enabled)
int	show()	Shows the dialog.

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, 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

Methods inherited from interface org.esa.snap.ui.loading.MessageDialog

showErrorDialog, showErrorDialog, showInformationDialog, showInformationDialog

Constructor Detail

AbstractModalDialog

protected AbstractModalDialog(Window parent,
                              String title,
                              boolean isModal,
                              String helpID)

Method Detail

buildContentPanel

protected abstract JPanel buildContentPanel(int gapBetweenColumns,
                                            int gapBetweenRows)

buildButtonsPanel

protected abstract JPanel buildButtonsPanel(ActionListener cancelActionListener)

close

public void close()

Description copied from class: AbstractDialog

This method is called, when the user clicks the close button of the dialog's top window bar. It can also be called directly. Override to implement the dialog's default close behaviour.

Specified by:

close in interface MessageDialog

Specified by:

close in class AbstractDialog

show

public final 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.

getDefaultGapBetweenContentAndButtonPanels

protected int getDefaultGapBetweenContentAndButtonPanels()

getDefaultContentPanelMargins

protected int getDefaultContentPanelMargins()

getDefaultGapBetweenRows

protected int getDefaultGapBetweenRows()

getDefaultGapBetweenColumns

protected int getDefaultGapBetweenColumns()

buildDefaultTextFieldMargins

protected final Insets buildDefaultTextFieldMargins()

buildDefaultListItemMargins

protected final Insets buildDefaultListItemMargins()

addComponentToAllwaysEnabledList

protected final void addComponentToAllwaysEnabledList(JComponent component)

buildButtonsPanel

protected final JPanel buildButtonsPanel(String finishButtonText,
                                         ActionListener finishActionListener,
                                         String cancelButtonText,
                                         ActionListener cancelActionListener)

setEnabledComponentsWhileLoading

protected void setEnabledComponentsWhileLoading(boolean enabled)

getLoadingIndicator

protected final LoadingIndicator getLoadingIndicator()

getNewCurrentThreadId

protected final int getNewCurrentThreadId()

onAboutToShow

protected void onAboutToShow()

buildDialogBorder

protected Border buildDialogBorder(int margins)

registerEscapeKey

protected void registerEscapeKey(ActionListener cancelActionListener)

buildDialogButton

protected final JButton buildDialogButton(String buttonText)

computePanelFirstColumn

protected static void computePanelFirstColumn(JPanel contentPanel)