com.motivewave.platform.sdk.common.desc

Class ColorDescriptor

java.lang.Object

com.motivewave.platform.sdk.common.desc.SettingDescriptor

com.motivewave.platform.sdk.common.desc.ColorDescriptor

public class ColorDescriptor
extends SettingDescriptor

Describes a color setting.

Constructor Summary

Constructors

Constructor and Description
ColorDescriptor(java.lang.String name, java.lang.String label, java.awt.Color defaultValue) Constructor.
ColorDescriptor(java.lang.String name, java.lang.String label, java.awt.Color defaultValue, boolean enabled, boolean supportsDisable) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
javax.swing.JComponent	createInput(Settings settings, boolean readOnly) Creates the color input selector
ColorInfo	getDefaultValue() Gets the default value as a color.
boolean	isDisplaySetting() Indicates if this setting is used to affect the appearance of the of the study/strategy

Methods inherited from class com.motivewave.platform.sdk.common.desc.SettingDescriptor

getGridWidth, getLabel, getName, isAllowUserDefaults, isEnabled, isShowLabel, isSupportsDisable, setAllowUserDefaults, setDefaultValue, setEnabled, setGridWidth, setShowLabel, setSupportsDisable

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ColorDescriptor

public ColorDescriptor(java.lang.String name,
               java.lang.String label,
               java.awt.Color defaultValue)

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 user

defaultValue - default color value

ColorDescriptor

public ColorDescriptor(java.lang.String name,
               java.lang.String label,
               java.awt.Color defaultValue,
               boolean enabled,
               boolean supportsDisable)

Constructor.

Parameters:

name - name of this setting (key)

label - label displayed to the user

defaultValue - default color value

enabled - default enabled state

supportsDisable - indicates if the user can disable this setting

Method Detail

getDefaultValue

public ColorInfo getDefaultValue()

Gets the default value as a color.

Overrides:

getDefaultValue in class SettingDescriptor

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

Returns:

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

createInput

public javax.swing.JComponent createInput(Settings settings,
                                 boolean readOnly)

Creates the color input selector

Specified by:

createInput in class SettingDescriptor

Parameters:

settings - settings for the study

readOnly - true if the component should not accept user input

Returns:

component that will accept user input.