Class ColorDescriptor
java.lang.Object
com.motivewave.platform.sdk.common.desc.SettingDescriptor<ColorInfo>
com.motivewave.platform.sdk.common.desc.ColorDescriptor
Describes a color setting.
-
Constructor Summary
ConstructorsConstructorDescriptionColorDescriptor
(String name, String label, ColorInfo defaultValue) Constructor.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 TypeMethodDescriptionjavafx.scene.Node
createControl
(SettingsBase settings, boolean readOnly) Creates the color input selectorGets 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, createInputFX, createTBInput, createTBInput, getDescription, getGridWidth, getHelpLink, getIconFactory, getId, getLabel, getName, getPostLabel, isAllowUserDefaults, isEnabled, isReadOnly, isShowLabel, isSupportsDisable, setAllowUserDefaults, setDefaultValue, setDescription, setEnabled, setGridWidth, setHelpLink, setIconFactory, setPostLabel, setReadOnly, setShowLabel, setSupportsDisable
-
Constructor Details
-
ColorDescriptor
-
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 userdefaultValue
- default color valueenabled
- default enabled statesupportsDisable
- indicates if the user can disable this setting
-
ColorDescriptor
-
ColorDescriptor
Constructor.- Parameters:
name
- name of this setting (key)label
- label displayed to the userdefaultValue
- default color valuesupportsDisable
- indicates if the user can disable this settingenabled
- default enabled state
-
-
Method Details
-
getDefaultValue
Gets the default value for this setting.- Overrides:
getDefaultValue
in classSettingDescriptor<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 classSettingDescriptor<ColorInfo>
- Returns:
- true if this setting affects the appearance of the study/strategy
-
createControl
Creates the color input selector- Overrides:
createControl
in classSettingDescriptor<ColorInfo>
- Parameters:
settings
- settings for the studyreadOnly
- true if the component should not accept user input- Returns:
- component that will accept user input.
-
fromJson
- Overrides:
fromJson
in classSettingDescriptor<ColorInfo>
-