com.datagis.com4j

Class OleColor

java.lang.Object

java.awt.Color

com.datagis.com4j.OleColor

All Implemented Interfaces:

Paint, Transparency, Serializable

public class OleColor
extends Color

Specifies a native OLE color value. The OleColor class extends class java.awt.Color in order to support OLE color formats in addition to all Color capabilities.

An OLE color value, whose C/C++ type is named OLE_COLOR, basically is an int value, that stores color information in different formats. One format stores a color's red, green and blue components explicitly, whereas the other format simply holds an predefined index into the operating system's system color table.

Among many analogies, there are two major differences between OLE colors and Java colors:

1. OLE colors have no alpha component. That means, OLE colors are never transparent but always opaque. Furthermore, bits 24-31 are not used to store the color's alpha component.

2. OLE colors store the red, green and blue components in reverse order. That is, they actually store the blue, green and red components in bits 16-23, 8-15 and 0-7 respectively. So, an int value containing an OLE color with explicit color components looks like 0x00bbggrr.

The second form of an OLE color simply stores an index of a well-known system color. These are the colors that are defined in the Windows display control panel. Actually, a single byte is sufficient to store any system color index, so the index is stored in bits 0-7 of the int value that holds an OLE color. To distinguish between an OLE color that explicitly stores blue, green and red components, 0x80 is put into bits 24-31. So, an int value containing an OLE color that refers to a system color looks like 0x800000ss, whereas ss is the index of the system color.

Since:

TEJ1.0

Author:

Carsten Klein

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static int	INVALID_SYSTEM_COLOR_INDEX Represents an invalid system color index.

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
OleColor(Color color) Creates a OleColor sRGB color with the values of the specified Color object.
OleColor(ColorSpace cspace, float[] components, float alpha) Creates a color in the specified ColorSpace with the color components specified in the float array and the specified alpha.
OleColor(float r, float g, float b) Creates an opaque sRGB color with the specified red, green, and blue values in the range (0.0 - 1.0).
OleColor(float r, float g, float b, float a) Creates a sRGB color with the specified red, green, blue, and alpha values in the range (0.0 - 1.0).
OleColor(int bgr) Creates an opaque sRGB color with the specified combined BGR value consisting of the blue component in bits 16-23, the green component in bits 8-15, and the red component in bits 0-7.
OleColor(int rgba, boolean hasalpha) Creates a sRGB color with the specified combined RGBA value consisting of the alpha component in bits 24-31, the red component in bits 16-23, the green component in bits 8-15, and the blue component in bits 0-7.
OleColor(int r, int g, int b) Creates an opaque sRGB color with the specified red, green, and blue values in the range (0 - 255).
OleColor(int r, int g, int b, int a) Creates a sRGB color with the specified red, green, blue, and alpha values in the range (0 - 255).
OleColor(NativeSystemColor systemColor) Creates an opaque sRGB color with the specified native system color.

Method Summary

Modifier and Type	Method and Description
int	getBGR() Returns the value of this OleColor as a combined BGR color value.
Color	getColor() Returns the value of this OleColor as a real java.awt.Color type.
Color	getColor(float alpha) Returns the value of this OleColor as a real java.awt.Color type with the specified alpha value.
Color	getColor(int alpha) Returns the value of this OleColor as a real java.awt.Color type with the specified alpha value.
int	getOleColorValue() Returns the value of this OleColor as a OLE color value.
static int	getRGB(int bgr) Returns a combined RGB value, created from the specified combined BGR value consisting of the blue component in bits 16-23, the green component in bits 8-15, and the red component in bits 0-7.
int	getSystemColorIndex() Returns the system color index of this OleColor or -1 if this instance does not represent a system color.
boolean	isSystemColor() Returns a value indicating whether this OleColor represents a system color.

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

INVALID_SYSTEM_COLOR_INDEX

public static final int INVALID_SYSTEM_COLOR_INDEX

Represents an invalid system color index. This value may be returned by method getSystemColorIndex.

See Also:

Constant Field Values

Constructor Detail

OleColor

public OleColor(int bgr)

Creates an opaque sRGB color with the specified combined BGR value consisting of the blue component in bits 16-23, the green component in bits 8-15, and the red component in bits 0-7. Optionally, the specified argument may represent a native system color in OLE color format. That is, the system color's index bitwise combined (bitwise or operation) with the value 0x80000000.

Parameters:

bgr - the combined BGR components or a native system color in OLE color format

Throws:

IndexOutOfBoundsException - if bgr denotes a system color in OLE color format (aka contains 0x80 in bits 24-31), whose index (bits 0-7) does not specify an existing system color.

OleColor

public OleColor(NativeSystemColor systemColor)

Creates an opaque sRGB color with the specified native system color.

Parameters:

systemColor - the native system color

OleColor

public OleColor(Color color)

Creates a OleColor sRGB color with the values of the specified Color object.

Parameters:

color - the color object to take color values from

OleColor

public OleColor(int r,
                int g,
                int b)

Creates an opaque sRGB color with the specified red, green, and blue values in the range (0 - 255). The actual color used in rendering depends on finding the best match given the color space available for a given output device. Alpha is defaulted to 255.

Parameters:

r - the red component

g - the green component

b - the blue component

