org.testfx.util

Class ColorUtils

java.lang.Object

org.testfx.util.ColorUtils

public final class ColorUtils
extends java.lang.Object

Contains Color utility methods.

See Also:

Named Colors

Method Summary

Modifier and Type	Method and Description
static double	calculateColorDistSq(javafx.scene.paint.Color color0, javafx.scene.paint.Color color1) Calculates and returns the distance between two Colors, using a simple Euclidean metric.
static javafx.scene.paint.Color	getClosestNamedColor(javafx.scene.paint.Color color) Returns the named color that is closest to the given color.
static java.lang.String	getClosestNamedColor(java.lang.Integer hexColor) Returns the named color that is closest to the given hex code color value.
static java.util.Optional<javafx.scene.paint.Color>	getNamedColor(javafx.scene.paint.Color color) Returns an Optional with a value of the named Color that is equal to the given color, if it exists.
static java.util.Optional<java.lang.String>	getNamedColor(java.lang.Integer hexColor) Returns the named color that is exactly equal to the given hex code color value.
static java.util.Optional<javafx.scene.paint.Color>	getNamedColor(java.lang.String name) Returns an Optional with a value of the named Color that has the given name, if it exists.

Methods inherited from class java.lang.Object

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

Method Detail

getClosestNamedColor

public static java.lang.String getClosestNamedColor(java.lang.Integer hexColor)

Returns the named color that is closest to the given hex code color value.

Only the first 6 bytes of hexColor are taken into account. That is two bytes for each red, blue, and green component.

Parameters:

hexColor - the Integer hex color value of the named color to return

Returns:

the named color that is closest to the given hexString color

getClosestNamedColor

public static javafx.scene.paint.Color getClosestNamedColor(javafx.scene.paint.Color color)

Returns the named color that is closest to the given color.

Parameters:

color - the color to find the closest named color for

Returns:

the named color that is closest to the given color

getNamedColor

public static java.util.Optional<javafx.scene.paint.Color> getNamedColor(java.lang.String name)

Returns an Optional with a value of the named Color that has the given name, if it exists. Otherwise returns an empty Optional.

Parameters:

name - the name of the named Color to return

Returns:

an Optional<Color> that either contains the named color with the given name or nothing (i.e. an empty Optional if no such named color exists

getNamedColor

public static java.util.Optional<javafx.scene.paint.Color> getNamedColor(javafx.scene.paint.Color color)

Returns an Optional with a value of the named Color that is equal to the given color, if it exists. Otherwise returns an empty Optional.

Parameters:

color - the color of the named color to return

Returns:

an Optional<Color> that either contains the named color that is equal to the given color or nothing (i.e. an empty Optional) if no such named color exists

getNamedColor

public static java.util.Optional<java.lang.String> getNamedColor(java.lang.Integer hexColor)

Returns the named color that is exactly equal to the given hex code color value.

Only the first 6 bytes of hexColor are taken into account. That is two bytes for each red, blue, and green component.

Parameters:

hexColor - the Integer hex color value of the named color to return

Returns:

an Optional<String> that either contains the named color that equals the given hexColor or nothing if no such named color exists

calculateColorDistSq

public static double calculateColorDistSq(javafx.scene.paint.Color color0,
                                          javafx.scene.paint.Color color1)

Calculates and returns the distance between two Colors, using a simple Euclidean metric.

Parameters:

color0 - the first color

color1 - the second color

Returns:

the distance between the two colors