public class DefaultConfigPage extends Object implements ConfigPage
ConfigPage
interface.Constructor and Description |
---|
DefaultConfigPage() |
Modifier and Type | Method and Description |
---|---|
void |
addSubPage(ConfigPage subPage) |
void |
applyPage()
Applies the modifications made on this page.
|
Parameter |
getConfigParam(String paramName) |
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.
|
protected void |
initConfigParams(ParamGroup configParams) |
protected void |
initPageUI() |
boolean |
isConfigParamUIEnabled(String paramName) |
boolean |
isModified()
Checks whether or not this page has been modified.
|
void |
onOK()
Called when the config dialog is commited.
|
void |
removeSubPage(ConfigPage subPage) |
void |
restorePage()
Restores the modifications made on this page.
|
void |
setConfigParamUIEnabled(String paramName,
boolean enabled) |
void |
setConfigParamValues(PropertyMap propertyMap,
ParamExceptionHandler errorHandler) |
void |
setIcon(Icon icon) |
void |
setModified(boolean modified) |
void |
setPageUI(Component pageUI) |
void |
setTitle(String title) |
void |
updatePageUI()
Called when the config dialog is set to visible.
|
boolean |
verifyUserInput()
Verifies whether or not this page is valid or not.
|
protected void initConfigParams(ParamGroup configParams)
protected void initPageUI()
public ParamGroup getConfigParams()
getConfigParams
in interface ConfigPage
public PropertyMap getConfigParamValues(PropertyMap propertyMap)
getConfigParamValues
in interface ConfigPage
public void setConfigParamValues(PropertyMap propertyMap, ParamExceptionHandler errorHandler)
setConfigParamValues
in interface ConfigPage
public boolean isConfigParamUIEnabled(String paramName)
public void setConfigParamUIEnabled(String paramName, boolean enabled)
public String getKey()
ConfigPage
getKey
in interface ConfigPage
null
and unique within the page.public Icon getIcon()
ConfigPage
getIcon
in interface ConfigPage
null
if no icon is usedpublic void setIcon(Icon icon)
public String getTitle()
ConfigPage
getTitle
in interface ConfigPage
null
public void setTitle(String title)
public boolean isModified()
ConfigPage
isModified
in interface ConfigPage
public void setModified(boolean modified)
public Component getPageUI()
ConfigPage
getPageUI
in interface ConfigPage
null
public void setPageUI(Component pageUI)
public void addSubPage(ConfigPage subPage)
public void removeSubPage(ConfigPage subPage)
public ConfigPage[] getSubPages()
ConfigPage
getSubPages
in interface ConfigPage
null
if no sub-pages are usedpublic void applyPage()
ConfigPage
applyPage
in interface ConfigPage
public void restorePage()
ConfigPage
restorePage
in interface ConfigPage
public void onOK()
ConfigPage
onOK
in interface ConfigPage
public void updatePageUI()
ConfigPage
updatePageUI
in interface ConfigPage
public boolean verifyUserInput()
ConfigPage
verifyUserInput
in interface ConfigPage
Copyright © 2002–2014 Brockmann Consult GmbH. All rights reserved.