Class JaxoColor

java.lang.Object

net.sf.jaxodraw.util.JaxoColor

public final class JaxoColor
extends Object

Definitions and conversions for the colors of the LaTeX colordvi package (approximately) and a predefined set of gray shades.

Since:

2.0

Field Summary

Fields

Modifier and Type	Field	Description
static final int	ALL_COLORS_MODE	Any Color can be chosen.
static final Color	APRICOT	The color Apricot.
static final Color	AQUAMARINE	The color Aquamarine.
static final Color	BITTERSWEET	The color Bittersweet.
static final Color	BLACK	The color Black.
static final Color	BLUE	The color Blue.
static final Color	BLUE_GREEN	The color BlueGreen.
static final Color	BLUE_VIOLET	The color BlueViolet.
static final Color	BRICK_RED	The color BrickRed.
static final Color	BROWN	The color Brown.
static final Color	BURNT_ORANGE	The color BurntOrange.
static final Color	CADET_BLUE	The color CadetBlue.
static final Color	CARNATION_PINK	The color CarnationPink.
static final Color	CERULEAN	The color Cerulean.
static final Color	CORNFLOWER_BLUE	The color CornflowerBlue.
static final Color	CYAN	The color Cyan.
static final Color	DANDELION	The color Dandelion.
static final Color	DARK_ORCHID	The color DarkOrchid.
static final Color	EMERALD	The color Emerald.
static final Color	FOREST_GREEN	The color ForestGreen.
static final Color	FUCHSIA	The color Fuchsia.
static final Color	GOLDEN_ROD	The color Goldenrod.
static final Color	GRAY	The color Gray.
static final Color	GRAYSCALE105	The color GrayScale105.
static final Color	GRAYSCALE120	The color GrayScale120.
static final Color	GRAYSCALE135	The color GrayScale135.
static final Color	GRAYSCALE15	The color GrayScale15.
static final Color	GRAYSCALE150	The color GrayScale150.
static final Color	GRAYSCALE165	The color GrayScale165.
static final Color	GRAYSCALE180	The color GrayScale180.
static final Color	GRAYSCALE195	The color GrayScale195.
static final Color	GRAYSCALE210	The color GrayScale210.
static final Color	GRAYSCALE225	The color GrayScale225.
static final Color	GRAYSCALE240	The color GrayScale240.
static final Color	GRAYSCALE30	The color GrayScale30.
static final Color	GRAYSCALE45	The color GrayScale45.
static final Color	GRAYSCALE60	The color GrayScale60.
static final Color	GRAYSCALE75	The color GrayScale75.
static final Color	GRAYSCALE90	The color GrayScale90.
static final Color	GREEN	The color Green.
static final Color	GREEN_YELLOW	The color GreenYellow.
static final int	JAXO_COLORS_MODE	All Colors defined in JaxoColor can be chosen.
static final int	JAXO_COLORS_NO_GRAYSCALES_MODE	Colors defined in JaxoColor except grayscales can be chosen.
static final Color	JUNGLE_GREEN	The color JungleGreen.
static final Color	LAVENDER	The color Lavender.
static final Color	LIME_GREEN	The color LimeGreen.
static final Color	MAGENTA	The color Magenta.
static final Color	MAHOGANY	The color Mahagony.
static final Color	MAROON	The color Maroon.
static final Color	MELON	The color Melon.
static final Color	MIDNIGHT_BLUE	The color MidnightBlue.
static final Color	MULBERRY	The color Mulberry.
static final Color	NAVY_BLUE	The color NavyBlue.
static final Color	OLIVE_GREEN	The color OliveGreen.
static final Color	ORANGE	The color Orange.
static final Color	ORANGE_RED	The color OrangeRed.
static final Color	ORCHID	The color Orchid.
static final Color	PEACH	The color Peach.
static final Color	PERIWINKLE	The color Periwinkle.
static final Color	PINE_GREEN	The color PineGreen.
static final Color	PLUM	The color Plum.
static final Color	PROCESS_BLUE	The color ProcessBlue.
static final Color	PURPLE	The color Purple.
static final Color	RAWSIENNA	The color RawSienna.
static final Color	RED	The color Red.
static final Color	RED_ORANGE	The color RedOrange.
static final Color	RED_VIOLET	The color RedViolet.
static final Color	RHODAMINE	The color Rhodamine.
static final Color	ROYAL_BLUE	The color RoyalBlue.
static final Color	ROYAL_PURPLE	The color RoyalPurple.
static final Color	RUBINE_RED	The color RubineRed.
static final Color	SALMON	The color Salmon.
static final Color	SEA_GREEN	The color SeaGreen.
static final Color	SEPIA	The color Sepia.
static final Color	SKY_BLUE	The color SkyBlue.
static final Color	SPRING_GREEN	The color SpringGreen.
static final Color	TAN	The color Tan.
static final Color	TEAL_BLUE	The color TealBlue.
static final Color	THISTLE	The color Thistle.
static final Color	TURQUOISE	The color Turquoise.
static final Color	VIOLET	The color Violet.
static final Color	VIOLET_RED	The color VioletRed.
static final Color	WHITE	The color White.
static final Color	WILDSTRAWBERRY	The color WildStrawberry.
static final Color	YELLOW	The color Yellow.
static final Color	YELLOW_GREEN	The color YellowGreen.
static final Color	YELLOW_ORANGE	The color YellowOrange.

