public interface ConfigPage
Modifier and Type | Method and Description |
---|---|
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.
|
ParamGroup getConfigParams()
PropertyMap getConfigParamValues(PropertyMap propertyMap)
void setConfigParamValues(PropertyMap propertyMap, ParamExceptionHandler errorHandler)
String getKey()
null
and unique within the page.String getTitle()
null
Icon getIcon()
null
if no icon is usedConfigPage[] getSubPages()
null
if no sub-pages are usedComponent getPageUI()
null
void applyPage()
void restorePage()
boolean isModified()
void onOK()
boolean verifyUserInput()
void updatePageUI()
Copyright © 2002–2014 Brockmann Consult GmbH. All rights reserved.