Interface IBpmnProcessElementUi
public interface IBpmnProcessElementUi
Extension point interface to provide the user interface part of an 3rd party Ivy process element.
3rd party providers can implement this interface to provide user interface representation of their own process elements
- Since:
- 9.2.0
- API:
- This is a public API.
-
Method Summary
Modifier and TypeMethodDescriptiondefault String
getDescription
(Locale locale) Returns a description for this process element with given locale.default String
Specifies the URL path to the help page of this inscription editor.getName()
Returns the name of the 3rd party process element.default String
Returns the name for this process element with given locale.default String
getShortName
(Locale locale) Returns the short name for this process element with given locale.default boolean
Specifies if the default tab 'PI
' should be displayed or not.
-
Method Details
-
getName
String getName()Returns the name of the 3rd party process element.The name must match the one of the execution process element
IBpmnProcessElement.getName()
- Returns:
- A name that matches a registered executable element
IBpmnProcessElement.getName()
- Since:
- 9.2.0
- API:
- This public API is available in Java.
-
getShortName
Returns the short name for this process element with given locale.Implementing this method is optional. If not implemented this method will return the value of
getName(Locale)
.- Parameters:
locale
- The locale in which the short name should be returned.- Returns:
- Short name of the process element or
null
. - Since:
- 9.2.0
- API:
- This public API is available in Java.
-
getName
Returns the name for this process element with given locale.Implementing this method is optional. If not implemented this method will return the value of
getName()
.- Parameters:
locale
- The locale in which the name should be returned.- Returns:
- Name of the process element.
- Since:
- 9.2.0
- API:
- This public API is available in Java.
-
getDescription
Returns a description for this process element with given locale.Implementing this method is optional. If not implemented this method will return
null
.- Parameters:
locale
- The locale in which the description should be returned.- Returns:
- Description of the process element or
null
. - Since:
- 9.2.0
- API:
- This public API is available in Java.
-
showDefaultTabs
default boolean showDefaultTabs()Specifies if the default tab 'PI
' should be displayed or not. Iftrue
the custom editor tabs defined ingetEditorTabs(ElementConfigurator)
are not displayed.Implementing this method is optional. If not implemented this method will return
false
.- Returns:
true
if the 'PI
' tab to configure timeout behavior should be displayed.- Since:
- 9.2.0
- API:
- This public API is available in Java.
-
getHelpPath
Specifies the URL path to the help page of this inscription editor.- Returns:
- The URL help path of this editor or null if undefined
- Since:
- 9.2.0
- API:
- This public API is available in Java.
-