Class Flowchart
- java.lang.Object
-
- javax.faces.component.UIComponent
-
- javax.faces.component.UIComponentBase
-
- de.xima.fc.workflow.taglib.component.flowchart.FlowchartBase
-
- de.xima.fc.workflow.taglib.component.flowchart.Flowchart
-
- All Implemented Interfaces:
IWidgetConfigProviding<FlowchartClientConfig>
,EventListener
,javax.faces.component.behavior.ClientBehaviorHolder
,javax.faces.component.PartialStateHolder
,javax.faces.component.StateHolder
,javax.faces.component.TransientStateHolder
,javax.faces.event.ComponentSystemEventListener
,javax.faces.event.FacesListener
,javax.faces.event.SystemEventListenerHolder
,org.primefaces.component.api.PrimeClientBehaviorHolder
,org.primefaces.component.api.Widget
public class Flowchart extends FlowchartBase implements javax.faces.event.ComponentSystemEventListener
Component handler for the flowchart component that can represent a syntax tree-like program as a diagram and also allows editing. The available triggers and nodes of the program are dynamically definable. A handler must be provided for each node and trigger. The handler controls how the nodes and triggers are rendered, and how the user can interact with them.- Since:
- 7.0.0
- Author:
- XIMA MEDIA GmbH
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class de.xima.fc.workflow.taglib.component.flowchart.FlowchartBase
FlowchartBase.PropertyKeys
-
-
Field Summary
Fields Modifier and Type Field Description static String
COMPONENT_TYPE
The component type of the flowchart.static String
SEQUENCE_NODE_KIND
The node kind for the built-in sequence node handler.-
Fields inherited from class de.xima.fc.workflow.taglib.component.flowchart.FlowchartBase
COMPONENT_FAMILY, DEFAULT_RENDERER
-
-
Constructor Summary
Constructors Constructor Description Flowchart()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
addSubmittedParams(ElementKey nodeKey, com.alibaba.fastjson.JSONObject params)
Only used by the renderer during theApplyRequestValuesPhase
.Map<String,Class<? extends javax.faces.event.BehaviorEvent>>
getBehaviorEventMapping()
FlowchartClientConfig
getDefaultWidgetConfig(javax.faces.context.FacesContext context)
Collection<String>
getEventNames()
FlowchartClientConfig
getWidgetConfig(javax.faces.context.FacesContext context)
IFastJsonConverter
getWidgetConfigConverter()
void
processEvent(javax.faces.event.ComponentSystemEvent event)
void
processUpdates(javax.faces.context.FacesContext context)
void
queueEvent(javax.faces.event.FacesEvent event)
void
setSubmittedFlowchartSelection(FlowchartSelection<?> selection)
Only used by the renderer during theApplyRequestValuesPhase
.void
setSubmittedHistoryInfo(HistoryInfo historyInfo)
Only used by the renderer during theApplyRequestValuesPhase
.void
setSubmittedPatches(List<JsonPatchUpdate> patches)
Only used by the renderer during theApplyRequestValuesPhase
.-
Methods inherited from class de.xima.fc.workflow.taglib.component.flowchart.FlowchartBase
getBackupCustomDataProvider, getBackupCustomDataVersion, getBackupDelaySeconds, getBackupKey, getClientHandlerService, getElementInfoPanel, getElementPrototypeDataSource, getElementPrototypeSelector, getFamily, getInitialNodePrototypes, getLinterService, getNodeAddPanel, getStyle, getStyleClass, getTaskAddPanel, getValue, getWidgetVar, isInitiallyPersisted, isShowToolbar, setBackupCustomDataProvider, setBackupCustomDataVersion, setBackupDelaySeconds, setBackupKey, setClientHandlerService, setElementInfoPanel, setElementPrototypeDataSource, setElementPrototypeSelector, setInitiallyPersisted, setInitialNodePrototypes, setLinterService, setNodeAddPanel, setShowToolbar, setStyle, setStyleClass, setTaskAddPanel, setValue, setWidgetVar
-
Methods inherited from class javax.faces.component.UIComponentBase
addClientBehavior, addFacesListener, broadcast, clearInitialState, decode, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientBehaviors, getClientId, getDefaultEventName, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getListenersForEventClass, getParent, getPassThroughAttributes, getRenderer, getRendererType, getRendersChildren, getValueBinding, invokeOnComponent, isRendered, isTransient, markInitialState, processDecodes, processRestoreState, processSaveState, processValidators, removeFacesListener, restoreAttachedState, restoreState, saveAttachedState, saveState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding, subscribeToEvent, unsubscribeFromEvent
-
Methods inherited from class javax.faces.component.UIComponent
encodeAll, getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getNamingContainer, getPassThroughAttributes, getResourceBundleMap, getStateHelper, getStateHelper, getTransientStateHelper, getTransientStateHelper, getValueExpression, initialStateMarked, isCompositeComponent, isInView, isVisitable, popComponentFromEL, pushComponentToEL, restoreTransientState, saveTransientState, setInView, setValueExpression, visitTree
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
-
-
-
Field Detail
-
COMPONENT_TYPE
public static final String COMPONENT_TYPE
The component type of the flowchart.- See Also:
- Constant Field Values
-
SEQUENCE_NODE_KIND
public static final String SEQUENCE_NODE_KIND
The node kind for the built-in sequence node handler.- See Also:
- Constant Field Values
-
-
Method Detail
-
addSubmittedParams
public void addSubmittedParams(ElementKey nodeKey, com.alibaba.fastjson.JSONObject params)
Only used by the renderer during theApplyRequestValuesPhase
. Stored temporarily and applies to the model duringUpdateModelValuesPhase
phase.- Parameters:
nodeKey
- Submitted node key.params
- Submitted params.
-
getBehaviorEventMapping
public Map<String,Class<? extends javax.faces.event.BehaviorEvent>> getBehaviorEventMapping()
- Specified by:
getBehaviorEventMapping
in interfaceorg.primefaces.component.api.PrimeClientBehaviorHolder
-
getDefaultWidgetConfig
public FlowchartClientConfig getDefaultWidgetConfig(javax.faces.context.FacesContext context)
- Specified by:
getDefaultWidgetConfig
in interfaceIWidgetConfigProviding<FlowchartClientConfig>
- Parameters:
context
- The current faces context.- Returns:
- The default widget configuration. Values in the
IWidgetConfigProviding.getWidgetConfig(FacesContext)
that are equal to the default values are not sent to the client.
-
getEventNames
public Collection<String> getEventNames()
- Specified by:
getEventNames
in interfacejavax.faces.component.behavior.ClientBehaviorHolder
- Overrides:
getEventNames
in classjavax.faces.component.UIComponentBase
-
getWidgetConfig
public FlowchartClientConfig getWidgetConfig(javax.faces.context.FacesContext context) throws FastJsonException
- Specified by:
getWidgetConfig
in interfaceIWidgetConfigProviding<FlowchartClientConfig>
- Parameters:
context
- The current faces context.- Returns:
- The widget configuration to send to the client.
- Throws:
FastJsonException
-
getWidgetConfigConverter
public IFastJsonConverter getWidgetConfigConverter()
- Specified by:
getWidgetConfigConverter
in interfaceIWidgetConfigProviding<FlowchartClientConfig>
- Returns:
- The converter for converting between the widget configuration and JSON.
-
processEvent
public void processEvent(javax.faces.event.ComponentSystemEvent event) throws javax.faces.event.AbortProcessingException
- Specified by:
processEvent
in interfacejavax.faces.event.ComponentSystemEventListener
- Overrides:
processEvent
in classjavax.faces.component.UIComponent
- Throws:
javax.faces.event.AbortProcessingException
-
processUpdates
public void processUpdates(javax.faces.context.FacesContext context)
- Overrides:
processUpdates
in classjavax.faces.component.UIComponentBase
-
queueEvent
public void queueEvent(javax.faces.event.FacesEvent event)
- Overrides:
queueEvent
in classjavax.faces.component.UIComponentBase
-
setSubmittedFlowchartSelection
public void setSubmittedFlowchartSelection(FlowchartSelection<?> selection)
Only used by the renderer during theApplyRequestValuesPhase
. Stored temporarily and applies to the model duringUpdateModelValuesPhase
phase.- Parameters:
selection
- Submitted selection
-
setSubmittedHistoryInfo
public void setSubmittedHistoryInfo(HistoryInfo historyInfo)
Only used by the renderer during theApplyRequestValuesPhase
. Stored temporarily and applies to the model duringUpdateModelValuesPhase
phase.- Parameters:
historyInfo
- Submitted history info.
-
setSubmittedPatches
public void setSubmittedPatches(List<JsonPatchUpdate> patches)
Only used by the renderer during theApplyRequestValuesPhase
. Stored temporarily and applies to the model duringUpdateModelValuesPhase
phase.- Parameters:
patches
- Submitted patches
-
-