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

Class MarkerDescriptor

java.lang.Object

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

com.motivewave.platform.sdk.common.desc.MarkerDescriptor

public class MarkerDescriptor
extends SettingDescriptor<MarkerInfo>

Describes marker figure that is displayed at strategic points on the graph.

Constructor Summary

Constructors

Constructor	Description
MarkerDescriptor(String name, String label, Enums.MarkerType type, Enums.Size size, Color fillColor, Color outlineColor, boolean enabled, boolean supportsDisable)	Constructor
MarkerDescriptor(String name, String label, MarkerInfo def, boolean supportsDisable)	Constructor

Method Summary

Modifier and Type	Method	Description
javafx.scene.Node	createInputFX(Settings settings, boolean readOnly)	Creates the component that will accept the user input.
Object	fromJson(Object json)
MarkerInfo	getDefaultValue()	Gets the default value for this setting.
Color	getFillColor()	Gets the default fill color for the marker.
Color	getOutlineColor()	Gets the default outline color for the marker.
Enums.Size	getSize()	Gets the default size of the marker.
Enums.Size[]	getSizes()	Gets all of the valid marker sizes.
Enums.MarkerType	getType()	Gets the default type of the marker.
Enums.MarkerType[]	getTypes()	Gets the set of valid marker types.
boolean	isDisplaySetting()	Indicates if this setting is used to affect the appearance of the of the study/strategy
boolean	isSupportsAdvanced()	Indicates if the user can adjust the advanced attributes of the marker.
boolean	isSupportsColor()	Indicates if the user can adjust the color attributes of the marker.
void	setSizes(Enums.Size[] sizes)	Sets the valid marker sizes.
void	setSupportsAdvanced(boolean b)	Sets the attribute to allow the user to set advanced attributes.
void	setSupportsColor(boolean b)	Sets the attribute to allow the user to set color attributes.
void	setTypes(Enums.MarkerType[] values)	Sets the valid set of type choices.

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

MarkerDescriptor

public MarkerDescriptor(String name,
 String label,
 Enums.MarkerType type,
 Enums.Size size,
 Color fillColor,
 Color outlineColor,
 boolean enabled,
 boolean supportsDisable)

Constructor

Parameters:

name - name of this setting (key)

label - label displayed to the user

type - default type of the marker

size - default size of the marker

fillColor - default fill color for the marker

outlineColor - default outline color for the marker

enabled - default enabled state

supportsDisable - indicates if the user can disable the display of the marker

MarkerDescriptor

public MarkerDescriptor(String name,
 String label,
 MarkerInfo def,
 boolean supportsDisable)

Constructor

Parameters:

name - name of this setting (key)

label - label displayed to the user

supportsDisable - indicates if the user can disable the display of the marker

type - default type of the marker

size - default size of the marker

fillColor - default fill color for the marker

outlineColor - default outline color for the marker

enabled - default enabled state

Method Details

getDefaultValue

public MarkerInfo getDefaultValue()

Gets the default value for this setting.

Overrides:

getDefaultValue in class SettingDescriptor<MarkerInfo>

Returns:

default value for the setting

createInputFX

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

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 class SettingDescriptor<MarkerInfo>

Parameters:

settings - settings for the study

readOnly - true if the component should not accept user input

Returns:

component that will accept user input.

getType

public Enums.MarkerType getType()

Gets the default type of the marker.

getSize

public Enums.Size getSize()

Gets the default size of the marker.

getFillColor

public Color getFillColor()

Gets the default fill color for the marker.

getOutlineColor

public Color getOutlineColor()

Gets the default outline color for the marker.

isSupportsAdvanced

public boolean isSupportsAdvanced()

Indicates if the user can adjust the advanced attributes of the marker.

setSupportsAdvanced

public void setSupportsAdvanced(boolean b)

Sets the attribute to allow the user to set advanced attributes.

isSupportsColor

public boolean isSupportsColor()

Indicates if the user can adjust the color attributes of the marker.

setSupportsColor

public void setSupportsColor(boolean b)

Sets the attribute to allow the user to set color attributes.

getTypes

public Enums.MarkerType[] getTypes()

Gets the set of valid marker types.

setTypes

public void setTypes(Enums.MarkerType[] values)

Sets the valid set of type choices.

getSizes

public Enums.Size[] getSizes()

Gets all of the valid marker sizes.

setSizes

public void setSizes(Enums.Size[] sizes)

Sets the valid marker sizes.

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

Returns:

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

fromJson

public Object fromJson(Object json)

Overrides:

fromJson in class SettingDescriptor<MarkerInfo>