Package de.xima.fc.workflow.designer.registry

Interface IBuiltinResourcesHandler<TData,TElement extends IWorkflowElementEntity>

Type Parameters:

TData - Type of the element's properties model.

TElement - Type of the workflow node.

All Superinterfaces:

ICustomParametersUpdateable, IElementHandler<TData,TElement>, IResourceBundleLocator, IWorkflowElementTypeProviding

All Known Implementing Classes:

FcChangeFormAvailabilityHandler, FcChangeStateHandler, FcCompressAsZipHandler, FcCreateTextFileHandler, FcDecodeBase64Handler, FcEmailHandler, FcEmptyHandler, FcEncodeBase64Handler, FcExperimentHandler, FcExportToPersistenceHandler, FcExportToXmlHandler, FcFillPdfHandler, FcFillWordHandler, FcFormSubmitButtonHandler, FcHttpRequestHandler, FcImportFormValueFromXmlHandler, FcLogEntryHandler, FcManualHandler, FcMoveFormRecordToInboxHandler, FcMultipleConditionHandler, FcProcessHistoryPdfHandler, FcProcessLogPdfHandler, FcProvideResourceHandler, FcQualifiedFormSubmitButtonHandler, FcQueueTaskHandler, FcRedirectHandler, FcReturnFileHandler, FcSaveToFileSystemHandler, FcSaveToWebDavHandler, FcSequenceHandler, FcShowTemplateHandler, FcStateTimerHandler, FcSwitchCaseHandler, FcSwitchDefaultHandler, FcSwitchHandler, FcThrowExceptionHandler, FcTimePointHandler

public interface IBuiltinResourcesHandler<TData,TElement extends IWorkflowElementEntity>
extends IElementHandler<TData,TElement>

Adds default implementations for IElementHandler.getJavaScript(boolean) and IElementHandler.getCascadingStyleSheet(boolean). Uses the JavaScript from the fc-workflow-designer-gui module. Should not be used by workflow plugins.

Since:

7.0.0

Author:

XIMA MEDIA GmbH

Field Summary

Fields inherited from interface de.xima.fc.interfaces.workflow.elements.IElementHandler

CURRENT_HANDLER_VERSION

Method Summary

Modifier and Type	Method	Description
default IResourceDescriptor	getCascadingStyleSheet(boolean devMode)	Retrieves the CSS resources required by elements of this kind, when this node is displayed in the workflow designer.
default IResourceDescriptor	getJavaScript(boolean devMode)	Retrieves the JavaScript resources required by elements of this kind.

Methods inherited from interface de.xima.fc.interfaces.workflow.ICustomParametersUpdateable

updateCustomParams

Methods inherited from interface de.xima.fc.interfaces.workflow.elements.IElementHandler

extractDescription, extractName, extractSearchTerms, getCascadingStyleSheet, getDataModelClass, getDisplayLabel, getElementSummaryModel, getElementSummaryXhtml, getFastJsonConverter, getFilterCriteriaForEntities, getHelpPageLocation, getJavaScript, getLocalizedTypeName, getPropertiesBeanClass, getPropertiesViewXhtml, getResourceBundle, getVersion, isAvailable, isHasUserVisibleName, readEntityReferences, readPlaceholders, validateGlobal, validateLocal, writeEntityReferences, writePlaceholders

Methods inherited from interface de.xima.fc.interfaces.workflow.IWorkflowElementTypeProviding

getType

Method Detail

getCascadingStyleSheet

default IResourceDescriptor getCascadingStyleSheet(boolean devMode)
                                            throws URISyntaxException

Description copied from interface: IElementHandler

Retrieves the CSS resources required by elements of this kind, when this node is displayed in the workflow designer. The CSS is added globally to the document - make sure to use unique class names. We recommend you keep to the conventions as laid out by BEM.

Specified by:

getCascadingStyleSheet in interface IElementHandler<TData,TElement extends IWorkflowElementEntity>

Parameters:

devMode - true if the application is started in development mode. May be used to deliver uncompressed files with a inline source maps for development.

Returns:

The resource descriptor for the required CSS files. When no CSS resource is required, you may return either EmptyResourceDescriptor.INSTANCE or null.

Throws:

URISyntaxException - This exception is declared for convenience. Usually you want to create a new URI from a fixed path that is known to exist. In case this exception is thrown, the resource will not be loaded and an appropriate error is shown to the user.

getJavaScript

default IResourceDescriptor getJavaScript(boolean devMode)
                                   throws URISyntaxException

Description copied from interface: IElementHandler

Retrieves the JavaScript resources required by elements of this kind.

The JavaScript code is loaded automatically by the flowchart and executed in a local function scope. The variable Flowchart is made available in that scope and contains the public client-side API of the flowchart. The JavaScript must (synchronously!) register the appropriate element handler either via a call to

 Flowchart.registerNode(nodeType: string, nodeHandler: Object): void;
 Flowchart.registerTrigger(triggerType: string, triggerHandler: Object): void;
 

See the TypeScript declaration file shipped in the NPM module fc-workflow-flowchart for an exact description of the node and trigger handler object. It also contains all available methods exposed on the Flowchart object. We recommend you build your plugin against the declaration file to prevent errors when updating the formcycle version (removed or deprecated methods etc.)

Specified by:

getJavaScript in interface IElementHandler<TData,TElement extends IWorkflowElementEntity>

Parameters:

devMode - true if the application is started in development mode. May be used to deliver uncompressed files with a inline source maps for development.

Returns:

The resource descriptor for the required JavaScript files. When no CSS resource is required, you may return either EmptyResourceDescriptor.INSTANCE or null.

Throws:

URISyntaxException - This exception is declared for convenience. Usually you want to create a new URI from a fixed path that is known to exist. In case this exception is thrown, the resource will not be loaded and an appropriate error is shown to the user.