Package jmri.util

Class ColorUtil

java.lang.Object

jmri.util.ColorUtil

public class ColorUtil
extends Object

A collection of utilities related to colors.

Field Summary

Fields

Modifier and Type	Field	Description
static final Color	BROWN
static final Color	clear
static final Color	CLEAR
static final String	ColorBlack
static final String	ColorBlue
static final String	ColorBrown
static final String	ColorClear
static final String	ColorCyan
static final String	ColorDarkGray
static final String	ColorGray
static final String	ColorGreen
static final String	ColorLightGray
static final String	ColorMagenta
static final String	ColorOrange
static final String	ColorPink
static final String	ColorRed
static final String	ColorTrack
static final String	ColorWhite
static final String	ColorYellow

Constructor Summary

Constructors

Constructor	Description
ColorUtil()

Method Summary

Modifier and Type	Method	Description
static String	colorToColorName(Color color)	Returns known color name or hex value in form #RRGGBB.
static String	colorToHexString(Color color)	Convert a color into hex value of form #RRGGBB.
static String	colorToLocalizedName(Color color)	Returns localized color name or hex value in form #RRGGBB.
static String	colorToString(Color color)	Handles known colors plus special value for track.
static Color	contrast(Color color)	Return the color (Black/White) that most contrasts with the specified color.
static Color	lerp(Color colorA, Color colorB, double t)	Calculate the linear interpolation between two colors.
static Color	setAlpha(Color color, double alpha)	Set the alpha component of a color.
static Color	setAlpha(Color color, int alpha)	Set the alpha component of a color.
static Color	stringToColor(String string)

Methods inherited from class java.lang.Object

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

Field Details

ColorTrack

public static final String ColorTrack

See Also:

• Constant Field Values

ColorBlack

public static final String ColorBlack

See Also:

• Constant Field Values

ColorDarkGray

public static final String ColorDarkGray

See Also:

• Constant Field Values

ColorGray

public static final String ColorGray

See Also:

• Constant Field Values

ColorLightGray

public static final String ColorLightGray

See Also:

• Constant Field Values

ColorWhite

public static final String ColorWhite

See Also:

• Constant Field Values

ColorRed

public static final String ColorRed

See Also:

• Constant Field Values

ColorPink

public static final String ColorPink

See Also:

• Constant Field Values

ColorOrange

public static final String ColorOrange

See Also:

• Constant Field Values

ColorYellow

public static final String ColorYellow

See Also:

• Constant Field Values

ColorGreen

public static final String ColorGreen

See Also:

• Constant Field Values

ColorBlue

public static final String ColorBlue

See Also:

• Constant Field Values

ColorMagenta

public static final String ColorMagenta

See Also:

• Constant Field Values

ColorCyan

public static final String ColorCyan

See Also:

• Constant Field Values

ColorClear

public static final String ColorClear

See Also:

• Constant Field Values

ColorBrown

public static final String ColorBrown

See Also:

• Constant Field Values

clear

public static final Color clear

CLEAR

public static final Color CLEAR

BROWN

public static final Color BROWN

Constructor Details

ColorUtil

public ColorUtil()

Method Details

colorToString

@Nonnull
public static String colorToString(@CheckForNull
 Color color)

Handles known colors plus special value for track.

Parameters:

color - the color or null

Returns:

the name of the color or "black" if a color was provided; "track" if color is null

colorToColorName

@CheckForNull
public static String colorToColorName(@CheckForNull
 Color color)

Returns known color name or hex value in form #RRGGBB.

Parameters:

color - the color

Returns:

the name or hex value of color; returns null if color is null

colorToLocalizedName

@CheckForNull
public static String colorToLocalizedName(@CheckForNull
 Color color)

Returns localized color name or hex value in form #RRGGBB.

Parameters:

color - the color object

Returns:

the localized name or hex value of color; returns null if color is null

Since:

4.13.1

stringToColor

public static Color stringToColor(String string)

Parameters:

string - Either a hexadecimal representation of the rgb value of a color or a color name defined as a constant.

Returns:

the color from the string or null if the string equals "track" or equals the localized value for "None"

Throws:

IllegalArgumentException - if string cannot be converted into a Color

colorToHexString

@CheckForNull
public static String colorToHexString(@CheckForNull
 Color color)

Convert a color into hex value of form #RRGGBB.

Parameters:

color - the color or null

Returns:

the hex string or null if color is null

contrast

public static Color contrast(@Nonnull
 Color color)

Return the color (Black/White) that most contrasts with the specified color.

Parameters:

color - the source color

Returns:

the contrasting color

lerp

@CheckReturnValue
public static Color lerp(@Nonnull
 Color colorA,
 @Nonnull
 Color colorB,
 double t)

Calculate the linear interpolation between two colors.

Parameters:

colorA - the first color

colorB - the second color

t - the fraction (between 0 and 1)

Returns:

the linear interpolation between a and b for t

setAlpha

@CheckReturnValue
public static Color setAlpha(@Nonnull
 Color color,
 int alpha)

Set the alpha component of a color.

Parameters:

color - the color

alpha - the alpha component (integer 0 - 255)

Returns:

the new color with the specified alpha

setAlpha

@CheckReturnValue
public static Color setAlpha(@Nonnull
 Color color,
 double alpha)

Set the alpha component of a color.

Parameters:

color - the color

alpha - the alpha component (double 0.0 - 1.0)

Returns:

the new color with the specified alpha