Throws:

IllegalArgumentException - if r, g or b are outside of the range 0 to 255, inclusive

See Also:

Color.getRed(), Color.getGreen(), Color.getBlue(), getRGB(int), getBGR()

OleColor

public OleColor(int r,
                int g,
                int b,
                int a)

Creates a sRGB color with the specified red, green, blue, and alpha values in the range (0 - 255).

Parameters:

r - the red component

g - the green component

b - the blue component

a - the alpha component

Throws:

IllegalArgumentException - if r, g, b or a are outside of the range 0 to 255, inclusive

See Also:

Color.getRed(), Color.getGreen(), Color.getBlue(), Color.getAlpha(), getRGB(int), getBGR()

OleColor

public OleColor(int rgba,
                boolean hasalpha)

Creates a sRGB color with the specified combined RGBA value consisting of the alpha component in bits 24-31, the red component in bits 16-23, the green component in bits 8-15, and the blue component in bits 0-7. If the hasalpha argument is false, alpha is defaulted to 255.

Parameters:

rgba - the combined RGBA components

hasalpha - true if the alpha bits are valid; false otherwise

See Also:

ColorModel.getRGBdefault(), Color.getRed(), Color.getGreen(), Color.getBlue(), Color.getAlpha(), getRGB(int), getBGR()

OleColor

public OleColor(float r,
                float g,
                float b)

Creates an opaque sRGB color with the specified red, green, and blue values in the range (0.0 - 1.0). Alpha is defaulted to 1.0. The actual color used in rendering depends on finding the best match given the color space available for a particular output device.

Parameters:

r - the red component

g - the green component

b - the blue component

Throws:

IllegalArgumentException - if r, g or b are outside of the range 0.0 to 1.0, inclusive

See Also:

Color.getRed(), Color.getGreen(), Color.getBlue(), getRGB(int), getBGR()

OleColor

public OleColor(float r,
                float g,
                float b,
                float a)

Creates a sRGB color with the specified red, green, blue, and alpha values in the range (0.0 - 1.0). The actual color used in rendering depends on finding the best match given the color space available for a particular output device.

Parameters:

r - the red component

g - the green component

b - the blue component

a - the alpha component

Throws:

IllegalArgumentException - if r, g b or a are outside of the range 0.0 to 1.0, inclusive

See Also:

Color.getRed(), Color.getGreen(), Color.getBlue(), Color.getAlpha(), getRGB(int), getBGR()

OleColor

public OleColor(ColorSpace cspace,
                float[] components,
                float alpha)

Creates a color in the specified ColorSpace with the color components specified in the float array and the specified alpha. The number of components is determined by the type of the ColorSpace. For example, RGB requires 3 components, but CMYK requires 4 components.

Parameters:

cspace - the ColorSpace to be used to interpret the components

components - an arbitrary number of color components that is compatible with the

alpha - alpha value

Throws:

IllegalArgumentException - if any of the values in the components array or alpha is outside of the range 0.0 to 1.0

See Also:

Color.getComponents(float[]), Color.getColorComponents(float[])

Method Detail

getRGB

public static int getRGB(int bgr)

Returns a combined RGB value, created from the specified combined BGR value consisting of the blue component in bits 16-23, the green component in bits 8-15, and the red component in bits 0-7. Optionally, the specified argument may represent a native system color in OLE color format. That is, the system color's index bitwise combined (bitwise or operation) with the value 0x80000000.

Parameters:

bgr - the combined BGR components or a native system color in OLE color format

Returns:

a combined RGB value, created from the specified combined BGR value or from a system color specified as OLE color value

Throws:

IndexOutOfBoundsException - if bgr denotes a system color in OLE color format (aka contains 0x80 in bits 24-31), whose index (bits 0-7) does not specify an existing system color.

isSystemColor

public boolean isSystemColor()

Returns a value indicating whether this OleColor represents a system color.

Returns:

true if this OleColor represents a system color; false otherwise

See Also:

getSystemColorIndex()

getSystemColorIndex

public int getSystemColorIndex()

Returns the system color index of this OleColor or -1 if this instance does not represent a system color.

Returns:

the system color index of this OleColor or -1 if this instance does not represent a system color

getBGR

public int getBGR()

Returns the value of this OleColor as a combined BGR color value.

Returns:

the value of this OleColor as a combined BGR color value

getOleColorValue

public int getOleColorValue()

Returns the value of this OleColor as a OLE color value. That is an OLE color encoded system color index, if this OleColor represents a system color or a combined BGR color value for all other colors.

Returns:

the value of this OleColor as a OLE color value

getColor

public Color getColor()

Returns the value of this OleColor as a real java.awt.Color type.

Returns:

the value of this OleColor as a real java.awt.Color type.

getColor

public Color getColor(int alpha)

Returns the value of this OleColor as a real java.awt.Color type with the specified alpha value.

Parameters:

alpha - the alpha value to be used for the returned Color

Returns:

the value of this OleColor as a real java.awt.Color type.

getColor

public Color getColor(float alpha)

Returns the value of this OleColor as a real java.awt.Color type with the specified alpha value.

Parameters:

alpha - the alpha value to be used for the returned Color

Returns:

the value of this OleColor as a real java.awt.Color type.