Class BarDescriptor
java.lang.Object
com.motivewave.platform.sdk.common.desc.SettingDescriptor<BarInfo>
com.motivewave.platform.sdk.common.desc.BarDescriptor
Describes a vertical bar.
-
Constructor Summary
ConstructorsConstructorDescriptionBarDescriptor(String name, String label, Color color, boolean enabled, boolean supportsDisable) Constructor.BarDescriptor(String name, String label, Color color, Integer fixedWidth, boolean enabled, boolean supportsDisable) Constructor. -
Method Summary
Modifier and TypeMethodDescriptionjavafx.scene.NodecreateControl(SettingsBase settings, boolean readOnly) Creates the component that will accept the user input.getColor()Gets the default color of the bar.Gets the default value for this setting.Gets the fixed width of the bar.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, 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
-
BarDescriptor
public BarDescriptor(String name, String label, Color color, boolean enabled, boolean supportsDisable) Constructor.- Parameters:
name- name of this setting (key)label- label displayed to the usercolor- default color of the barenabled- default enabled statesupportsDisable- indicates if the user can disable this setting
-
BarDescriptor
public BarDescriptor(String name, String label, Color color, Integer fixedWidth, boolean enabled, boolean supportsDisable) Constructor.- Parameters:
name- name of this setting (key)label- label displayed to the usercolor- default color of the barfixedWidth- fixed width of the bar (null for dynamic size)enabled- default enabled statesupportsDisable- indicates if the user can disable this setting
-
-
Method Details
-
getDefaultValue
Gets the default value for this setting.- Overrides:
getDefaultValuein classSettingDescriptor<BarInfo>- 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<BarInfo>- Returns:
- true if this setting affects the appearance of the study/strategy
-
createControl
Description copied from class:SettingDescriptorCreates the component that will accept the user input. This is called by the study framework.- Overrides:
createControlin classSettingDescriptor<BarInfo>- Parameters:
settings- settings for the studyreadOnly- true if the component should not accept user input- Returns:
- component that will accept user input.
-
getColor
Gets the default color of the bar. -
getFixedWidth
Gets the fixed width of the bar. -
fromJson
- Overrides:
fromJsonin classSettingDescriptor<BarInfo>
-