ilog.views.util.java2d

Class IlvContrastingColor

java.lang.Object

java.awt.Color

ilog.views.util.java2d.IlvContrastingColor

All Implemented Interfaces:

Composite, Paint, Transparency, Serializable

public class IlvContrastingColor
extends Color
implements Composite

This class denotes a color that depends on the background. It can take two different colors. When the background is bright, it presents itself as a dark color. When the background is dark, it behaves like a bright color.

Note: This class can only be used in graphic objects and renderers that have explicit support for it. Most graphic objects and renderers in JViews do not support it.

Note: In order to add support for IlvContrastingColor to a drawing routine with a background filled entirely with a known color, the following code template can be used:

   Color backgroundColor = ...;
   Graphics2D g = ...;
   Color oldPaint = g.getPaint();
   try {
     g.setPaint(contrastingColor.chooseColor(backgroundColor);
     ...
   } finally {
     g.setPaint(oldPaint);
   }
 

Note: In order to add support for IlvContrastingColor to a drawing routine with an unknown background, the following code template can be used:

   Color backgroundColor = ...;
   Graphics2D g = ...;
   Color oldPaint = g.getPaint();
   Composite oldComposite = g.getComposite();
   try {
     g.setPaint(Color.black);
     g.setComposite(contrastingColor);
     ...
   } finally {
     g.setPaint(oldPaint);
     g.setComposite(oldComposite);
   }
 

Note: IlvContrastingColor is a custom implementation of Composite. Due to Sun JRE bug #4833528, custom Composites work only when rendering into a BufferedImage. This is the case

• on Windows, inside a Swing component, when Swing double-buffering is enabled, or
• on Unix/X11, inside a Swing component, when Swing double-buffering is enabled and the system property sun.java2d.pmoffscreen is set to false, or
• when drawing into an explicitly allocated BufferedImage.

Since:

JViews 8.0

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static RenderingHints.Key	KNOWN_BACKGROUND_COLOR This rendering hint can be set on a Graphics2D to indicate a known background color.

Fields inherited from class java.awt.Color

black, BLACK, blue, BLUE, cyan, CYAN, DARK_GRAY, darkGray, gray, GRAY, green, GREEN, LIGHT_GRAY, lightGray, magenta, MAGENTA, orange, ORANGE, pink, PINK, red, RED, white, WHITE, yellow, YELLOW

Fields inherited from interface java.awt.Transparency

BITMASK, OPAQUE, TRANSLUCENT

Constructor Summary

Constructors

Constructor and Description
IlvContrastingColor() Creates a contrasting color with default settings.
IlvContrastingColor(Color darkColor, Color brightColor, float threshold) Creates a contrasting color with the given dark and bright color.

Method Summary

Modifier and Type	Method and Description
Color	chooseColor(Color backgroundColor) Returns the appropriate color for a given background color.
CompositeContext	createContext(ColorModel srcColorModel, ColorModel dstColorModel, RenderingHints hints) This method implements the Composite interface.
Color	getBrightColor() Returns the color used in front of dark background.
Color	getDarkColor() Returns the color used in front of bright background.
float	getThreshold() Returns the brightness limit used to distinguish whether the background is considered as bright or dark.

Methods inherited from class java.awt.Color

brighter, createContext, darker, decode, equals, getAlpha, getBlue, getColor, getColor, getColor, getColorComponents, getColorComponents, getColorSpace, getComponents, getComponents, getGreen, getHSBColor, getRed, getRGB, getRGBColorComponents, getRGBComponents, getTransparency, hashCode, HSBtoRGB, RGBtoHSB, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

KNOWN_BACKGROUND_COLOR

public static final RenderingHints.Key KNOWN_BACKGROUND_COLOR

This rendering hint can be set on a Graphics2D to indicate a known background color. The possible values are instances of java.awt.Color and null.

Constructor Detail

IlvContrastingColor

public IlvContrastingColor(Color darkColor,
                           Color brightColor,
                           float threshold)

Creates a contrasting color with the given dark and bright color.

Parameters:

darkColor - The color to use in front of bright background.

brightColor - The color to use in front of dark background.

threshold - The brightness limit used to distinguish whether the background is considered as bright or dark. This is a value between 0 and 1.

IlvContrastingColor

public IlvContrastingColor()

Creates a contrasting color with default settings. The dark color is black, the bright color is white, and the threshold is 0.5.

Method Detail

getDarkColor

public Color getDarkColor()

Returns the color used in front of bright background.

getBrightColor

public Color getBrightColor()

Returns the color used in front of dark background.

getThreshold

public float getThreshold()

Returns the brightness limit used to distinguish whether the background is considered as bright or dark.

Returns:

A value between 0 and 1.

chooseColor

public Color chooseColor(Color backgroundColor)

Returns the appropriate color for a given background color.

Returns:

One of getDarkColor(), getBrightColor().

createContext

public CompositeContext createContext(ColorModel srcColorModel,
                                      ColorModel dstColorModel,
                                      RenderingHints hints)

This method implements the Composite interface.

Specified by:

createContext in interface Composite