Class IntegerDescriptor

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

public class IntegerDescriptor extends SettingDescriptor
Describes an integer value that is used to configure a study/strategy.
  • Constructor Details

    • IntegerDescriptor

      public IntegerDescriptor(String name, String label, int defaultValue, int minValue, int maxValue, int step)
      Constructor.
      Parameters:
      name - name of this setting (key)
      label - label displayed to the user
      defaultValue - default integer value
      minValue - minimum integer value
      maxValue - maximum integer value
      step - step increment
  • Method Details

    • getDefaultValue

      public Integer getDefaultValue()
      Gets the default value as an Integer.
      Overrides:
      getDefaultValue in class SettingDescriptor
      Returns:
      default value for the setting
    • 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.
    • getMinValue

      public int getMinValue()
      Gets the minimum value for the setting.
    • getMaxValue

      public int getMaxValue()
      Gets the maximum value for the setting.
    • getStep

      public int getStep()
      Gets the step increment value.