net.sf.jaxodraw.util
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

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

Method Summary

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(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 String	getColorName(int i) Returns the name of the color at index i in the colorList.
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 java.lang.Object

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

Field Detail

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 Detail

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.