Package de.xima.fc.workflow.mixin
Interface IBaseConditionClientHandlerNode<TData extends BaseConditionProps>
-
- Type Parameters:
TData
- Type of the node's properties model.
- All Superinterfaces:
ICustomParametersUpdateable
,IElementHandler<TData,WorkflowNode>
,IExecutionResultDescriptor
,INodeHandler<TData>
,IRefinedExecutionResultDescriptor<TData>
,IResourceBundleLocator
,IWorkflowElementTypeProviding
,IWorkflowNodeFlowAnalyzer<TData>
,IWorkflowNodeTypeProviding
- All Known Subinterfaces:
IPluginConditionNodeHandler<TData>
- All Known Implementing Classes:
APluginConditionNodeHandler
public interface IBaseConditionClientHandlerNode<TData extends BaseConditionProps> extends INodeHandler<TData>
Mixin for nodes that wish to register the default client-side condition handlers.- Since:
- 8.0.0
- Author:
- XIMA MEDIA GmbH
-
-
Field Summary
-
Fields inherited from interface de.xima.fc.interfaces.workflow.elements.IElementHandler
CURRENT_HANDLER_VERSION
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description int
getAlternateChildIndex()
default IResourceDescriptor
getCascadingStyleSheet(Locale locale, boolean devMode)
Retrieves the CSS resources required by elements of this kind, when this node is displayed in the workflow designer.default RegisterBaseConditionOptions
getConditionsOptions(Locale locale)
int
getConsequentChildIndex()
default IResourceDescriptor
getJavaScript(Locale locale, boolean devMode)
Retrieves the JavaScript resources required by elements of this kind.default boolean
isAlwaysCompletesAbruptly()
-
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, getPropertiesViewXhtml, getResourceBundle, getVersion, isAvailable, isHasUserVisibleName, readEntityReferences, readPlaceholders, validateGlobal, validateLocal, writeEntityReferences, writePlaceholders
-
Methods inherited from interface de.xima.fc.interfaces.workflow.execution.IExecutionResultDescriptor
getAlwaysValueDescriptor, getAttachmentValueDescriptor, getCurrentAttachmentValueDescriptor, getCurrentFileValueDescriptor, getCurrentValueDescriptor, getErrorValueDescriptor, getFileValueDescriptor, getSoftErrorValueDescriptor, getSuccessValueDescriptor
-
Methods inherited from interface de.xima.fc.interfaces.workflow.nodes.INodeHandler
execute, getLocalizedTypeName, getNodePrototypes, getPropertiesBeanClass, getRelatedNodeTypes, getSupportedControlTransferTypes, isCreateProtocolEntryAfterExecution, isCreateProtocolEntryAfterExecution, isReplacePlaceholderBeforeExecution
-
Methods inherited from interface de.xima.fc.interfaces.workflow.execution.IRefinedExecutionResultDescriptor
getAlwaysValueDescriptor, getAttachmentValueDescriptor, getCurrentAttachmentValueDescriptor, getCurrentFileValueDescriptor, getCurrentValueDescriptor, getErrorValueDescriptor, getFileValueDescriptor, getSoftErrorValueDescriptor, getSuccessValueDescriptor
-
Methods inherited from interface de.xima.fc.interfaces.workflow.IWorkflowElementTypeProviding
getType
-
Methods inherited from interface de.xima.fc.interfaces.workflow.analysis.IWorkflowNodeFlowAnalyzer
createFlowGraph
-
-
-
-
Method Detail
-
getAlternateChildIndex
int getAlternateChildIndex()
- Returns:
- Index of the child representing the alternate (else) part.
-
getCascadingStyleSheet
default IResourceDescriptor getCascadingStyleSheet(Locale locale, boolean devMode) throws URISyntaxException, MalformedURLException
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 interfaceIElementHandler<TData extends BaseConditionProps,WorkflowNode>
- Parameters:
locale
- The current language of the workflow designer. You can use this parameter to include localized message in the script.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
ornull
. - 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.MalformedURLException
- This exception is declared for convenience. You may want to create an URI from a fixed URL. In case this exception is thrown, the resource will not be loaded and an appropriate error is shown to the user.
-
getConditionsOptions
default RegisterBaseConditionOptions getConditionsOptions(Locale locale)
- Parameters:
locale
- Current locale.- Returns:
- The options for how the condition is displayed.
-
getConsequentChildIndex
int getConsequentChildIndex()
- Returns:
- Index of the child representing the consequent (if) part.
-
getJavaScript
default IResourceDescriptor getJavaScript(Locale locale, boolean devMode) throws URISyntaxException, MalformedURLException
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 toFlowchart.registerNode(nodeType: string, nodeHandler: Object): void; Flowchart.registerTrigger(triggerType: string, triggerHandler: Object): void;
See the TypeScript declaration file shipped in the NPM modulefc-workflow-flowchart
for an exact description of the node and trigger handler object. It also contains all available methods exposed on theFlowchart
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 interfaceIElementHandler<TData extends BaseConditionProps,WorkflowNode>
- Parameters:
locale
- The current language of the workflow designer. You can use this parameter to include localized message in the script.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
ornull
. - 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.MalformedURLException
- This exception is declared for convenience. You may want to create an URI from a fixed URL. In case this exception is thrown, the resource will not be loaded and an appropriate error is shown to the user.
-
isAlwaysCompletesAbruptly
default boolean isAlwaysCompletesAbruptly()
- Returns:
true
if this action always completes abruptly,false
otherwise. Used for the client-side flowchart view to hide outgoing flow lines.false
if this action either always completes normally (empty statement), always completes abruptly (return or throw statement), or some completes normally and sometimes abruptly (business action that may fail). Defaults tofalse
.
-
-