Method Summary

Modifier and Type	Method	Description
static Color	getClosestColorTo(Color refcolor, int mode)	Return the Color closest (in the specified mode) to the given color.
static Color	getColor(int i)	Returns the color at index i of the colorList.
static Color	getColor(String cName)	Returns the color corresponding to the name cName, or the default color if none.
static Color	getColor(String cName, int mode)	Returns the color corresponding to the name cName, or the default color if none.
static int	getColorCount()	Returns the number of colors defined by JaxoColor.
static String	getColorName(int i)	Returns the name of the color at index i in the colorList.
static String	getColorName(Color color)	Returns the name of the closest defined color to 'color'.
static String	getColorName(Color color, int space)	Returns the name of the closest defined color (in the mode) color.
static Color	getDefaultColor()	Returns the current default color.
static Color	getDefaultFillColor(Color lineColor)	Returns the current default fill color for the given line color.
static Color	getGrayScaleColor(float f)	Returns the grayscale that corresponds to the float value f.
static float	getGrayScaleFloat(Color color)	Returns a string representation of a Color that gives the grayscale of color, or sets it to '0.0' (black), if color is not a grayscale.
static String	getLatexColorCommand(Color color)	Returns a String containing the LaTex color command (as used by the package colordvi) to set the color.
static boolean	isDefinedColor(Color color)	Checks whether the given color is a defined Color.
static boolean	isDefinedColor(Color color, int mode)	Checks whether the given color is a defined Color in the given mode.
static boolean	isDefinedColorName(String cName)	Checks whether the given name is for a defined Color.
static boolean	isDefinedColorName(String cName, int mode)	Checks whether the given name is for a Color defined in the given mode.
static boolean	isGrayScale(Color color)	Checks whether the 'color' is closest to one of the gray scales defined in this class.

Methods inherited from class Object

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

Field Details

JAXO_COLORS_MODE

public static final int JAXO_COLORS_MODE

All Colors defined in JaxoColor can be chosen.

See Also:

• Constant Field Values

JAXO_COLORS_NO_GRAYSCALES_MODE

public static final int JAXO_COLORS_NO_GRAYSCALES_MODE

Colors defined in JaxoColor except grayscales can be chosen.

See Also:

• Constant Field Values

ALL_COLORS_MODE

public static final int ALL_COLORS_MODE

Any Color can be chosen.

See Also:

• Constant Field Values

GREEN_YELLOW

public static final Color GREEN_YELLOW

The color GreenYellow.

YELLOW

public static final Color YELLOW

The color Yellow.

GOLDEN_ROD

public static final Color GOLDEN_ROD

The color Goldenrod.

DANDELION

public static final Color DANDELION

The color Dandelion.

APRICOT

public static final Color APRICOT

The color Apricot.

PEACH

public static final Color PEACH

The color Peach.

MELON

public static final Color MELON

The color Melon.

YELLOW_ORANGE

public static final Color YELLOW_ORANGE

The color YellowOrange.

ORANGE

public static final Color ORANGE

The color Orange.

BURNT_ORANGE

public static final Color BURNT_ORANGE

The color BurntOrange.

BITTERSWEET

public static final Color BITTERSWEET

The color Bittersweet.

RED_ORANGE

public static final Color RED_ORANGE

The color RedOrange.

MAHOGANY

public static final Color MAHOGANY

The color Mahagony.

MAROON

public static final Color MAROON

The color Maroon.

BRICK_RED

public static final Color BRICK_RED

The color BrickRed.

RED

public static final Color RED

The color Red.

ORANGE_RED

public static final Color ORANGE_RED

The color OrangeRed.

RUBINE_RED

public static final Color RUBINE_RED

The color RubineRed.

WILDSTRAWBERRY

