Package de.xima.fc.workflow.taglib.model
Class FlowchartUpdateClientConfig
- java.lang.Object
-
- de.xima.fc.workflow.taglib.model.FlowchartUpdateClientConfig
-
- All Implemented Interfaces:
Serializable
public final class FlowchartUpdateClientConfig extends Object implements Serializable
Model class for the JSON object that is sent to the client (browser) during a partial update of the flowchart. Instances of this class are meant to be serialized viaJSON
.- Since:
- 7.0.0
- Author:
- XIMA MEDIA GmbH
- See Also:
- Serialized Form
-
-
Constructor Summary
Constructors Constructor Description FlowchartUpdateClientConfig(javax.faces.context.FacesContext context, Flowchart flowchart)
Creates the client update config from the data of the given flowchart model.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description List<NodeEntry<Boolean>>
getCollapsedNodesUpdates()
List<NodeEntry<Boolean>>
getDeadNodeUpdates()
List<ElementPrototypeModel>
getDragSources()
List<ElementEntry<ElementMessageSetModel>>
getElementMessageUpdates()
com.alibaba.fastjson.JSONObject
getExternalState()
Map<UUID,Boolean>
getHiddenTasksUpdates()
List<ElementPrototypeModel>
getNodeAddSources()
List<ElementEntry<com.alibaba.fastjson.JSONObject>>
getParamsUpdates()
ElementMessageSetModel
getProcessMessageUpdates()
FlowchartSelection<?>
getSelectionUpdate()
Boolean
getShowLaneSeparatorsUpdate()
List<ElementPrototypeModel>
getTaskAddSources()
List<TaskEntry<ElementMessageSetModel>>
getTaskMessageUpdates()
boolean
isClearBackup()
-
-
-
Constructor Detail
-
FlowchartUpdateClientConfig
public FlowchartUpdateClientConfig(javax.faces.context.FacesContext context, Flowchart flowchart)
Creates the client update config from the data of the given flowchart model.- Parameters:
flowchart
- The flowchart model for which to create the client update config.context
- Current faces context.
-
-
Method Detail
-
getCollapsedNodesUpdates
@Nullable public List<NodeEntry<Boolean>> getCollapsedNodesUpdates()
- Returns:
- Nodes which should be collapsed or expanded.
-
getDeadNodeUpdates
@Nullable public List<NodeEntry<Boolean>> getDeadNodeUpdates()
- Returns:
- Nodes for which their dead node status has changed.
-
getDragSources
@Nullable public List<ElementPrototypeModel> getDragSources()
- Returns:
- Sources that can be used for dragging element into the flowchart.
-
getElementMessageUpdates
@Nullable public List<ElementEntry<ElementMessageSetModel>> getElementMessageUpdates()
- Returns:
- A list of validation messages to add or remove from the flowchart elements (node or triggers).
-
getExternalState
@Nullable public com.alibaba.fastjson.JSONObject getExternalState()
- Returns:
- External state that should be made available within the flowchart react application.
null
when the state has not changed.
-
getHiddenTasksUpdates
@Nullable public Map<UUID,Boolean> getHiddenTasksUpdates()
- Returns:
- Tasks to hide or unhide.
-
getNodeAddSources
@Nullable public List<ElementPrototypeModel> getNodeAddSources()
-
getParamsUpdates
@Nullable public List<ElementEntry<com.alibaba.fastjson.JSONObject>> getParamsUpdates()
- Returns:
- A list of custom parameters to set on the flowchart elements.
-
getProcessMessageUpdates
@Nullable public ElementMessageSetModel getProcessMessageUpdates()
- Returns:
- A list of validation messages to add or remove from the flowchart process.
-
getSelectionUpdate
@Nullable public FlowchartSelection<?> getSelectionUpdate()
-
getShowLaneSeparatorsUpdate
@Nullable public Boolean getShowLaneSeparatorsUpdate()
- Returns:
- Whether the lane separators between lines should be shown.
-
getTaskAddSources
@Nullable public List<ElementPrototypeModel> getTaskAddSources()
-
getTaskMessageUpdates
@Nullable public List<TaskEntry<ElementMessageSetModel>> getTaskMessageUpdates()
- Returns:
- A list of validation messages to add or remove from the flowchart tasks.
-
isClearBackup
public boolean isClearBackup()
- Returns:
- Whether to clear the backup saved on the client. Usually set to
true
after the model was persisted.
-
-