org.esa.beam.framework.ui.config
Interface ConfigPage

All Known Implementing Classes:

DefaultConfigPage, VisatPreferencesDialog.AppearancePage, VisatPreferencesDialog.BehaviorPage, VisatPreferencesDialog.DataIO, VisatPreferencesDialog.GeolocationDisplayPage, VisatPreferencesDialog.GraticuleOverlayPage, VisatPreferencesDialog.ImageDisplayPage, VisatPreferencesDialog.LayerPropertiesPage, VisatPreferencesDialog.LoggingPage, VisatPreferencesDialog.MaskOverlayPage, VisatPreferencesDialog.NoDataOverlayPage, VisatPreferencesDialog.ProductSettings, VisatPreferencesDialog.RepositoryConnectionConfigPage, VisatPreferencesDialog.RGBImageProfilePage

public interface ConfigPage

This interface represents a page within a configuration dialog.

Version:

$Revision$ $Date$

Author:

Norman Fomferra, Sabine Embacher

Method Summary

void	applyPage() Applies the modifications made on this page.
ParamGroup	getConfigParams()
PropertyMap	getConfigParamValues(PropertyMap propertyMap)
Icon	getIcon() Returns an icon for the page which is displayed in the config dialog's tree view.
String	getKey() Returns the key used to identify this page in a multiple page config dialog.
Component	getPageUI() Returns the UI component which lets a user edit this page.
ConfigPage[]	getSubPages() Returns an array of sub-pages this page has.
String	getTitle() Returns the human readable tile of the page which is displayed in the config dialog's tree view and title bar.
boolean	isModified() Checks whether or not this page has been modified.
void	onOK() Called when the config dialog is commited.
void	restorePage() Restores the modifications made on this page.
void	setConfigParamValues(PropertyMap propertyMap, ParamExceptionHandler errorHandler)
void	updatePageUI() Called when the config dialog is set to visible.
boolean	verifyUserInput() Verifies whether or not this page is valid or not.

Method Detail

getConfigParams

ParamGroup getConfigParams()

getConfigParamValues

PropertyMap getConfigParamValues(PropertyMap propertyMap)

setConfigParamValues

void setConfigParamValues(PropertyMap propertyMap,
                          ParamExceptionHandler errorHandler)

getKey

String getKey()

Returns the key used to identify this page in a multiple page config dialog.

Returns:

the key, must not be null and unique within the page.

getTitle

String getTitle()

Returns the human readable tile of the page which is displayed in the config dialog's tree view and title bar.

Returns:

the title, must not be null

getIcon

Icon getIcon()

Returns an icon for the page which is displayed in the config dialog's tree view.

Returns:

an icon or null if no icon is used

getSubPages

ConfigPage[] getSubPages()

Returns an array of sub-pages this page has. Subpages are displayed in the config dialog's tree view as children of this page.

Returns:

an array of sub-pages or null if no sub-pages are used

getPageUI

Component getPageUI()

Returns the UI component which lets a user edit this page. The component is shown on the right side o the config dialog if a user clicks on this page in the tree view.

Returns:

the UI component, must not be null

applyPage

void applyPage()

Applies the modifications made on this page.

restorePage

void restorePage()

Restores the modifications made on this page.

isModified

boolean isModified()

Checks whether or not this page has been modified.

onOK

void onOK()

Called when the config dialog is commited. All user inputs have already been verified.

verifyUserInput

boolean verifyUserInput()

Verifies whether or not this page is valid or not.

updatePageUI

void updatePageUI()

Called when the config dialog is set to visible.