Package net.sf.jaxodraw.util

Class JaxoColor

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

    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static java.awt.Color getClosestColorTo​(java.awt.Color refcolor, int mode)
      Return the Color closest (in the specified mode) to the given color.
      static java.awt.Color getColor​(int i)
      Returns the color at index i of the colorList.
      static java.awt.Color getColor​(java.lang.String cName)
      Returns the color corresponding to the name cName, or the default color if none.
      static java.awt.Color getColor​(java.lang.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 java.lang.String getColorName​(int i)
      Returns the name of the color at index i in the colorList.
      static java.lang.String getColorName​(java.awt.Color color)
      Returns the name of the closest defined color to 'color'.
      static java.lang.String getColorName​(java.awt.Color color, int space)
      Returns the name of the closest defined color (in the mode) color.
      static java.awt.Color getDefaultColor()
      Returns the current default color.
      static java.awt.Color getDefaultFillColor​(java.awt.Color lineColor)
      Returns the current default fill color for the given line color.
      static java.awt.Color getGrayScaleColor​(float f)
      Returns the grayscale that corresponds to the float value f.
      static float getGrayScaleFloat​(java.awt.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 java.lang.String getLatexColorCommand​(java.awt.Color color)
      Returns a String containing the LaTex color command (as used by the package colordvi) to set the color.
      static boolean isDefinedColor​(java.awt.Color color)
      Checks whether the given color is a defined Color.
      static boolean isDefinedColor​(java.awt.Color color, int mode)
      Checks whether the given color is a defined Color in the given mode.
      static boolean isDefinedColorName​(java.lang.String cName)
      Checks whether the given name is for a defined Color.
      static boolean isDefinedColorName​(java.lang.String cName, int mode)
      Checks whether the given name is for a Color defined in the given mode.
      static boolean isGrayScale​(java.awt.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 java.awt.Color GREEN_YELLOW
        The color GreenYellow.

      • YELLOW

        public static final java.awt.Color YELLOW
        The color Yellow.

      • GOLDEN_ROD

        public static final java.awt.Color GOLDEN_ROD
        The color Goldenrod.

      • DANDELION

        public static final java.awt.Color DANDELION
        The color Dandelion.

      • APRICOT

        public static final java.awt.Color APRICOT
        The color Apricot.

      • PEACH

        public static final java.awt.Color PEACH
        The color Peach.

      • MELON

        public static final java.awt.Color MELON
        The color Melon.

      • YELLOW_ORANGE

        public static final java.awt.Color YELLOW_ORANGE
        The color YellowOrange.

      • ORANGE

        public static final java.awt.Color ORANGE
        The color Orange.

      • BURNT_ORANGE

        public static final java.awt.Color BURNT_ORANGE
        The color BurntOrange.

      • BITTERSWEET

        public static final java.awt.Color BITTERSWEET
        The color Bittersweet.

      • RED_ORANGE

        public static final java.awt.Color RED_ORANGE
        The color RedOrange.

      • MAHOGANY

        public static final java.awt.Color MAHOGANY
        The color Mahagony.

      • MAROON

        public static final java.awt.Color MAROON
        The color Maroon.

      • BRICK_RED

        public static final java.awt.Color BRICK_RED
        The color BrickRed.

      • RED

        public static final java.awt.Color RED
        The color Red.

      • ORANGE_RED

        public static final java.awt.Color ORANGE_RED
        The color OrangeRed.

      • RUBINE_RED

        public static final java.awt.Color RUBINE_RED
        The color RubineRed.

      • WILDSTRAWBERRY

        public static final java.awt.Color WILDSTRAWBERRY
        The color WildStrawberry.

      • SALMON

        public static final java.awt.Color SALMON
        The color Salmon.

      • CARNATION_PINK

        public static final java.awt.Color CARNATION_PINK
        The color CarnationPink.

      • MAGENTA

        public static final java.awt.Color MAGENTA
        The color Magenta.

      • VIOLET_RED

        public static final java.awt.Color VIOLET_RED
        The color VioletRed.

      • RHODAMINE

        public static final java.awt.Color RHODAMINE
        The color Rhodamine.

      • MULBERRY

        public static final java.awt.Color MULBERRY
        The color Mulberry.

      • RED_VIOLET

        public static final java.awt.Color RED_VIOLET
        The color RedViolet.

      • FUCHSIA

        public static final java.awt.Color FUCHSIA
        The color Fuchsia.

      • LAVENDER

        public static final java.awt.Color LAVENDER
        The color Lavender.

      • THISTLE

        public static final java.awt.Color THISTLE
        The color Thistle.

      • ORCHID

        public static final java.awt.Color ORCHID
        The color Orchid.

      • DARK_ORCHID

        public static final java.awt.Color DARK_ORCHID
        The color DarkOrchid.

      • PURPLE

        public static final java.awt.Color PURPLE
        The color Purple.

      • PLUM

        public static final java.awt.Color PLUM
        The color Plum.

      • VIOLET

        public static final java.awt.Color VIOLET
        The color Violet.

      • ROYAL_PURPLE

        public static final java.awt.Color ROYAL_PURPLE
        The color RoyalPurple.

      • BLUE_VIOLET

        public static final java.awt.Color BLUE_VIOLET
        The color BlueViolet.

      • PERIWINKLE

        public static final java.awt.Color PERIWINKLE
        The color Periwinkle.

      • CADET_BLUE

        public static final java.awt.Color CADET_BLUE
        The color CadetBlue.

      • CORNFLOWER_BLUE

        public static final java.awt.Color CORNFLOWER_BLUE
        The color CornflowerBlue.

      • MIDNIGHT_BLUE

        public static final java.awt.Color MIDNIGHT_BLUE
        The color MidnightBlue.

      • NAVY_BLUE

        public static final java.awt.Color NAVY_BLUE
        The color NavyBlue.

      • ROYAL_BLUE

        public static final java.awt.Color ROYAL_BLUE
        The color RoyalBlue.

      • BLUE

        public static final java.awt.Color BLUE
        The color Blue.

      • CERULEAN

        public static final java.awt.Color CERULEAN
        The color Cerulean.

      • CYAN

        public static final java.awt.Color CYAN
        The color Cyan.

      • PROCESS_BLUE

        public static final java.awt.Color PROCESS_BLUE
        The color ProcessBlue.

      • SKY_BLUE

        public static final java.awt.Color SKY_BLUE
        The color SkyBlue.

      • TURQUOISE

        public static final java.awt.Color TURQUOISE
        The color Turquoise.

      • TEAL_BLUE

        public static final java.awt.Color TEAL_BLUE
        The color TealBlue.

      • AQUAMARINE

        public static final java.awt.Color AQUAMARINE
        The color Aquamarine.

      • BLUE_GREEN

        public static final java.awt.Color BLUE_GREEN
        The color BlueGreen.

      • EMERALD

        public static final java.awt.Color EMERALD
        The color Emerald.

      • JUNGLE_GREEN

        public static final java.awt.Color JUNGLE_GREEN
        The color JungleGreen.

      • SEA_GREEN

        public static final java.awt.Color SEA_GREEN
        The color SeaGreen.

      • GREEN

        public static final java.awt.Color GREEN
        The color Green.

      • FOREST_GREEN

        public static final java.awt.Color FOREST_GREEN
        The color ForestGreen.

      • PINE_GREEN

        public static final java.awt.Color PINE_GREEN
        The color PineGreen.

      • LIME_GREEN

        public static final java.awt.Color LIME_GREEN
        The color LimeGreen.

      • YELLOW_GREEN

        public static final java.awt.Color YELLOW_GREEN
        The color YellowGreen.

      • SPRING_GREEN

        public static final java.awt.Color SPRING_GREEN
        The color SpringGreen.

      • OLIVE_GREEN

        public static final java.awt.Color OLIVE_GREEN
        The color OliveGreen.

      • RAWSIENNA

        public static final java.awt.Color RAWSIENNA
        The color RawSienna.

      • SEPIA

        public static final java.awt.Color SEPIA
        The color Sepia.

      • BROWN

        public static final java.awt.Color BROWN
        The color Brown.

      • TAN

        public static final java.awt.Color TAN
        The color Tan.

      • GRAY

        public static final java.awt.Color GRAY
        The color Gray.

      • BLACK

        public static final java.awt.Color BLACK
        The color Black.

      • GRAYSCALE15

        public static final java.awt.Color GRAYSCALE15
        The color GrayScale15.

      • GRAYSCALE30

        public static final java.awt.Color GRAYSCALE30
        The color GrayScale30.

      • GRAYSCALE45

        public static final java.awt.Color GRAYSCALE45
        The color GrayScale45.

      • GRAYSCALE60

        public static final java.awt.Color GRAYSCALE60
        The color GrayScale60.

      • GRAYSCALE75

        public static final java.awt.Color GRAYSCALE75
        The color GrayScale75.

      • GRAYSCALE90

        public static final java.awt.Color GRAYSCALE90
        The color GrayScale90.

      • GRAYSCALE105

        public static final java.awt.Color GRAYSCALE105
        The color GrayScale105.

      • GRAYSCALE120

        public static final java.awt.Color GRAYSCALE120
        The color GrayScale120.

      • GRAYSCALE135

        public static final java.awt.Color GRAYSCALE135
        The color GrayScale135.

      • GRAYSCALE150

        public static final java.awt.Color GRAYSCALE150
        The color GrayScale150.

      • GRAYSCALE165

        public static final java.awt.Color GRAYSCALE165
        The color GrayScale165.

      • GRAYSCALE180

        public static final java.awt.Color GRAYSCALE180
        The color GrayScale180.

      • GRAYSCALE195

        public static final java.awt.Color GRAYSCALE195
        The color GrayScale195.

      • GRAYSCALE210

        public static final java.awt.Color GRAYSCALE210
        The color GrayScale210.

      • GRAYSCALE225

        public static final java.awt.Color GRAYSCALE225
        The color GrayScale225.

      • GRAYSCALE240

        public static final java.awt.Color GRAYSCALE240
        The color GrayScale240.

      • WHITE

        public static final java.awt.Color WHITE
        The color White.

    • Method Detail

      • isDefinedColor

        public static boolean isDefinedColor​(java.awt.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​(java.awt.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​(java.lang.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​(java.lang.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 java.awt.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 java.lang.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 java.awt.Color getDefaultColor()
        Returns the current default color.
        Returns:
        Returns BLACK.

      • getDefaultFillColor

        public static java.awt.Color getDefaultFillColor​(java.awt.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 java.awt.Color getColor​(java.lang.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 java.awt.Color getColor​(java.lang.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 java.lang.String getColorName​(java.awt.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 java.lang.String getColorName​(java.awt.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​(java.awt.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​(java.awt.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 java.awt.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 java.lang.String getLatexColorCommand​(java.awt.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 java.awt.Color getClosestColorTo​(java.awt.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.