Class BaseMultipleCheckBean<TData extends IMultipleCheckProps>

java.lang.Object

de.xima.fc.gui.common.bean.ABooleanExpressionBean

de.xima.fc.workflow.designer.bean.nodes.BaseMultipleCheckBean<TData>

Type Parameters:

TData - Type of the node's property model.

All Implemented Interfaces:

IElementPropertiesBean<TData, WorkflowNode>, INodePropertiesBean<TData>, Serializable

Direct Known Subclasses:

FcDoUntilLoopBean, FcMultipleConditionBean, FcWhileLoopBean

public abstract class BaseMultipleCheckBean<TData extends IMultipleCheckProps>
extends ABooleanExpressionBean
implements INodePropertiesBean<TData>, Serializable

Bean for editing workflow nodes for which a complex condition need to be configured, such as an if-else condition or a while loop.

Since:

8.2.0

Author:

XIMA MEDIA GmbH

See Also:

• Serialized Form

Field Summary

Fields inherited from class ABooleanExpressionBean

localeBean

Constructor Summary

Constructors

Constructor	Description
BaseMultipleCheckBean()

Method Summary

Modifier and Type	Method	Description
void	addCondition()	Called when the user clicks on the add button to add a new condition.
protected Set<String>	getAllVariables()
void	prepareViewForElement(IElementPropInitParams<TData> params)	Called each time when the properties panel for a certain workflow element is loaded.
void	removeCondition(int index)	Called when the user clicks on the remove button on a condition.
void	updateCurrentProperties(IElementUpdateCurrentPropsParams<TData> params)	Called each time when the data of the selected node was edited externally.

Methods inherited from class ABooleanExpressionBean

completeCustomExpression, findNewVariableName, getOrderedCombinationTypes, getOrderedMatchConditions, lintCustomExpression

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface IElementPropertiesBean

updateCurrentTask

Methods inherited from interface INodePropertiesBean

retrieveCurrentProperties

Constructor Details

BaseMultipleCheckBean

public BaseMultipleCheckBean()

Method Details

addCondition

public void addCondition()

Called when the user clicks on the add button to add a new condition.

prepareViewForElement

public void prepareViewForElement(IElementPropInitParams<TData> params)
                           throws Exception

Description copied from interface: IElementPropertiesBean

Called each time when the properties panel for a certain workflow element is loaded. This method is passed the workflow element and the properties model, and should perform whatever initialization is necessary in order for the user to start editing the properties.

Specified by:

prepareViewForElement in interface IElementPropertiesBean<TData extends IMultipleCheckProps, WorkflowNode>

Parameters:

params - The current element to be edited and its properties. You may store a reference to these, modify them, and return them when IElementPropertiesBean.retrieveCurrentProperties(Object) is called.

Throws:

Exception - When the initialization failed. If an exception is thrown, the user is shown an error indicating that the properties cannot be edited.

removeCondition

public void removeCondition(int index)

Called when the user clicks on the remove button on a condition.

Parameters:

index - Index of the condition to remove.

updateCurrentProperties

public void updateCurrentProperties(IElementUpdateCurrentPropsParams<TData> params)
                             throws Exception

Description copied from interface: IElementPropertiesBean

Called each time when the data of the selected node was edited externally. Normally this does not happen. This only happens when the element handler returned a custom client handler (see getJavaScript) that invoked an external custom params update from the flowchart. If this bean stored the data in a field during IElementPropertiesBean.prepareViewForElement(IElementPropInitParams), it should update that field.

Specified by:

updateCurrentProperties in interface IElementPropertiesBean<TData extends IMultipleCheckProps, WorkflowNode>

Parameters:

params - Params with the old and new data.

Throws:

Exception - When the data could not be updated. This exception is caught and an error message is shown to the user.

getAllVariables

protected Set<String> getAllVariables()

Specified by:

getAllVariables in class ABooleanExpressionBean