public static final Color WILDSTRAWBERRY

The color WildStrawberry.

SALMON

public static final Color SALMON

The color Salmon.

CARNATION_PINK

public static final Color CARNATION_PINK

The color CarnationPink.

MAGENTA

public static final Color MAGENTA

The color Magenta.

VIOLET_RED

public static final Color VIOLET_RED

The color VioletRed.

RHODAMINE

public static final Color RHODAMINE

The color Rhodamine.

MULBERRY

public static final Color MULBERRY

The color Mulberry.

RED_VIOLET

public static final Color RED_VIOLET

The color RedViolet.

FUCHSIA

public static final Color FUCHSIA

The color Fuchsia.

LAVENDER

public static final Color LAVENDER

The color Lavender.

THISTLE

public static final Color THISTLE

The color Thistle.

ORCHID

public static final Color ORCHID

The color Orchid.

DARK_ORCHID

public static final Color DARK_ORCHID

The color DarkOrchid.

PURPLE

public static final Color PURPLE

The color Purple.

PLUM

public static final Color PLUM

The color Plum.

VIOLET

public static final Color VIOLET

The color Violet.

ROYAL_PURPLE

public static final Color ROYAL_PURPLE

The color RoyalPurple.

BLUE_VIOLET

public static final Color BLUE_VIOLET

The color BlueViolet.

PERIWINKLE

public static final Color PERIWINKLE

The color Periwinkle.

CADET_BLUE

public static final Color CADET_BLUE

The color CadetBlue.

CORNFLOWER_BLUE

public static final Color CORNFLOWER_BLUE

The color CornflowerBlue.

MIDNIGHT_BLUE

public static final Color MIDNIGHT_BLUE

The color MidnightBlue.

NAVY_BLUE

public static final Color NAVY_BLUE

The color NavyBlue.

ROYAL_BLUE

public static final Color ROYAL_BLUE

The color RoyalBlue.

BLUE

public static final Color BLUE

The color Blue.

CERULEAN

public static final Color CERULEAN

The color Cerulean.

CYAN

public static final Color CYAN

The color Cyan.

PROCESS_BLUE

public static final Color PROCESS_BLUE

The color ProcessBlue.

SKY_BLUE

public static final Color SKY_BLUE

The color SkyBlue.

TURQUOISE

public static final Color TURQUOISE

The color Turquoise.

TEAL_BLUE

public static final Color TEAL_BLUE

The color TealBlue.

AQUAMARINE

public static final Color AQUAMARINE

The color Aquamarine.

BLUE_GREEN

public static final Color BLUE_GREEN

The color BlueGreen.

EMERALD

public static final Color EMERALD

The color Emerald.

JUNGLE_GREEN

public static final Color JUNGLE_GREEN

The color JungleGreen.

SEA_GREEN

public static final Color SEA_GREEN

The color SeaGreen.

GREEN

public static final Color GREEN

The color Green.

FOREST_GREEN

public static final Color FOREST_GREEN

The color ForestGreen.

PINE_GREEN

public static final Color PINE_GREEN

The color PineGreen.

LIME_GREEN

public static final Color LIME_GREEN

The color LimeGreen.

YELLOW_GREEN

public static final Color YELLOW_GREEN

The color YellowGreen.

SPRING_GREEN

public static final Color SPRING_GREEN

The color SpringGreen.

OLIVE_GREEN

public static final Color OLIVE_GREEN

The color OliveGreen.

RAWSIENNA

public static final Color RAWSIENNA

The color RawSienna.

SEPIA

public static final Color SEPIA

The color Sepia.

BROWN

public static final Color BROWN

The color Brown.

TAN

public static final Color TAN

The color Tan.

GRAY

public static final Color GRAY

The color Gray.

BLACK

public static final Color BLACK

The color Black.

GRAYSCALE15

public static final Color GRAYSCALE15

The color GrayScale15.

GRAYSCALE30

public static final Color GRAYSCALE30

The color GrayScale30.

GRAYSCALE45

public static final Color GRAYSCALE45

The color GrayScale45.

GRAYSCALE60

public static final Color GRAYSCALE60

The color GrayScale60.

GRAYSCALE75

public static final Color GRAYSCALE75

The color GrayScale75.

GRAYSCALE90

public static final Color GRAYSCALE90

The color GrayScale90.

GRAYSCALE105

public static final Color GRAYSCALE105

The color GrayScale105.

GRAYSCALE120

public static final Color GRAYSCALE120

The color GrayScale120.

GRAYSCALE135

public static final Color GRAYSCALE135

The color GrayScale135.

GRAYSCALE150

