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

Class IndicatorDescriptor

java.lang.Object

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

com.motivewave.platform.sdk.common.desc.IndicatorDescriptor

public class IndicatorDescriptor
extends SettingDescriptor<IndicatorInfo>

Describes an indicator that is displayed on the axis.

Constructor Summary

Constructors

Constructor	Description
IndicatorDescriptor(String id, String label, Color bgColor, Color txtColor, boolean showLine, boolean enabled, boolean supportsDisable)	Constructor
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
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

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)
IndicatorInfo	getDefaultValue()	Gets the default value for this setting.
boolean	isDisplaySetting()	Indicates if this setting is used to affect the appearance of the of the study/strategy

Methods 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

Methods inherited from class java.lang.Object

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

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 setting

label - label displayed to the user

bgColor - default background color for the indicator

txtColor - default text color of the indicator

showLine - indicates if the line is shown by default

enabled - indicates if the indicator is enabled by default

supportsDisable - 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 setting

label - label displayed to the user

bgColor - default background color for the indicator

txtColor - default text color of the indicator

showLine - indicates if the line is shown by default

enabled - indicates if the indicator is enabled by default

supportsDisable - 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 setting

label - label displayed to the user

bgColor - default background color for the indicator

txtColor - default text color of the indicator

showLine - indicates if the line is shown by default

showTag - indicates if the tag is shown by default

tag - default tag text

enabled - indicates if the indicator is enabled by default

supportsDisable - indicates if the user can disable the indicator

Method Details

getDefaultValue

public IndicatorInfo getDefaultValue()

Gets the default value for this setting.

Overrides:

getDefaultValue in class SettingDescriptor<IndicatorInfo>

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

Parameters:

settings - settings for the study

readOnly - 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 class SettingDescriptor<IndicatorInfo>

Returns:

true if this setting affects the appearance of the study/strategy

fromJson

public Object fromJson(Object json)

Overrides:

fromJson in class SettingDescriptor<IndicatorInfo>