Interface IBaseActionClientHandlerNode<TData extends BaseActionProps>

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:
IDefaultClientHandlerNode<TData>, IPluginActionNodeHandler<TData>
All Known Implementing Classes:
APluginActionNodeHandler
public interface IBaseActionClientHandlerNode<TData extends BaseActionProps> extends INodeHandler<TData>
Mixin for nodes that wish to register the default client-side action handlers.
Since:
8.0.0
Author:
XIMA MEDIA GmbH

  • Method Details

    • getActionViewType

      @Deprecated default EBaseActionViewType getActionViewType()
      Deprecated.
      Use or implement isCanCompleteNormally(), isCanCompleteAbruptlyByThrowing(), isCanCompleteAbruptlyByReturning().
      Returns:
      View type to use for rendering the node in the workflow flowchart. Defaults to EBaseActionViewType.STANDARD.

    • 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 interface IElementHandler<TData extends BaseActionProps, 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 an 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.
      MalformedURLException - This exception is declared for convenience. You may want to create a 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.

    • 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 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 extends BaseActionProps, 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 an 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.
      MalformedURLException - This exception is declared for convenience. You may want to create a 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

      @Deprecated default boolean isAlwaysCompletesAbruptly()
      Deprecated.
      Use or implement isCanCompleteNormally(), isCanCompleteAbruptlyByThrowing(), isCanCompleteAbruptlyByReturning().
      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 to false.

    • isCanCompleteAbruptlyByReturning

      default boolean isCanCompleteAbruptlyByReturning()
      Returns:
      true if it is possible that this action can issue a return statement when executed.
      Since:
      8.1.0

    • isCanCompleteAbruptlyByThrowing

      default boolean isCanCompleteAbruptlyByThrowing()
      Returns:
      true if it is possible that this action can throw an exception when executed. This should be true for most normal actions, as there is always the potential for business logic to fail. Can be false for actions that, for example, represent a simple return statement that cannot fail.
      Since:
      8.1.0

    • isCanCompleteNormally

      default boolean isCanCompleteNormally()
      Returns:
      true if it is possible that this action can complete normally when executed. This should be true for most normal actions. Can be false for actions that, for example, represent a throw or return statement, or an end point in the workflow.
      Since:
      8.1.0

    • isSelectable

      default boolean isSelectable()
      Returns:
      Whether nodes of this type are selectable. When they are not, they will not be selected automatically. By default, this checks whether IElementHandler.getPropertiesViewXhtml() is non-null.