org.jfree.pixie.wmf

Class GDIColor


public class GDIColor
extends Color

A color implementation, that supports some additional flags defined by the Windows API, but has no Alpha-Channel. This is a BGR color implementation, the flags are stored in the highest byte.

Field Summary

static int
PC_EXPLICIT
static int
PC_NOCOLLAPSE
static int
PC_RESERVED

Constructor Summary

GDIColor(int colorref)
Creates a new GDI color instance by parsing the color reference.
GDIColor(int r, int g, int b, int flags)
Creates a new GDI Color instance.

Method Summary

int
getFlags()
Gets the assigned flag for the color.
boolean
isExplicit()
Returns the PC_EXPLICIT flag state for this color.
boolean
isNoCollapse()
Returns the PC_NOCOLLAPSE flag state for this color.
boolean
isReserved()
Returns the PC_RESERVED flag state for this color.
static int
translateColor(Color c)
Translates the given color instance into a GDI color reference.

Field Details

PC_EXPLICIT

public static final int PC_EXPLICIT
Field Value:
2

PC_NOCOLLAPSE

public static final int PC_NOCOLLAPSE
Field Value:
4

PC_RESERVED

public static final int PC_RESERVED
Field Value:
1

Constructor Details

GDIColor

public GDIColor(int colorref)
Creates a new GDI color instance by parsing the color reference.
Parameters:
colorref - the integer color reference.

GDIColor

public GDIColor(int r,
                int g,
                int b,
                int flags)
Creates a new GDI Color instance.
Parameters:
r - the red channel.
g - the green channel.
b - the blue channel.
flags - the Windows Color flags.

Method Details

getFlags

public int getFlags()
Gets the assigned flag for the color.
Returns:
the flags.

isExplicit

public boolean isExplicit()
Returns the PC_EXPLICIT flag state for this color.
Returns:
true, if PC_EXPLICIT is set, false otherwise.

isNoCollapse

public boolean isNoCollapse()
Returns the PC_NOCOLLAPSE flag state for this color.
Returns:
true, if PC_NOCOLLAPSE is set, false otherwise.

isReserved

public boolean isReserved()
Returns the PC_RESERVED flag state for this color.
Returns:
true, if PC_RESERVED is set, false otherwise.

translateColor

public static int translateColor(Color c)
Translates the given color instance into a GDI color reference.
Parameters:
c - the color that should be translated.
Returns:
the created color reference.