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

Class ShadeDescriptor

java.lang.Object

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

com.motivewave.platform.sdk.common.desc.ShadeDescriptor

public class ShadeDescriptor
extends SettingDescriptor<ShadeInfo>

Describes information to shade an area between two lines/paths.

Constructor Summary

Constructors

Constructor	Description
ShadeDescriptor(String name, String label, String[][] linePairs, Color color, boolean enabled, boolean supportsDisable)	Constructor
ShadeDescriptor(String name, String label, String lineKey1, double value, Enums.ShadeType type, Color color)	Constructor.
ShadeDescriptor(String name, String label, String lineKey1, double value, Enums.ShadeType type, Color color, boolean enabled, boolean supportsDisable)	Constructor
ShadeDescriptor(String name, String label, String lineKey1, String lineKey2, Enums.ShadeType type, Color color)	Constructor.
ShadeDescriptor(String name, String label, String lineKey1, String lineKey2, Enums.ShadeType type, Color color, 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)
Color	getColor()	Gets the default color for the shade.
ShadeInfo	getDefaultValue()	Gets the default value for this setting.
String	getLineKey1()	Gets the setting key for the first line.
String	getLineKey2()	Gets the setting key for the first line.
String[][]	getLinePairs()	Gets the line pairs.
Enums.ShadeType	getShadeType()	Gets the type of shade to apply.
double	getValue()	Gets the absolute value to shade above or below.
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

ShadeDescriptor

public ShadeDescriptor(String name,
 String label,
 String lineKey1,
 String lineKey2,
 Enums.ShadeType type,
 Color color)

Constructor.

Parameters:

name -

label -

lineKey1 -

lineKey2 -

type -

color -

ShadeDescriptor

public ShadeDescriptor(String name,
 String label,
 String lineKey1,
 double value,
 Enums.ShadeType type,
 Color color)

Constructor.

Parameters:

name -

label -

lineKey1 -

value -

type -

color -

ShadeDescriptor

public ShadeDescriptor(String name,
 String label,
 String lineKey1,
 String lineKey2,
 Enums.ShadeType type,
 Color color,
 boolean enabled,
 boolean supportsDisable)

Constructor

Parameters:

name -

label -

lineKey1 -

lineKey2 -

type -

color -

enabled -

supportsDisable -

ShadeDescriptor

public ShadeDescriptor(String name,
 String label,
 String[][] linePairs,
 Color color,
 boolean enabled,
 boolean supportsDisable)

Constructor

Parameters:

name - identifier

label - display label for the shade

linePairs - set of line pairs to apply the shade (filled between the pairs)

color - shade color

enabled - true if this shade is enabled by default

supportsDisable - true if the user can disable the shade

ShadeDescriptor

public ShadeDescriptor(String name,
 String label,
 String lineKey1,
 double value,
 Enums.ShadeType type,
 Color color,
 boolean enabled,
 boolean supportsDisable)

Constructor

Parameters:

name -

label -

lineKey1 -

value -

type -

color -

enabled -

supportsDisable -

Method Details

getDefaultValue

public ShadeInfo getDefaultValue()

Gets the default value for this setting.

Overrides:

getDefaultValue in class SettingDescriptor<ShadeInfo>

Returns:

default value for the setting

getColor

public Color getColor()

Gets the default color for the shade.

getLineKey1

public String getLineKey1()

Gets the setting key for the first line.

getLineKey2

public String getLineKey2()

Gets the setting key for the first line.

getLinePairs

public String[][] getLinePairs()

Gets the line pairs.

getShadeType

public Enums.ShadeType getShadeType()

Gets the type of shade to apply.

getValue

public double getValue()

Gets the absolute value to shade above or below.

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

Returns:

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

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

Parameters:

settings - settings for the study

readOnly - true if the component should not accept user input

Returns:

component that will accept user input.

fromJson

public Object fromJson(Object json)

Overrides:

fromJson in class SettingDescriptor<ShadeInfo>