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, 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.NodecreateInputFX(Settings settings, boolean readOnly) Creates the color input selectorGets the default value for this setting.booleanIndicates 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
-
ColorDescriptor
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 userdefaultValue- 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 userdefaultValue- default color valueenabled- default enabled statesupportsDisable- indicates if the user can disable this setting
-
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:
getDefaultValuein classSettingDescriptor<ColorInfo>- Returns:
- default value for the setting
-
isDisplaySetting
public boolean isDisplaySetting()Description copied from class:SettingDescriptorIndicates if this setting is used to affect the appearance of the of the study/strategy- Overrides:
isDisplaySettingin classSettingDescriptor<ColorInfo>- Returns:
- true if this setting affects the appearance of the study/strategy
-
createInputFX
Creates the color input selector- Specified by:
createInputFXin 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:
fromJsonin classSettingDescriptor<ColorInfo>
-