Class ExtensionUiBuilder
java.lang.Object
ch.ivyteam.ivy.process.extension.ui.ExtensionUiBuilder
The facade to create custom UI widgets for Third-Party Editors on Programmable elements.
- Since:
- 9.4
- See Also:
- API:
- This is a public API.
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic class
A builder to setup UI labels.static class
A builder to setup Ivy Script editors.static class
A builder to setup an input text field.static class
Common base features for all widget builders -
Method Summary
Modifier and TypeMethodDescriptionCreates a label widget for your inscription editor.Creates a new Ivy Script widget for your inscription editor.Creates a new text widget for your inscription editor.
-
Method Details
-
label
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
Creates a new Ivy Script widget for your inscription editor.Examples
Ivy Script Expression field, expecting a Number as return value:
name = ui.scriptField().requiredType(Number.class).create();
Ivy Script Code Block:
action = ui.scriptField().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.
-
textField
Creates a new text widget for your inscription editor.Examples
Single line text editor:
name = ui.textField().create();
Text block:
extensiondescription = ui.textField().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.
-