Interface UIComponent

All Known Subinterfaces:
RuleParameterCustomUi, UIContainer, UIContainerHorizontal, UIContainerVertical, UIImage, UILabel, UIRadioButtonPanel, UIRadioButtonPanelHorizontal, UIRadioButtonPanelVertical, UIRuleParameter

public interface UIComponent
Common interface for rule parameter UI components. All instances of UIComponents used in defining a UI must be unique.
Since:
9.10.2
  • Method Details

    • setEnabler

      void setEnabler(UIComponent enabler)
      Sets this UIComponent to follow the enabled state of enabler. The enabler is a component that is used to make another component enabled or disabled. For example, the enabler can be a rule parameter with a checkbox which makes another part of the UI enabled or disabled.
      Parameters:
      enabler - the UIComponent whose enabled state this UIComponent follows
      Since:
      9.10.2
    • getEnabler

      Optional<UIComponent> getEnabler()
      Returns the UIComponent whose enabled state this UIComponent is set to follow.
      Returns:
      the UIComponent whose enabled state this UIComponent is set to follow
      Since:
      9.10.2
    • setInvisibleWhenDisabled

      default void setInvisibleWhenDisabled(UIComponent invisibleWhenDisabled)
      Sets this UIComponent to follow the enabled state of InvisibleWhenDisabled. The InvisibleWhenDisabled is a component that is used to make another component visible or hidden. For example, the InvisibleWhenDisabled can be a rule parameter with a checkbox which makes another part of the UI visible or disappear.
      Parameters:
      invisibleWhenDisabled - the UIComponent whose visible state this UIComponent follows
      Since:
      25.12.0
    • getInvisibleWhenDisabled

      default Optional<UIComponent> getInvisibleWhenDisabled()
      Returns the UIComponent whose visible state this UIComponent is set to follow.
      Returns:
      the UIComponent whose visible state this UIComponent is set to follow
      Since:
      25.12.0