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

Class ExtensionUiBuilder

java.lang.Object

ch.ivyteam.ivy.process.extension.ui.ExtensionUiBuilder

public class ExtensionUiBuilder
extends Object

The facade to create custom UI widgets for Third-Party Editors on Programmable elements.

Since:

9.4

See Also:

• UiEditorExtension.initUiFields(ExtensionUiBuilder)

API:

This is a public API.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ExtensionUiBuilder.LabelBuilder	A builder to setup UI labels.
static class	ExtensionUiBuilder.ScriptBuilder	A builder to setup Ivy Script editors.
static class	ExtensionUiBuilder.TextBuilder	A builder to setup an input text field.
static class	ExtensionUiBuilder.WidgetBuilder<T extends ExtensionUiBuilder.WidgetBuilder<?>>	Common base features for all widget builders

Method Summary

Modifier and Type	Method	Description
ExtensionUiBuilder.LabelBuilder	label(String text)	Creates a label widget for your inscription editor.
ExtensionUiBuilder.ScriptBuilder	scriptField()	Deprecated, for removal: This API element is subject to removal in a future version. use scriptField(String) instead.
ExtensionUiBuilder.ScriptBuilder	scriptField(String configKey)	Creates a new Ivy Script widget for your inscription editor.
ExtensionUiBuilder.TextBuilder	textField()	Deprecated, for removal: This API element is subject to removal in a future version. use scriptField(String) instead.
ExtensionUiBuilder.TextBuilder	textField(String configKey)	Creates a new text widget for your inscription editor.

Method Details

label

public ExtensionUiBuilder.LabelBuilder label(String text)

Creates a label widget for your inscription editor.

Examples

Simple label before an input field:
ui.label("maximum retry attempts").create();

Large help text:
help = ui.label("Lorem ipsum dolor...").multiline().create();

Parameters:

text - to be shown on the label to be created.

Returns:

a builder for this label widget. Don't forget to call create() when all your configs are set.

API:

This public API is available in Java.

scriptField

public ExtensionUiBuilder.ScriptBuilder scriptField(String configKey)

Creates a new Ivy Script widget for your inscription editor.

Examples

Ivy Script Expression field, expecting a Number as return value:
timeoutSeconds = ui.scriptField("timeout").requiredType(Number.class).create();

Ivy Script Code Block:
action = ui.scriptField("action").multiline().create();

Returns:

a builder for this scriptField widget. Don't forget to call create() when all your configs are set.

API:

This public API is available in Java.

scriptField

@Deprecated(forRemoval=true,
            since="11.2")
public ExtensionUiBuilder.ScriptBuilder scriptField()

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

use scriptField(String) instead.

API:

This public API is available in Java.

textField

public ExtensionUiBuilder.TextBuilder textField(String configKey)

Creates a new text widget for your inscription editor.

Examples

Single line text editor:
name = ui.textField("name").create();

Text block:
extension description = ui.textField("description").multiline().create();

Returns:

a builder for this textField widget. Don't forget to call create() when all your configs are set.

API:

This public API is available in Java.

textField

@Deprecated(forRemoval=true,
            since="11.2")
public ExtensionUiBuilder.TextBuilder textField()

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

use scriptField(String) instead.

API:

This public API is available in Java.