Package com.motivewave.platform.sdk.common.desc

Class IntegerDescriptor

java.lang.Object

com.motivewave.platform.sdk.common.desc.SettingDescriptor<Integer>

com.motivewave.platform.sdk.common.desc.IntegerDescriptor

public class IntegerDescriptor
extends SettingDescriptor<Integer>

Describes an integer value that is used to configure a study/strategy.

Constructor Summary

Constructors

Constructor	Description
IntegerDescriptor(String name, String label, int defaultValue, int minValue, int maxValue, int step)	Constructor.

Method Summary

Modifier and Type	Method	Description
javafx.scene.Node	createInputFX(Settings settings, boolean readOnly)	Creates the component that will accept the user input.
Object	fromJson(Object json)
Integer	getDefaultValue()	Gets the default value as an Integer.
int	getMaxValue()	Gets the maximum value for the setting.
int	getMinValue()	Gets the minimum value for the setting.
int	getStep()	Gets the step increment value.

Methods inherited from class com.motivewave.platform.sdk.common.desc.SettingDescriptor

createInput, createTBInput, getDescription, getGridWidth, getHelpLink, getIconFactory, getId, getLabel, getName, isAllowUserDefaults, isDisplaySetting, isEnabled, isShowLabel, isSupportsDisable, setAllowUserDefaults, setDefaultValue, setDescription, setEnabled, setGridWidth, setHelpLink, setIconFactory, setShowLabel, setSupportsDisable

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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<Integer>

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<Integer>

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.

fromJson

public Object fromJson(Object json)

Overrides:

fromJson in class SettingDescriptor<Integer>