IElementCategory (formcycle: bom 8.0.4-RC.3 API)

All Superinterfaces:

Serializable

All Known Implementing Classes:

EWorkflowElementCategory
```
public interface IElementCategory
extends Serializable
```
Models a category for a workflow element, such as a node or trigger. The category classifies a workflow element and determines how it is shown in the drawer panel to the left of the workflow designer.

Since:

7.0.0

Author:

XIMA MEDIA GmbH

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method	Description
`default IGuiIcon`	`getIcon()`	(Optional) If this method returns null, a default icon will be used.
`String`	`getName(Locale locale)`	The name needs to be provided as it is used as the identifier of the category.
`default String`	`getSortKey()`	(Optional) If this method returns null or a blank string, the category will be sorted by its localized name (`getName(Locale)`.

- Method Detail
  - getName
```
String getName(Locale locale)
```
    The name needs to be provided as it is used as the identifier of the category.
    
    Parameters:
    
    locale - Locale for which to get the category name.
    
    Returns:
    
    The name of the category.
  - getSortKey
```
default String getSortKey()
```
    (Optional) If this method returns null or a blank string, the category will be sorted by its localized name (getName(Locale).
    
    Returns:
    
    The key by which the category is sorted.
  - getIcon
```
default IGuiIcon getIcon()
```
    (Optional) If this method returns null, a default icon will be used.
    
    Returns:
    
    IGuiIcon for displaying the category with an icon