java.lang.Object
- de.xima.fc.workflow.taglib.model.FlowchartClientConfig

All Implemented Interfaces:

Serializable
```
public final class FlowchartClientConfig
extends Object
implements Serializable
```
Model class for the JSON object that is sent to the client (browser) during a full update of the flowchart. Instances of this class are meant to be serialized via JSON.

Since:

7.0.0

Author:

XIMA MEDIA GmbH

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor Description

FlowchartClientConfig(javax.faces.context.FacesContext context, Flowchart flowchart)

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static FlowchartClientConfig`	`empty()`
`String`	`getBackupCustomDataProvider()`
`String`	`getBackupCustomDataVersion()`
`long`	`getBackupIntervalDelay()`
`String`	`getBackupKey()`
`List<NodeEntry<Boolean>>`	`getCollapsedNodes()`
`List<NodeEntry<Boolean>>`	`getDeadNodes()`
`List<ElementPrototypeModel>`	`getDragSources()`
`String`	`getElementInfoPanelClientId()`
`List<ElementEntry<ElementMessageSetModel>>`	`getElementMessagesMap()`
`String`	`getElementPrototypeSelector()`
`com.alibaba.fastjson.JSONObject`	`getExternalState()`
`Map<UUID,Boolean>`	`getHiddenTasks()`
`InitialNodePrototypeClientModel`	`getInitialNodePrototypes()`
`String`	`getNodeAddPanelClientId()`
`List<ElementPrototypeModel>`	`getNodeAddSources()`
`List<ElementEntry<com.alibaba.fastjson.JSONObject>>`	`getParamsMap()`
`ProcessModel`	`getProcess()`
`ElementMessageSetModel`	`getProcessMessages()`
`String`	`getTaskAddPanelClientId()`
`List<ElementPrototypeModel>`	`getTaskAddSources()`
`List<TaskEntry<ElementMessageSetModel>>`	`getTaskMessagesMap()`
`boolean`	`isClearBackup()`
`boolean`	`isInitiallyPersisted()`
`boolean`	`isShowLaneSeparators()`
`boolean`	`isShowToolbar()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - FlowchartClientConfig
```
public FlowchartClientConfig(javax.faces.context.FacesContext context,
                             Flowchart flowchart)
                      throws FastJsonException
```
    Throws:
    
    FastJsonException
- Method Detail
  - getBackupCustomDataProvider
```
public String getBackupCustomDataProvider()
```
    Returns:
    
    Evaluates to a function that provides custom data fort the backup.
  - getBackupCustomDataVersion
```
public String getBackupCustomDataVersion()
```
    Returns:
    
    Version of the custom data in the backup.
  - getBackupIntervalDelay
```
public long getBackupIntervalDelay()
```
    Returns:
    
    A backup of the current model can be stored at a certain frequency in the local storage. This is the minimum interval at which backups are created, in seconds.
  - getBackupKey
```
@Nullable
public String getBackupKey()
```
    Returns:
    
    A backup of the current model can be stored at a certain frequency in the local storage. This is the key for the local storage.
  - getCollapsedNodes
```
public List<NodeEntry<Boolean>> getCollapsedNodes()
```
    Returns:
    
    List of nodes that should be collapsed in the flowchart.
  - getDeadNodes
```
@Nullable
public List<NodeEntry<Boolean>> getDeadNodes()
```
    Returns:
    
    List of workflow nodes that are considered dead code.
  - getDragSources
```
@Nullable
public List<ElementPrototypeModel> getDragSources()
```
    Returns:
    
    List of elements that should be made available for inserting new elements into the flowchart via dragging.
  - getElementInfoPanelClientId
```
@Nullable
public String getElementInfoPanelClientId()
```
  - getElementMessagesMap
```
@Nullable
public List<ElementEntry<ElementMessageSetModel>> getElementMessagesMap()
```
  - getElementPrototypeSelector
```
@Nullable
public String getElementPrototypeSelector()
```
  - getExternalState
```
@Nullable
public com.alibaba.fastjson.JSONObject getExternalState()
```
    Returns:
    
    External state that should be made available within the state of the preact flowchart app.
  - getHiddenTasks
```
@Nullable
public Map<UUID,Boolean> getHiddenTasks()
```
  - getInitialNodePrototypes
```
@Nullable
public InitialNodePrototypeClientModel getInitialNodePrototypes()
```
    Returns:
    
    Initial node that is set when a new task is added. If null, a new empty sequence node is used instead.
  - getNodeAddPanelClientId
```
@Nullable
public String getNodeAddPanelClientId()
```
    Returns:
    
    Client ID of the OverlayPanel component to use for adding new nodes.
  - getNodeAddSources
```
@Nullable
public List<ElementPrototypeModel> getNodeAddSources()
```
  - getParamsMap
```
@Nullable
public List<ElementEntry<com.alibaba.fastjson.JSONObject>> getParamsMap()
```
    Returns:
    
    Map entries of the mapping between the element keys and their custom properties JSON.
  - getProcess
```
@Nullable
public ProcessModel getProcess()
```
    Returns:
    
    Process model to be displayed and edited in the flowchart.
  - getProcessMessages
```
@Nullable
public ElementMessageSetModel getProcessMessages()
```
  - getTaskAddPanelClientId
```
@Nullable
public String getTaskAddPanelClientId()
```
    Returns:
    
    Client ID of the OverlayPanel component to use for adding new tasks.
  - getTaskAddSources
```
@Nullable
public List<ElementPrototypeModel> getTaskAddSources()
```
  - getTaskMessagesMap
```
@Nullable
public List<TaskEntry<ElementMessageSetModel>> getTaskMessagesMap()
```
  - isClearBackup
```
public boolean isClearBackup()
```
    Returns:
    
    Whether to clear the backup saved on the client. Usually set to true after the model was persisted.
  - isInitiallyPersisted
```
public boolean isInitiallyPersisted()
```
  - isShowLaneSeparators
```
public boolean isShowLaneSeparators()
```
    Returns:
    
    Whether to show the separator lines between the workflow tasks.
  - isShowToolbar
```
public boolean isShowToolbar()
```
    Returns:
    
    Whether to show the toolbar buttons to the top left of the flowchart that contains the redo, undo, reset etc. buttons.
  - empty
```
public static FlowchartClientConfig empty()
```
    Returns:
    
    A new client config with the defaults.

Class FlowchartClientConfig

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

FlowchartClientConfig

Method Detail

getBackupCustomDataProvider

getBackupCustomDataVersion

getBackupIntervalDelay

getBackupKey

getCollapsedNodes

getDeadNodes

getDragSources

getElementInfoPanelClientId

getElementMessagesMap

getElementPrototypeSelector

getExternalState

getHiddenTasks

getInitialNodePrototypes

getNodeAddPanelClientId

getNodeAddSources

getParamsMap

getProcess

getProcessMessages

getTaskAddPanelClientId

getTaskAddSources

getTaskMessagesMap

isClearBackup

isInitiallyPersisted

isShowLaneSeparators

isShowToolbar

empty