Package 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 Object

Field Summary

Fields

Modifier and Type	Field	Description
final Color	defaultColor
boolean	isDisplayedInColorDialog
boolean	isDisplayedInIndicatorPopup
final String	name	Color name that user will see

Constructor Summary

Constructors

Constructor	Description
ColorDescription(Class<?> strategyClass, String name, Color defaultColor, boolean isDisplayedInColorDialog)

Method Summary

Modifier and Type	Method	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 Details

defaultColor

public final Color defaultColor

name

public final String name

Color name that user will see

isDisplayedInColorDialog

public boolean isDisplayedInColorDialog

isDisplayedInIndicatorPopup

public boolean isDisplayedInIndicatorPopup

Constructor Details

ColorDescription

public ColorDescription(Class<?> strategyClass,
 String name,
 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 Details

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: