Package ch.ivyteam.ivy.process.extension

Interface ICommonProcessExtensionConfigurationEditor

All Known Subinterfaces:

IProcessExtensionConfigurationEditorEx

All Known Implementing Classes:

ConfigurableExtensionEditor, UiEditorExtension

public interface ICommonProcessExtensionConfigurationEditor

Do not use this interface directly use IProcessExtensionConfigurationEditorEx instead.

API:

This is a public API.

Method Summary

Modifier and Type	Method	Description
boolean	acceptInput()	Deprecated, for removal: This API element is subject to removal in a future version. directly bind your widgets to a config value via ExtensionUiBuilder.scriptField(String) or ExtensionUiBuilder.textField(String)
default <T> T	getComposite(T parent)	Deprecated. use UiEditorExtension.initUiFields(ch.ivyteam.ivy.process.extension.ui.ExtensionUiBuilder) instead.
String	getConfiguration()	Deprecated, for removal: This API element is subject to removal in a future version. directly bind your widgets to a config value via ExtensionUiBuilder.scriptField(String) or ExtensionUiBuilder.textField(String)
void	setConfiguration(String configString)	Deprecated, for removal: This API element is subject to removal in a future version. directly bind your widgets to a config value via ExtensionUiBuilder.scriptField(String) or ExtensionUiBuilder.textField(String)

Method Details

getComposite

@Deprecated
default <T> T getComposite(T parent)

Deprecated.

use UiEditorExtension.initUiFields(ch.ivyteam.ivy.process.extension.ui.ExtensionUiBuilder) instead.

Parameters:

parent - org.eclipse.swt.widgets.Composite

Returns:

an editor composite implemented with SWT.

API:

This public API is available in Java.

setConfiguration

@Deprecated(forRemoval=true,
            since="11.2")
void setConfiguration(String configString)

Deprecated, for removal: This API element is subject to removal in a future version.

directly bind your widgets to a config value via ExtensionUiBuilder.scriptField(String) or ExtensionUiBuilder.textField(String)

Initialize the editor with an older configuration

Parameters:

configString -

API:

This public API is available in Java.

getConfiguration

@Deprecated(forRemoval=true,
            since="11.2")
String getConfiguration()

Deprecated, for removal: This API element is subject to removal in a future version.

directly bind your widgets to a config value via ExtensionUiBuilder.scriptField(String) or ExtensionUiBuilder.textField(String)

Returns:

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

API:

This public API is available in Java.

acceptInput

@Deprecated(forRemoval=true,
            since="11.2")
boolean acceptInput()

Deprecated, for removal: This API element is subject to removal in a future version.

directly bind your widgets to a config value via ExtensionUiBuilder.scriptField(String) or ExtensionUiBuilder.textField(String)

This method is called if the user pressed the OK button of the dialog containing this editor. The dialog is closed and the new configuration is used only if this methode return true

Returns:

boolean if the input is accepted by the editor (e.g. correct filled textfield)

API:

This public API is available in Java.