Package de.xima.fc.workflow.taglib.iface
Interface IClientHandlerService
-
- All Known Implementing Classes:
ClientHandlerLocatorBean
public interface IClientHandlerService
Interface for an object that is able to locate the resources required by a flowchart element (node or trigger). An instance of this interface is usually passed to theFlowchartBase.getClientHandlerService()
attribute. This is used to load the client side resources dynamically as new node and trigger types are added to the flowchart.Note on JavaScript resources: The JavaScript is executed in a local function scope. The variable
Flowchart
is available in that scope and contains the public client-side API of the flowchart. The JavaScript must (synchronously!) register the appropriate node and trigger handlers viaFlowchart.registerNode(nodeKind, nodeHandler)
andFlowchart.registerTrigger(eventName, triggerHandler)
.Note on CSS resources: The CSS resources are added globally to the current document.
- Since:
- 7.0.0
- Author:
- XIMA MEDIA GmbH
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description FlowchartElementResource
getNodeResources(Set<String> nodeKindList)
Finds the JavaScript and CSS resources required by the given nodes.FlowchartElementResource
getTriggerResources(Set<String> eventNameList)
Finds the JavaScript and CSS resources required by the given triggers.
-
-
-
Method Detail
-
getNodeResources
FlowchartElementResource getNodeResources(Set<String> nodeKindList) throws IOException
Finds the JavaScript and CSS resources required by the given nodes. When more than one node is given, the individual JavaScript and CSS resources should be concatenated together.- Parameters:
nodeKindList
- List of nodes for which resources are required.- Returns:
- The JavaScript and CSS resources required by the given nodes.
- Throws:
IOException
- When the resources could not be retrieved.
-
getTriggerResources
FlowchartElementResource getTriggerResources(Set<String> eventNameList) throws IOException
Finds the JavaScript and CSS resources required by the given triggers. When more than one trigger is given, the individual JavaScript and CSS resources should be concatenated together.- Parameters:
eventNameList
- List of triggers for which resources are required.- Returns:
- The JavaScript and CSS resources required by the given triggers.
- Throws:
IOException
- When the resources could not be retrieved.
-
-