java.lang.Object
- java.lang.Enum<EWorkflowElementCategory>
- - de.xima.fc.workflow.enums.EWorkflowElementCategory

All Implemented Interfaces:

INamedUiElement, IElementCategory, Serializable, Comparable<EWorkflowElementCategory>
```
public enum EWorkflowElementCategory
extends Enum<EWorkflowElementCategory>
implements INamedUiElement, IElementCategory
```
Enumeration of built-in categories for workflow nodes and triggers. These categories are used for the drawer panel to the left of the workflow designer. Workflow nodes and triggers are not restricted to these categories, they can also define their own categories.

Since:

7.0.0

Author:

XIMA MEDIA GmbH

Enum Constant Summary

Enum Constants
Enum Constant	Description
`DEPRECATED`
`MAIN_ACTION`
`MAIN_BUTTONS`
`MAIN_FLOW_CONTROL`
`MAIN_STATE_CHANGE`
`MAIN_TRIGGER`
`MISC`
`SUB_ACTION_CHANGE_STATE`
`SUB_ACTION_COMMON`
`SUB_ACTION_DATA_QUERIES`
`SUB_ACTION_END_POINT`
`SUB_ACTION_EXTERNAL_SERVICES`
`SUB_ACTION_FILES`
`SUB_ACTION_FORM_DATA`
`SUB_ACTION_FORM_RECORD`
`SUB_ACTION_SERVLET_RESPONSE`
`SUB_FLOW_CONTROL_CONDITION`
`SUB_FLOW_CONTROL_ERROR`
`SUB_FLOW_CONTROL_LOOP`
`SUB_TRIGGER_BUTTON_ADVANCED`
`SUB_TRIGGER_BUTTON_NOSAVE`
`SUB_TRIGGER_BUTTON_SAVE`
`SUB_TRIGGER_BUTTON_SUBMIT`
`SUB_TRIGGER_ERROR`
`SUB_TRIGGER_SYSTEM`
`SUB_TRIGGER_TIMED`

Field Summary
- Fields inherited from interface de.xima.fc.interfaces.INamedUiElement
  ATTR_DISPLAY_NAME

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`String`	`getCategoryId()`
`String`	`getDisplayName(Locale l)`	The display name of this element in the given locale.
`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.
`String`	`getSortKey()`	(Optional) If this method returns null or a blank string, the category will be sorted by its localized name (`IElementCategory.getName(Locale)`.
`static EWorkflowElementCategory`	`valueOf(String name)`	Returns the enum constant of this type with the specified name.
`static EWorkflowElementCategory[]`	`values()`	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Enum Constant Detail
  - MAIN_BUTTONS
```
public static final EWorkflowElementCategory MAIN_BUTTONS
```
  - MAIN_TRIGGER
```
public static final EWorkflowElementCategory MAIN_TRIGGER
```
  - MAIN_ACTION
```
public static final EWorkflowElementCategory MAIN_ACTION
```
  - MAIN_FLOW_CONTROL
```
public static final EWorkflowElementCategory MAIN_FLOW_CONTROL
```
  - MAIN_STATE_CHANGE
```
public static final EWorkflowElementCategory MAIN_STATE_CHANGE
```
  - SUB_TRIGGER_BUTTON_SUBMIT
```
public static final EWorkflowElementCategory SUB_TRIGGER_BUTTON_SUBMIT
```
  - SUB_TRIGGER_BUTTON_SAVE
```
public static final EWorkflowElementCategory SUB_TRIGGER_BUTTON_SAVE
```
  - SUB_TRIGGER_BUTTON_NOSAVE
```
public static final EWorkflowElementCategory SUB_TRIGGER_BUTTON_NOSAVE
```
  - SUB_TRIGGER_BUTTON_ADVANCED
```
public static final EWorkflowElementCategory SUB_TRIGGER_BUTTON_ADVANCED
```
  - SUB_TRIGGER_SYSTEM
```
public static final EWorkflowElementCategory SUB_TRIGGER_SYSTEM
```
  - SUB_TRIGGER_TIMED
```
public static final EWorkflowElementCategory SUB_TRIGGER_TIMED
```
  - SUB_TRIGGER_ERROR
```
public static final EWorkflowElementCategory SUB_TRIGGER_ERROR
```
  - SUB_ACTION_COMMON
```
public static final EWorkflowElementCategory SUB_ACTION_COMMON
```
  - SUB_ACTION_SERVLET_RESPONSE
```
public static final EWorkflowElementCategory SUB_ACTION_SERVLET_RESPONSE
```
  - SUB_ACTION_FILES
```
public static final EWorkflowElementCategory SUB_ACTION_FILES
```
  - SUB_ACTION_DATA_QUERIES
```
public static final EWorkflowElementCategory SUB_ACTION_DATA_QUERIES
```
  - SUB_ACTION_FORM_DATA
```
public static final EWorkflowElementCategory SUB_ACTION_FORM_DATA
```
  - SUB_ACTION_FORM_RECORD
```
public static final EWorkflowElementCategory SUB_ACTION_FORM_RECORD
```
  - SUB_ACTION_CHANGE_STATE
```
public static final EWorkflowElementCategory SUB_ACTION_CHANGE_STATE
```
  - SUB_ACTION_END_POINT
```
public static final EWorkflowElementCategory SUB_ACTION_END_POINT
```
  - SUB_ACTION_EXTERNAL_SERVICES
```
public static final EWorkflowElementCategory SUB_ACTION_EXTERNAL_SERVICES
```
  - SUB_FLOW_CONTROL_CONDITION
```
public static final EWorkflowElementCategory SUB_FLOW_CONTROL_CONDITION
```
  - SUB_FLOW_CONTROL_LOOP
```
public static final EWorkflowElementCategory SUB_FLOW_CONTROL_LOOP
```
  - SUB_FLOW_CONTROL_ERROR
```
public static final EWorkflowElementCategory SUB_FLOW_CONTROL_ERROR
```
  - MISC
```
public static final EWorkflowElementCategory MISC
```
  - DEPRECATED
```
public static final EWorkflowElementCategory DEPRECATED
```
- Method Detail
  - values
```
public static EWorkflowElementCategory[] values()
```
    Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
    for (EWorkflowElementCategory c : EWorkflowElementCategory.values()) System.out.println(c);
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static EWorkflowElementCategory valueOf(String name)
```
    Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
    
    Parameters:
    
    name - the name of the enum constant to be returned.
    
    Returns:
    
    the enum constant with the specified name
    
    Throws:
    
    IllegalArgumentException - if this enum type has no constant with the specified name
    
    NullPointerException - if the argument is null
  - getCategoryId
