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

Class ColorDescriptor

java.lang.Object

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

com.motivewave.platform.sdk.common.desc.ColorDescriptor

public class ColorDescriptor
extends SettingDescriptor<ColorInfo>

Describes a color setting.

Constructor Summary

Constructors

Constructor	Description
ColorDescriptor(String name, String label, ColorInfo defaultValue, boolean supportsDisable)	Constructor.
ColorDescriptor(String name, String label, Color defaultValue)	Constructor.
ColorDescriptor(String name, String label, Color defaultValue, boolean enabled, boolean supportsDisable)	Constructor.

Method Summary

Modifier and Type	Method	Description
javafx.scene.Node	createInputFX(Settings settings, boolean readOnly)	Creates the color input selector
Object	fromJson(Object json)
ColorInfo	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

ColorDescriptor

public ColorDescriptor(String name,
 String label,
 Color defaultValue)

Constructor. Creates a color desccriptor with the name (key), label and default color

Parameters:

name - name of this setting (key)

label - label displayed to the user

defaultValue - default color value

ColorDescriptor

public ColorDescriptor(String name,
 String label,
 Color defaultValue,
 boolean enabled,
 boolean supportsDisable)

Constructor.

Parameters:

name - name of this setting (key)

label - label displayed to the user

defaultValue - default color value

enabled - default enabled state

supportsDisable - indicates if the user can disable this setting

ColorDescriptor

public ColorDescriptor(String name,
 String label,
 ColorInfo defaultValue,
 boolean supportsDisable)

Constructor.

Parameters:

name - name of this setting (key)

label - label displayed to the user

defaultValue - default color value

supportsDisable - indicates if the user can disable this setting

enabled - default enabled state

Method Details

getDefaultValue

public ColorInfo getDefaultValue()

Gets the default value for this setting.

Overrides:

getDefaultValue in class SettingDescriptor<ColorInfo>

Returns:

default value for the setting

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

Returns:

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

createInputFX

public javafx.scene.Node createInputFX(Settings settings,
 boolean readOnly)

Creates the color input selector

Specified by:

createInputFX in class SettingDescriptor<ColorInfo>

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