org.esa.beam.framework.ui.config
Class ConfigDialog

java.lang.Object
  org.esa.beam.framework.ui.AbstractDialog
      org.esa.beam.framework.ui.ModalDialog
          org.esa.beam.framework.ui.config.ConfigDialog

Direct Known Subclasses:

VisatPreferencesDialog

public class ConfigDialog
extends ModalDialog

Instances of the ConfigDialog class are modal dialogs composed of one or more, possibly nested configuration pages of the type ConfigPage. ConfigDialog uses a tree view to let the user switch between particular pages.

Version:

$Revision$ $Date$

Author:

Norman Fomferra, Sabine Embacher

See Also:

ConfigPage

Field Summary

Fields inherited from class org.esa.beam.framework.ui.ModalDialog

ID_OK_APPLY_CANCEL, ID_OK_APPLY_CANCEL_HELP, ID_OK_CANCEL, ID_OK_CANCEL_HELP, ID_YES_NO, ID_YES_NO_HELP

Fields inherited from class org.esa.beam.framework.ui.AbstractDialog

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

Constructor Summary

ConfigDialog()

ConfigDialog(Window owner, String helpID)

Method Summary

void	addRootPage(ConfigPage page)
void	expandAllPages()
PropertyMap	getConfigParamValues(PropertyMap propertyMap)
ConfigPage	getCurrentPage()
int	getNumRootPages()
ConfigPage	getRootPageAt(int index)
String	getTitleBase()
protected void	onOK() Called if the "OK" button has been clicked.
void	removeRootPage(ConfigPage page)
void	removeRootPageAt(int index)
void	setConfigParamValues(PropertyMap propertyMap, ParamExceptionHandler errorHandler)
void	setCurrentPage(ConfigPage currentPage)
void	setTitleBase(String titleBase)
int	show() Shows the dialog.
protected boolean	verifyUserInput() Called in order to perform input validation.

Methods inherited from class org.esa.beam.framework.ui.ModalDialog

close

Methods inherited from class org.esa.beam.framework.ui.AbstractDialog

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

Methods inherited from class java.lang.Object

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

Constructor Detail

ConfigDialog

public ConfigDialog()

ConfigDialog

public ConfigDialog(Window owner,
                    String helpID)

Method Detail

getConfigParamValues

public PropertyMap getConfigParamValues(PropertyMap propertyMap)

setConfigParamValues

public void setConfigParamValues(PropertyMap propertyMap,
                                 ParamExceptionHandler errorHandler)

expandAllPages

public void expandAllPages()

getTitleBase

public String getTitleBase()

setTitleBase

public void setTitleBase(String titleBase)

getNumRootPages

public int getNumRootPages()

getRootPageAt

public ConfigPage getRootPageAt(int index)

addRootPage

public void addRootPage(ConfigPage page)

removeRootPage

public void removeRootPage(ConfigPage page)

removeRootPageAt

public void removeRootPageAt(int index)

getCurrentPage

public ConfigPage getCurrentPage()

setCurrentPage

public void setCurrentPage(ConfigPage currentPage)

onOK

protected void onOK()

Description copied from class: AbstractDialog

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

Overrides:

onOK in class AbstractDialog

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.

verifyUserInput

protected boolean verifyUserInput()

Description copied from class: AbstractDialog

Called in order to perform input validation.

Overrides:

verifyUserInput in class AbstractDialog

Returns:

true if and only if the validation was successful.