Package ch.ivyteam.ivy.process.extension.ui

Class UiEditorExtension

java.lang.Object

ch.ivyteam.ivy.process.extension.impl.ConfigurableExtensionEditor

ch.ivyteam.ivy.process.extension.ui.UiEditorExtension

All Implemented Interfaces:

ICommonProcessExtensionConfigurationEditor, IProcessExtensionConfigurationEditorEx

public abstract class UiEditorExtension
extends ConfigurableExtensionEditor

A base class for Inscription-Editor extension contributors to Programmable elements. Its initUiFields(ExtensionUiBuilder) allows to build simple UIs. In addition, it provides APIs to bind the elements third-party configuration to UI fields.

Since:

9.4

API:

This is a public API.

Method Summary

Modifier and Type	Method	Description
abstract void	initUiFields(ExtensionUiBuilder ui)	Provides a facade, to build your own UI in no-time.

Methods inherited from class ch.ivyteam.ivy.process.extension.impl.ConfigurableExtensionEditor

clearBeanConfiguration, getBeanConfiguration, getBeanConfigurationProperty, getBeanConfigurationPropertyNames, getConfiguration, loadUiDataFromConfiguration, saveUiDataToConfiguration, setBeanConfiguration, setBeanConfigurationProperty

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

getComponent, getComposite

Method Details

initUiFields

public abstract void initUiFields(ExtensionUiBuilder ui)

Provides a facade, to build your own UI in no-time.

Example for a script-editor with a descriptive label and a large comment block:

 label = ui.label("Timeout in seconds").create();
 editor = ui.scriptField().requireType(Number.class).create();
 comment = ui.textField().multiline().create();
 

Parameters:

ui - the facade to build custom UI fields.

Since:

9.4

API:

This public API is available in Java.