```
public String getCategoryId()
```
  - getDisplayName
```
public String getDisplayName(Locale l)
```
    Description copied from interface: INamedUiElement
    
    The display name of this element in the given locale.
    
    Specified by:
    
    getDisplayName in interface INamedUiElement
    
    Parameters:
    
    l - The locale to get the display name for.
    
    Returns:
    
    The display name of this element in the given locale.
  - getName
```
public String getName(Locale locale)
```
    Description copied from interface: IElementCategory
    
    The name needs to be provided as it is used as the identifier of the category.
    
    Specified by:
    
    getName in interface IElementCategory
    
    Parameters:
    
    locale - Locale for which to get the category name.
    
    Returns:
    
    The name of the category.
  - getSortKey
```
public String getSortKey()
```
    Description copied from interface: IElementCategory
    
    (Optional) If this method returns null or a blank string, the category will be sorted by its localized name (IElementCategory.getName(Locale).
    
    Specified by:
    
    getSortKey in interface IElementCategory
    
    Returns:
    
    The key by which the category is sorted.
  - getIcon
```
public IGuiIcon getIcon()
```
    Description copied from interface: IElementCategory
    
    (Optional) If this method returns null, a default icon will be used.
    
    Specified by:
    
    getIcon in interface IElementCategory
    
    Returns:
    
    IGuiIcon for displaying the category with an icon

Enum EWorkflowElementCategory

Enum Constant Summary

Field Summary

Fields inherited from interface de.xima.fc.interfaces.INamedUiElement

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

MAIN_BUTTONS

MAIN_TRIGGER

MAIN_ACTION

MAIN_FLOW_CONTROL

MAIN_STATE_CHANGE

SUB_TRIGGER_BUTTON_SUBMIT

SUB_TRIGGER_BUTTON_SAVE

SUB_TRIGGER_BUTTON_NOSAVE

SUB_TRIGGER_BUTTON_ADVANCED

SUB_TRIGGER_SYSTEM

SUB_TRIGGER_TIMED

SUB_TRIGGER_ERROR

SUB_ACTION_COMMON

SUB_ACTION_SERVLET_RESPONSE

SUB_ACTION_FILES

SUB_ACTION_DATA_QUERIES

SUB_ACTION_FORM_DATA

SUB_ACTION_FORM_RECORD

SUB_ACTION_CHANGE_STATE

SUB_ACTION_END_POINT

SUB_ACTION_EXTERNAL_SERVICES

SUB_FLOW_CONTROL_CONDITION

SUB_FLOW_CONTROL_LOOP

SUB_FLOW_CONTROL_ERROR

MISC

DEPRECATED

Method Detail

values

valueOf

getCategoryId

getDisplayName

getName

getSortKey

getIcon