Class GuideDescriptor
java.lang.Object
com.motivewave.platform.sdk.common.desc.SettingDescriptor<GuideInfo>
com.motivewave.platform.sdk.common.desc.GuideDescriptor
Describes a guide that is displayed on a study graph.
-
Constructor Summary
ConstructorDescriptionGuideDescriptor
(String name, String label, double value, double minValue, double maxValue, double step, boolean supportsDisable) Constructor. -
Method Summary
Modifier and TypeMethodDescriptionjavafx.scene.Node
createInputFX
(Settings settings, boolean readOnly) Creates the component that will accept the user input.float[]
getDash()
Gets the default dash settings for the guide (null for solid line).Gets the default value for this setting.Gets the default label color for the guide indicator.Gets the default line color for the guide.double
Gets the maximum value for the guide.double
Gets the minimum value for the guide.double
getStep()
Gets the step increment.Gets the default text color for the guide indicator.float
getWidth()
Gets the default line width for the guide.void
setDash
(float[] d) Sets the default dash settings for the guide (null for solid line).void
setEnabled
(boolean b) Sets the default enabled state for this guide.void
Sets the default label color for the guide indicator.void
Sets the default line color for the guide.void
setSupportsEditValue
(boolean b) void
Sets the default text color for the guide indicator.void
setWidth
(float w) Sets the default line width for the guide.boolean
Methods inherited from class com.motivewave.platform.sdk.common.desc.SettingDescriptor
createInput, createTBInput, getDescription, getGridWidth, getHelpLink, getIconFactory, getId, getLabel, getName, isAllowUserDefaults, isDisplaySetting, isEnabled, isShowLabel, isSupportsDisable, setAllowUserDefaults, setDefaultValue, setDescription, setGridWidth, setHelpLink, setIconFactory, setShowLabel, setSupportsDisable
-
Constructor Details
-
GuideDescriptor
public GuideDescriptor(String name, String label, double value, double minValue, double maxValue, double step, boolean supportsDisable) Constructor.- Parameters:
name
- name of this setting (key)label
- label displayed to the uservalue
- default y value for displaying this guideminValue
- minimum y value for the guidemaxValue
- maximum y value for the guidestep
- incremental stepsupportsDisable
- indicates if the user can disable this setting.
-
-
Method Details
-
getDefaultValue
Gets the default value for this setting.- Overrides:
getDefaultValue
in classSettingDescriptor<GuideInfo>
- Returns:
- default value for the setting
-
createInputFX
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 classSettingDescriptor<GuideInfo>
- Parameters:
settings
- settings for the studyreadOnly
- true if the component should not accept user input- Returns:
- component that will accept user input.
-
getMinValue
public double getMinValue()Gets the minimum value for the guide. -
getMaxValue
public double getMaxValue()Gets the maximum value for the guide. -
getStep
public double getStep()Gets the step increment. -
getLineColor
Gets the default line color for the guide. -
setLineColor
Sets the default line color for the guide. -
getLabelColor
Gets the default label color for the guide indicator. -
setLabelColor
Sets the default label color for the guide indicator. -
getTextColor
Gets the default text color for the guide indicator. -
setTextColor
Sets the default text color for the guide indicator. -
getWidth
public float getWidth()Gets the default line width for the guide. -
setWidth
public void setWidth(float w) Sets the default line width for the guide. -
getDash
public float[] getDash()Gets the default dash settings for the guide (null for solid line). -
setDash
public void setDash(float[] d) Sets the default dash settings for the guide (null for solid line). -
setEnabled
public void setEnabled(boolean b) Sets the default enabled state for this guide.- Overrides:
setEnabled
in classSettingDescriptor<GuideInfo>
- Parameters:
b
- true if this setting is enabled
-
supportsEditValue
public boolean supportsEditValue() -
setSupportsEditValue
public void setSupportsEditValue(boolean b) -
fromJson
- Overrides:
fromJson
in classSettingDescriptor<GuideInfo>
-