Skip navigation links

com.oracle.outsidein
Class ColorInfo

java.lang.Object
com.oracle.outsidein.ColorInfo

public class ColorInfo

extends java.lang.Object

Contains color information for use in annotations and options such as transparency color.

Constructor Summary

ColorInfo()
The default constructor that uses the default color

ColorInfo(byte red, byte green, byte blue)
Constructor used to create a specific color.

Method Summary

byte	getBlue() Retrieves the current blue color as a byte value.
byte	getGreen() Retrieves the current blue color as a byte value.
long	getOptionValue() An internally used method to obtain the color as a long value.
byte	getRed() Retrieves the current red color as a byte value.
boolean	isDefaultColor() Tells whether or not the color is using the default red, green, and blue values.

Methods inherited from class java.lang.Object

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

Constructor Detail

ColorInfo

public ColorInfo()

The default constructor that uses the default color

ColorInfo

public ColorInfo(byte red,
                 byte green,
                 byte blue)

Constructor used to create a specific color.

Parameters:

red - The red component of the color to create

green - The green component of the color to create

blue - The blue component of the color to create

Method Detail

getRed

public byte getRed()

Retrieves the current red color as a byte value.

Returns:

the red component of the color as a byte value

getGreen

public byte getGreen()

Retrieves the current blue color as a byte value.

Returns:

the blue component of the color as a byte value

getBlue

public byte getBlue()

Retrieves the current blue color as a byte value.

Returns:

the blue component of the color as a byte value

isDefaultColor

public boolean isDefaultColor()

Tells whether or not the color is using the default red, green, and blue values. The default color is set when the ColorInfo object is created with the ColorInfo() constructor. This color may be system dependent.

Returns:

true if and only if, the color is set to the default color value

getOptionValue

public long getOptionValue()

An internally used method to obtain the color as a long value. This method should not be used externally.

Returns:

The color value represented as a long

Skip navigation links