Class IntegerDescriptor
java.lang.Object
com.motivewave.platform.sdk.common.desc.SettingDescriptor<Integer>
com.motivewave.platform.sdk.common.desc.IntegerDescriptor
Describes an integer value that is used to configure a study/strategy.
-
Constructor Summary
ConstructorsConstructorDescriptionIntegerDescriptor(String name, String label, int defaultValue, int minValue, int maxValue, int step) Constructor. -
Method Summary
Modifier and TypeMethodDescriptionjavafx.scene.NodecreateControl(SettingsBase settings, boolean readOnly) Creates the component that will accept the user input.Gets the default value as an Integer.intGets the maximum value for the setting.intGets the minimum value for the setting.intgetStep()Gets the step increment value.Methods inherited from class com.motivewave.platform.sdk.common.desc.SettingDescriptor
createInput, createInputFX, createTBInput, createTBInput, getDescription, getGridWidth, getHelpLink, getIconFactory, getId, getLabel, getName, getPostLabel, isAllowUserDefaults, isDisplaySetting, isEnabled, isReadOnly, isShowLabel, isSupportsDisable, setAllowUserDefaults, setDefaultValue, setDescription, setEnabled, setGridWidth, setHelpLink, setIconFactory, setPostLabel, setReadOnly, setShowLabel, setSupportsDisable
-
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 userdefaultValue- default integer valueminValue- minimum integer valuemaxValue- maximum integer valuestep- step increment
-
-
Method Details
-
getDefaultValue
Gets the default value as an Integer.- Overrides:
getDefaultValuein classSettingDescriptor<Integer>- Returns:
- default value for the setting
-
createControl
Description copied from class:SettingDescriptorCreates the component that will accept the user input. This is called by the study framework.- Overrides:
createControlin classSettingDescriptor<Integer>- Parameters:
settings- settings for the studyreadOnly- 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. -
fromJson
- Overrides:
fromJsonin classSettingDescriptor<Integer>
-