velox.api.layer1.messages.indicators

Class IndicatorColorScheme.ColorDescription

java.lang.Object

velox.api.layer1.messages.indicators.IndicatorColorScheme.ColorDescription

Enclosing interface:

IndicatorColorScheme

public static class IndicatorColorScheme.ColorDescription
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field and Description
java.awt.Color	defaultColor
boolean	isDisplayedInColorDialog
boolean	isDisplayedInIndicatorPopup
java.lang.String	name Color name that user will see

Constructor Summary

Constructors

Constructor and Description
ColorDescription(java.lang.Class<?> strategyClass, java.lang.String name, java.awt.Color defaultColor, boolean isDisplayedInColorDialog)

Method Summary

Modifier and Type	Method and Description
IndicatorColorScheme.ColorDescription	setDisplayedInColorDialog(boolean displayedInColorDialog)
IndicatorColorScheme.ColorDescription	setDisplayedInIndicatorPopup(boolean displayedInIndicatorPopup)

Methods inherited from class java.lang.Object

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

Field Detail

defaultColor

public final java.awt.Color defaultColor

name

public final java.lang.String name

Color name that user will see

isDisplayedInColorDialog

public boolean isDisplayedInColorDialog

isDisplayedInIndicatorPopup

public boolean isDisplayedInIndicatorPopup

Constructor Detail

ColorDescription

public ColorDescription(java.lang.Class<?> strategyClass,
                        java.lang.String name,
                        java.awt.Color defaultColor,
                        boolean isDisplayedInColorDialog)

Parameters:

strategyClass -

name - should consist only of a-zA-Z0-9 and spaces, and should not be empty

defaultColor -

isDisplayedInColorDialog - if true, this color will be configurable via default color dialog (in indicators section)
otherwise color will not be configurable there
Note that color dialog is global (non alias specific)

Method Detail

setDisplayedInIndicatorPopup

public IndicatorColorScheme.ColorDescription setDisplayedInIndicatorPopup(boolean displayedInIndicatorPopup)

Parameters:

displayedInIndicatorPopup - if true, this color will be configurable via right click menu for indicator
otherwise color will not be configurable there
Default: false

Returns:

setDisplayedInColorDialog

public IndicatorColorScheme.ColorDescription setDisplayedInColorDialog(boolean displayedInColorDialog)

Parameters:

displayedInColorDialog - if true, this color will be configurable via default color dialog (in indicators section)
otherwise color will not be configurable there
Note that color dialog is global (non alias specific)

Returns: