Package de.xima.fc.workflow.taglib.model

Class RegisterBaseWhileLoopOptions

  • All Implemented Interfaces:
    Serializable
    public final class RegisterBaseWhileLoopOptions
extends Object
implements Serializable
    Parameters that can be passed as the second parameter to the client side JavaScript method Flowchart.registerBaseWhileLoop.
    Since:
    8.2.0
    Author:
    XIMA MEDIA GmbH
    See Also:
    Serialized Form

    • Constructor Detail

      • RegisterBaseWhileLoopOptions

        public RegisterBaseWhileLoopOptions()

    • Method Detail

      • getBackArrowHeight

        @Nullable
public Integer getBackArrowHeight()
        Returns:
        Height of the arrow pointing back to the loop.

      • getBackArrowWidth

        @Nullable
public Integer getBackArrowWidth()
        Returns:
        Width of the arrow pointing back to the loop.

      • getChildLoopBody

        @Nullable
public Integer getChildLoopBody()
        Returns:
        Index of the child representing the loop body. 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 while test is isCollapsible().

      • getCollapsedInfoWidth

        @Nullable
public Integer getCollapsedInfoWidth()
        Returns:
        Width in pixels of the rectangle shown when the while test is isCollapsible().

      • getColor

        @Nullable
public ClientOpaqueColor getColor()
        Returns:
        Theme color of the while test, defaults to yellow.

      • getLabelNo

        @Nullable
public String getLabelNo()
        Returns:
        The label for the else branch. When this is set, #isEditable() should be false, in which case this label is always displayed. Otherwise, when #isEditable() is true, 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 be false, in which case this label is always displayed. Otherwise, when #isEditable() is true, 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 while test's rhombus representing the while test.

      • getRhombusWidth

        @Nullable
public Integer getRhombusWidth()
        Returns:
        Width in pixels of the while test's rhombus representing the while test.

      • getStyleClass

        @Nullable
public String getStyleClass()
        Returns:
        Additional style class added to the main DOM element of the node.

      • getWhileTestLineCount

        @Nullable
public Integer getWhileTestLineCount()
        Returns:
        The number of lines that should be displayed for the getWhileTestText().

      • getWhileTestText

        @Nullable
public String getWhileTestText()
        Returns:
        The text displayed inside the while test's rhombus.

      • getWhileTestTitle

        @Nullable
public String getWhileTestTitle()
        Returns:
        The title displayed when hovering over the while test's rhombus.

      • isCollapsible

        @Nullable
public Boolean isCollapsible()
        Returns:
        Whether the if and else branches can be colllapsed.

      • 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.

      • isShowInfo

        @Nullable
public boolean isShowInfo()
        Returns:
        Whether to show the icon for opening the overlay with the node's info.

      • setBackArrowHeight

        public void setBackArrowHeight​(Integer backArrowHeight)
        Parameters:
        backArrowHeight - Height of the arrow pointing back to the loop.

      • setBackArrowWidth

        public void setBackArrowWidth​(Integer backArrowWidth)
        Parameters:
        backArrowWidth - Width of the arrow pointing back to the loop.

      • setChildLoopBody

        public void setChildLoopBody​(Integer childLoopBody)
        Parameters:
        childLoopBody - Index of the child representing the loop body. 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 while test is isCollapsible().

      • setCollapsedInfoWidth

        public void setCollapsedInfoWidth​(Integer collapsedInfoWidth)
        Parameters:
        collapsedInfoWidth - Width in pixels of the rectangle shown when the while test is isCollapsible().

      • 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 while test, defaults to yellow.

      • setLabelNo

        public void setLabelNo​(String labelNo)
        Parameters:
        labelNo - The label for the else branch. When this is set, #isEditable() should be false, in which case this label is always displayed. Otherwise, when #isEditable() is true, 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 be false, in which case this label is always displayed. Otherwise, when #isEditable() is true, 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 while test's rhombus representing the while test.

      • setRhombusWidth

        public void setRhombusWidth​(Integer rhombusWidth)
        Parameters:
        rhombusWidth - Width in pixels of the while test's rhombus representing the while test.

      • 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 whether custom UI is set.

      • setShowInfo

        public void setShowInfo​(boolean showInfo)
        Parameters:
        showInfo - Whether to show the icon for opening the overlay with the node's info.

      • setStyleClass

        public void setStyleClass​(String styleClass)
        Parameters:
        styleClass - Additional style class added to the main DOM element of the node.

      • setWhileTestLineCount

        public void setWhileTestLineCount​(Integer whileTestLineCount)
        Parameters:
        whileTestLineCount - The number of lines that should be displayed for the getWhileTestText().

      • setWhileTestText

        public void setWhileTestText​(String whileTestText)
        Parameters:
        whileTestText - The text displayed inside the while test's rhombus.

      • setWhileTestTitle

        public void setWhileTestTitle​(String whileTestTitle)
        Parameters:
        whileTestTitle - The title displayed when hovering over the while test's rhombus.