Package de.xima.fc.workflow.taglib.model
Class RegisterBaseConditionOptions
- java.lang.Object
-
- de.xima.fc.workflow.taglib.model.RegisterBaseConditionOptions
-
- All Implemented Interfaces:
Serializable
public final class RegisterBaseConditionOptions extends Object implements Serializable
Parameters that can be passed as the second parameter to the client side JavaScript methodFlowchart.registerBaseCondition
.- Since:
- 7.1.0
- Author:
- XIMA MEDIA GmbH
- See Also:
- Serialized Form
-
-
Constructor Summary
Constructors Constructor Description RegisterBaseConditionOptions()
-
Method Summary
-
-
-
Method Detail
-
getChildAlternate
@Nullable public Integer getChildAlternate()
- Returns:
- Index of the child representing the alternate (else) branch. This is set automatically, you do not have to set this explicitly.
-
getChildConsequent
@Nullable public Integer getChildConsequent()
- Returns:
- Index of the child representing the consequent (if) branch. This is set automatically, you do not have to set this explicitly.
-
getCollapsedInfoHeight
@Nullable public Integer getCollapsedInfoHeight()
- Returns:
- Height in pixels of the rectangle shown when the condition is
isCollapsible()
.
-
getCollapsedInfoWidth
@Nullable public Integer getCollapsedInfoWidth()
- Returns:
- Width in pixels of the rectangle shown when the condition is
isCollapsible()
.
-
getColor
@Nullable public ClientOpaqueColor getColor()
- Returns:
- Theme color of the condition, defaults to yellow.
-
getConditionLineCount
@Nullable public Integer getConditionLineCount()
- Returns:
- The number of lines that should be displayed for the
getConditionText()
.
-
getConditionText
@Nullable public String getConditionText()
- Returns:
- The text displayed inside the condition's rhombus.
-
getConditionTitle
@Nullable public String getConditionTitle()
- Returns:
- The title displayed when hovering over the condition's rhombus.
-
getLabelNo
@Nullable public String getLabelNo()
- Returns:
- The label for the else branch. When this is set,
#isEditable()
should befalse
, in which case this label is always displayed. Otherwise, when#isEditable()
istrue
, this is used only as the default value when the user did not enter a custom label yet.
-
getLabelYes
@Nullable public String getLabelYes()
- Returns:
- The label for the if branch. When this is set,
#isEditable()
should befalse
, in which case this label is always displayed. Otherwise, when#isEditable()
istrue
, this is used only as the default value when the user did not enter a custom label yet.
-
getRhombusHeight
@Nullable public Integer getRhombusHeight()
- Returns:
- Height in pixels of the condition's rhombus representing the condition.
-
getRhombusWidth
@Nullable public Integer getRhombusWidth()
- Returns:
- Width in pixels of the condition's rhombus representing the condition.
-
getStyleClass
@Nullable public String getStyleClass()
- Returns:
- Additional style class added to the main DOM element of the node.
-
isCollapsible
@Nullable public Boolean isCollapsible()
- Returns:
- Whether the if and else branches can be colllapsed.
-
isEditable
@Nullable public Boolean isEditable()
- Returns:
- Whether the if and else branch labels of the condition are editable. This data is stored in
BaseConditionProps.getLabelNo()
andBaseConditionProps.getLabelYes()
. Defaults totrue
.
-
isSelectable
@Nullable public Boolean isSelectable()
- Returns:
- Whether nodes of this type are selectable. When they are not, they will not be selected automatically. By
default, this checks whether
custom UI
is set.
-
setChildAlternate
public void setChildAlternate(Integer childAlternate)
- Parameters:
childAlternate
- Index of the child representing the alternate (else) branch. This is set automatically, you do not have to set this explicitly.
-
setChildConsequent
public void setChildConsequent(Integer childConsequent)
- Parameters:
childConsequent
- Index of the child representing the consequent (if) branch. This is set automatically, you do not have to set this explicitly.
-
setCollapsedInfoHeight
public void setCollapsedInfoHeight(Integer collapsedInfoHeight)
- Parameters:
collapsedInfoHeight
- Height in pixels of the rectangle shown when the condition isisCollapsible()
.
-
setCollapsedInfoWidth
public void setCollapsedInfoWidth(Integer collapsedInfoWidth)
- Parameters:
collapsedInfoWidth
- Width in pixels of the rectangle shown when the condition isisCollapsible()
.
-
setCollapsible
public void setCollapsible(Boolean collapsible)
- Parameters:
collapsible
- Whether the if and else branches can be colllapsed.
-
setColor
public void setColor(ClientOpaqueColor color)
- Parameters:
color
- Theme color of the condition, defaults to yellow.
-
setConditionLineCount
public void setConditionLineCount(Integer conditionLineCount)
- Parameters:
conditionLineCount
- The number of lines that should be displayed for thegetConditionText()
.
-
setConditionText
public void setConditionText(String conditionText)
- Parameters:
conditionText
- The text displayed inside the condition's rhombus.
-
setConditionTitle
public void setConditionTitle(String conditionTitle)
- Parameters:
conditionTitle
- The title displayed when hovering over the condition's rhombus.
-
setEditable
public void setEditable(Boolean editable)
- Parameters:
editable
- Whether the if and else branch labels of the condition are editable. This data is stored inBaseConditionProps.getLabelNo()
andBaseConditionProps.getLabelYes()
. Defaults totrue
.
-
setLabelNo
public void setLabelNo(String labelNo)
- Parameters:
labelNo
- The label for the else branch. When this is set,#isEditable()
should befalse
, in which case this label is always displayed. Otherwise, when#isEditable()
istrue
, this is used only as the default value when the user did not enter a custom label yet.
-
setLabelYes
public void setLabelYes(String labelYes)
- Parameters:
labelYes
- The label for the if branch. When this is set,#isEditable()
should befalse
, in which case this label is always displayed. Otherwise, when#isEditable()
istrue
, this is used only as the default value when the user did not enter a custom label yet.
-
setRhombusHeight
public void setRhombusHeight(Integer rhombusHeight)
- Parameters:
rhombusHeight
- Height in pixels of the condition's rhombus representing the condition.
-
setRhombusWidth
public void setRhombusWidth(Integer rhombusWidth)
- Parameters:
rhombusWidth
- Width in pixels of the condition's rhombus representing the condition.
-
setSelectable
public void setSelectable(Boolean selectable)
- Parameters:
selectable
- Whether nodes of this type are selectable. When they are not, they will not be selected automatically. By default, this checks whethercustom UI
is set.
-
setStyleClass
public void setStyleClass(String styleClass)
- Parameters:
styleClass
- Additional style class added to the main DOM element of the node.
-
-