Package ch.ivyteam.ivy.process.extension.impl

Class AbstractProcessExtensionConfigurationEditor

java.lang.Object

ch.ivyteam.ivy.process.extension.impl.AbstractProcessExtensionConfigurationEditor

All Implemented Interfaces:

ICommonProcessExtensionConfigurationEditor, IProcessExtensionConfigurationEditorEx

public abstract class AbstractProcessExtensionConfigurationEditor
extends Object
implements IProcessExtensionConfigurationEditorEx

Abstract base class for process extension configuration editors

Since:

25.08.2009

API:

This is a public API.

Method Summary

Modifier and Type	Method	Description
protected void	clearBeanConfiguration()	Clears the bean configuration and all its properties.
protected Container	createEditorPanel()	Creates the editor panel. Clients may override this method.
protected void	createEditorPanelContent(Container editorPanel, IProcessExtensionConfigurationEditorEnvironment editorEnvironment)	Creates the editor panel content Clients are expected to override this method.
String	getBeanConfiguration()	Gets the bean configuration
protected String	getBeanConfigurationProperty(String name)	Gets a bean configuration property.
protected Set<String>	getBeanConfigurationPropertyNames()	Gets the names of the the bean configuration properties
String	getConfiguration()	Clients are not expected to override this method.
protected void	loadUiDataFromConfiguration()	Load the data of the configuration to the ui widgets. Clients are expected to override this method.
protected boolean	saveUiDataToConfiguration()	Save the data in the ui widgets to the configuration Clients are expected to override this method.
protected void	setBeanConfiguration(String configString)	Sets the given bean configuration to the given configuration string
protected String	setBeanConfigurationProperty(String name, String value)	Sets a bean configuration property.
boolean	shouldEditorFillAllSpace()	Defines whether the editor needs all layout space in the parent panel.

Methods inherited from interface ch.ivyteam.ivy.process.extension.ICommonProcessExtensionConfigurationEditor

getComposite

Method Detail

getConfiguration

public String getConfiguration()

Clients are not expected to override this method.

Specified by:

getConfiguration in interface ICommonProcessExtensionConfigurationEditor

Returns:

a description of a configuration. This description will be sent to the corresponding OuterProcessBean

See Also:

ICommonProcessExtensionConfigurationEditor.getConfiguration()

API:

This public API is available in Java.

getBeanConfiguration

public String getBeanConfiguration()

Gets the bean configuration

Returns:

bean configuration

API:

This public API is available in Java.

setBeanConfiguration

protected void setBeanConfiguration(String configString)

Sets the given bean configuration to the given configuration string

Parameters:

configString - the configuration to set.

API:

This public API is available in Java.

getBeanConfigurationProperty

protected String getBeanConfigurationProperty(String name)

Gets a bean configuration property.

This method only works correct if the configuration string contains a serialized Properties object.

Parameters:

name -

Returns:

the bean configuration property value. Maybe null.

API:

This public API is available in Java.

setBeanConfigurationProperty

protected String setBeanConfigurationProperty(String name,
                                              String value)

Sets a bean configuration property.

Parameters:

name - the name of the property to set

value - the new value of the bean configuration property

Returns:

the old bean configuration property value. Maybe null.

API:

This public API is available in Java.

clearBeanConfiguration

protected void clearBeanConfiguration()

Clears the bean configuration and all its properties.

Call this method before storing the bean configuration properties to flush outdated configurations. Typically called as first method in saveUiDataToConfiguration().

API:

This public API is available in Java.

getBeanConfigurationPropertyNames

protected Set<String> getBeanConfigurationPropertyNames()

Gets the names of the the bean configuration properties

Returns:

Set of property names. Never null. Maybe empty

API:

This public API is available in Java.

createEditorPanel

protected Container createEditorPanel()

Creates the editor panel.
Clients may override this method.

Returns:

the created editor panel

API:

This public API is available in Java.

createEditorPanelContent

protected void createEditorPanelContent(Container editorPanel,
                                        IProcessExtensionConfigurationEditorEnvironment editorEnvironment)

Creates the editor panel content
Clients are expected to override this method.

Parameters:

editorPanel - the editor panel

editorEnvironment - the editor environment

API:

This public API is available in Java.

loadUiDataFromConfiguration

protected void loadUiDataFromConfiguration()

Load the data of the configuration to the ui widgets.
Clients are expected to override this method.

API:

This public API is available in Java.

saveUiDataToConfiguration

protected boolean saveUiDataToConfiguration()

Save the data in the ui widgets to the configuration
Clients are expected to override this method.

Returns:

true if save was successful, otherwise false

API:

This public API is available in Java.

shouldEditorFillAllSpace

public boolean shouldEditorFillAllSpace()

Defines whether the editor needs all layout space in the parent panel.

Returns:

true if the editor needs all space

API:

This public API is available in Java.