public static final Color GRAYSCALE150

The color GrayScale150.

GRAYSCALE165

public static final Color GRAYSCALE165

The color GrayScale165.

GRAYSCALE180

public static final Color GRAYSCALE180

The color GrayScale180.

GRAYSCALE195

public static final Color GRAYSCALE195

The color GrayScale195.

GRAYSCALE210

public static final Color GRAYSCALE210

The color GrayScale210.

GRAYSCALE225

public static final Color GRAYSCALE225

The color GrayScale225.

GRAYSCALE240

public static final Color GRAYSCALE240

The color GrayScale240.

WHITE

public static final Color WHITE

The color White.

Method Details

isDefinedColor

public static boolean isDefinedColor(Color color)

Checks whether the given color is a defined Color.

Parameters:

color - A color.

Returns:

True if color is one of the colors defined by this class.

isDefinedColor

public static boolean isDefinedColor(Color color,
 int mode)

Checks whether the given color is a defined Color in the given mode.

Parameters:

color - A color.

mode - the color mode.

Returns:

True if color is defined.

isDefinedColorName

public static boolean isDefinedColorName(String cName)

Checks whether the given name is for a defined Color.

Parameters:

cName - a color name

Returns:

True if 'cName' is a name of one of the colors defined by this class.

isDefinedColorName

public static boolean isDefinedColorName(String cName,
 int mode)

Checks whether the given name is for a Color defined in the given mode.

Parameters:

cName - a color name.

mode - the color mode.

Returns:

True if 'cName' is defined.

getColorCount

public static int getColorCount()

Returns the number of colors defined by JaxoColor.

Returns:

The number of colors defined by JaxoColor.

getColor

public static Color getColor(int i)

Returns the color at index i of the colorList.

Parameters:

i - Index of the color to be returned

Returns:

Color at index i.

getColorName

public static String getColorName(int i)

Returns the name of the color at index i in the colorList.

Parameters:

i - Index of the color whose name is to be returned.

Returns:

Name of the color at index i.

getDefaultColor

public static Color getDefaultColor()

Returns the current default color.

Returns:

Returns BLACK.

getDefaultFillColor

public static Color getDefaultFillColor(Color lineColor)

Returns the current default fill color for the given line color.

Parameters:

lineColor - The line color.

Returns:

Returns GRAYSCALE225 if the argument is BLACK, GRAY otherwise.

getColor

public static Color getColor(String cName)

Returns the color corresponding to the name cName, or the default color if none.

Parameters:

cName - The name of the color to be returned.

Returns:

The color corresponding to the name cName.

See Also:

• getDefaultColor()

getColor

public static Color getColor(String cName,
 int mode)

Returns the color corresponding to the name cName, or the default color if none.

Parameters:

cName - The name of the color to be returned.

mode - The mode defining the color space

Returns:

The color corresponding to the name cName.

getColorName

public static String getColorName(Color color)

Returns the name of the closest defined color to 'color'.

Parameters:

color - Color whose name is to be returned.

Returns:

Name of the color color.

getColorName

public static String getColorName(Color color,
 int space)

Returns the name of the closest defined color (in the mode) color.

Parameters:

color - Color whose name is to be returned.

space - defining the allowed colors.

Returns:

Name of the color color.

getGrayScaleFloat

public static float getGrayScaleFloat(Color color)

Returns a string representation of a Color that gives the grayscale of color, or sets it to '0.0' (black), if color is not a grayscale.

Parameters:

color - The color whose grayscale value is to be returned.

Returns:

The float grayness of the grayscale corresponding to color.

isGrayScale

public static boolean isGrayScale(Color color)

Checks whether the 'color' is closest to one of the gray scales defined in this class.

Parameters:

color - A color.

Returns:

True if color is a grayscale, false otherwise.

getGrayScaleColor

public static Color getGrayScaleColor(float f)

Returns the grayscale that corresponds to the float value f. or null if f is not between 0.f and 1.f

Parameters:

f - A float between 0.f and 1.f

Returns:

The gray scale corresponding to the float value f.

getLatexColorCommand

public static String getLatexColorCommand(Color color)

Returns a String containing the LaTex color command (as used by the package colordvi) to set the color.

Parameters:

color - The color to be set in the LaTex command.

Returns:

The String representation of the LaTex command.

getClosestColorTo

public static Color getClosestColorTo(Color refcolor,
 int mode)

Return the Color closest (in the specified mode) to the given color.

Parameters:

refcolor - the color to be matched.

mode - mode to use

Returns:

A Color in the color space of the given mode, or null if the given color was null.