Package de.xima.fc.interfaces.workflow.elements

Interface IElementPrototypeDescriptor<TData>

Type Parameters:

TData - Type of the workflow element's properties model.

All Known Subinterfaces:

INodePrototypeDescriptor<TData>, ITriggerPrototypeDescriptor<TData>

All Known Implementing Classes:

ElementPrototypeDescriptor, NodePrototypeDescriptor, TriggerPrototypeDescriptor

public interface IElementPrototypeDescriptor<TData>

A prototype for a workflow element (node or trigger) that is shown in the drawer panel in the workflow designer. The user can move a prototype via drag & drop into the design area in the center to create a new workflow element.

Since:

7.0.0

Author:

XIMA MEDIA GmbH

Method Summary

Modifier and Type	Method	Description
IGuiIcon	getIcon()
String	getLabel()
IElementCategory	getMainCategory()
IElementPrototypeData<TData>	getPayload()
String	getSearchText()
String	getSortKey()	Returns the sort key for element prototypes that are in the same getSubCategory().
IElementCategory	getSubCategory()	(Optional)
String	getSubLabel()
Set<EElementPrototypeTag>	getTags()
String	getTitle()

Method Detail

getIcon

IGuiIcon getIcon()

Returns:

The icon for this element prototype, as shown in the UI.

getLabel

String getLabel()

Returns:

The localized name of the prototype item, as shown in the UI.

getMainCategory

IElementCategory getMainCategory()

Returns:

IElementCategory element's main category, which is used for grouping the elements.

getPayload

IElementPrototypeData<TData> getPayload()

Returns:

The data for this element prototype that is used for creating a new workflow element.

getSearchText

String getSearchText()

Returns:

A text that is never visible to the user, but only used when searching for an element, such as via a search input field in the UI.

getSortKey

String getSortKey()

Returns the sort key for element prototypes that are in the same getSubCategory(). Each prototype belongs to a category and is shown in that category (which may be a tab, accordion panel etc.) When there are multiple element prototypes in the same category, they are sorted according to their getSortKey().

Returns:

The key for sorting items in the same getSubCategory().

getSubCategory

IElementCategory getSubCategory()

(Optional)

Returns:

IElementCategory element's sub category, which is used for grouping the element within the given main group.

getSubLabel

String getSubLabel()

Returns:

The localized sub label of the prototype item. The sub label, when not empty, is shown below the label in a smaller font size and may provide additional details about the item.

getTags

Set<EElementPrototypeTag> getTags()

Returns:

List of tags for this prototype that may affect when this prototype is visible etc.

getTitle

String getTitle()

Returns:

The localized title for the prototype item. The title is the tooltip that shows up when the user hovers over the item with the mouse.