Class BarDescriptor

java.lang.Object
com.motivewave.platform.sdk.common.desc.SettingDescriptor
com.motivewave.platform.sdk.common.desc.BarDescriptor

public class BarDescriptor extends SettingDescriptor
Describes a vertical bar.
  • Constructor Details

    • BarDescriptor

      public BarDescriptor(String name, String label, Color color, boolean enabled, boolean supportsDisable)
      Constructor.
      Parameters:
      name - name of this setting (key)
      label - label displayed to the user
      color - default color of the bar
      enabled - default enabled state
      supportsDisable - indicates if the user can disable this setting
    • BarDescriptor

      public BarDescriptor(String name, String label, Color color, Integer fixedWidth, boolean enabled, boolean supportsDisable)
      Constructor.
      Parameters:
      name - name of this setting (key)
      label - label displayed to the user
      color - default color of the bar
      fixedWidth - fixed width of the bar (null for dynamic size)
      enabled - default enabled state
      supportsDisable - indicates if the user can disable this setting
  • Method Details

    • getDefaultValue

      public BarInfo getDefaultValue()
      Gets the default value as a BarInfo.
      Overrides:
      getDefaultValue in class SettingDescriptor
      Returns:
      default value for the setting
    • isDisplaySetting

      public boolean isDisplaySetting()
      Description copied from class: SettingDescriptor
      Indicates if this setting is used to affect the appearance of the of the study/strategy
      Overrides:
      isDisplaySetting in class SettingDescriptor
      Returns:
      true if this setting affects the appearance of the study/strategy
    • createInputFX

      public javafx.scene.Node createInputFX(Settings settings, boolean readOnly)
      Description copied from class: SettingDescriptor
      Creates the component that will accept the user input. This is called by the study framework.
      Specified by:
      createInputFX in class SettingDescriptor
      Parameters:
      settings - settings for the study
      readOnly - true if the component should not accept user input
      Returns:
      component that will accept user input.
    • getColor

      public Color getColor()
      Gets the default color of the bar.
    • getFixedWidth

      public Integer getFixedWidth()
      Gets the fixed width of the bar.