Class IndicatorDescriptor
java.lang.Object
com.motivewave.platform.sdk.common.desc.SettingDescriptor<IndicatorInfo>
com.motivewave.platform.sdk.common.desc.IndicatorDescriptor
Describes an indicator that is displayed on the axis.
-
Constructor Summary
ConstructorDescriptionIndicatorDescriptor
(String id, String label, Color bgColor, Color txtColor, boolean showLine, boolean enabled, boolean supportsDisable) ConstructorIndicatorDescriptor
(String id, String label, Color bgColor, Color txtColor, Font font, boolean showInd, Color lineColor, float lineWidth, float[] lineDash, boolean showLine, boolean enabled, boolean supportsDisable) ConstructorIndicatorDescriptor
(String id, String label, Color bgColor, Color txtColor, Font font, boolean showInd, Color lineColor, float lineWidth, float[] lineDash, boolean showLine, boolean showTag, String tag, boolean enabled, boolean supportsDisable) Constructor -
Method Summary
Modifier and TypeMethodDescriptionjavafx.scene.Node
createInputFX
(Settings settings, boolean readOnly) Creates the component that will accept the user input.Gets the default value for this setting.boolean
Indicates if this setting is used to affect the appearance of the of the study/strategyMethods inherited from class com.motivewave.platform.sdk.common.desc.SettingDescriptor
createInput, createTBInput, getDescription, getGridWidth, getHelpLink, getIconFactory, getId, getLabel, getName, isAllowUserDefaults, isEnabled, isShowLabel, isSupportsDisable, setAllowUserDefaults, setDefaultValue, setDescription, setEnabled, setGridWidth, setHelpLink, setIconFactory, setShowLabel, setSupportsDisable
-
Constructor Details
-
IndicatorDescriptor
public IndicatorDescriptor(String id, String label, Color bgColor, Color txtColor, boolean showLine, boolean enabled, boolean supportsDisable) Constructor- Parameters:
id
- name of this settinglabel
- label displayed to the userbgColor
- default background color for the indicatortxtColor
- default text color of the indicatorshowLine
- indicates if the line is shown by defaultenabled
- indicates if the indicator is enabled by defaultsupportsDisable
- indicates if the user can disable the indicator
-
IndicatorDescriptor
public IndicatorDescriptor(String id, String label, Color bgColor, Color txtColor, Font font, boolean showInd, Color lineColor, float lineWidth, float[] lineDash, boolean showLine, boolean enabled, boolean supportsDisable) Constructor- Parameters:
id
- name of this settinglabel
- label displayed to the userbgColor
- default background color for the indicatortxtColor
- default text color of the indicatorshowLine
- indicates if the line is shown by defaultenabled
- indicates if the indicator is enabled by defaultsupportsDisable
- indicates if the user can disable the indicator
-
IndicatorDescriptor
public IndicatorDescriptor(String id, String label, Color bgColor, Color txtColor, Font font, boolean showInd, Color lineColor, float lineWidth, float[] lineDash, boolean showLine, boolean showTag, String tag, boolean enabled, boolean supportsDisable) Constructor- Parameters:
id
- name of this settinglabel
- label displayed to the userbgColor
- default background color for the indicatortxtColor
- default text color of the indicatorshowLine
- indicates if the line is shown by defaultshowTag
- indicates if the tag is shown by defaulttag
- default tag textenabled
- indicates if the indicator is enabled by defaultsupportsDisable
- indicates if the user can disable the indicator
-
-
Method Details
-
getDefaultValue
Gets the default value for this setting.- Overrides:
getDefaultValue
in classSettingDescriptor<IndicatorInfo>
- Returns:
- default value for the setting
-
createInputFX
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 classSettingDescriptor<IndicatorInfo>
- Parameters:
settings
- settings for the studyreadOnly
- true if the component should not accept user input- Returns:
- component that will accept user input.
-
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 classSettingDescriptor<IndicatorInfo>
- Returns:
- true if this setting affects the appearance of the study/strategy
-
fromJson
- Overrides:
fromJson
in classSettingDescriptor<IndicatorInfo>
-