com.moximedia.aims
Class AimsColor

java.lang.Object
  com.moximedia.aims.AimsColor

All Implemented Interfaces:

java.lang.Cloneable, java.io.Serializable

public class AimsColor

extends java.lang.Object

implements java.io.Serializable, java.lang.Cloneable

The AimsColor class is used to store color information, and also contains static color definitions per the ArcIms ActiveX documentation.

Author:

Doug Cates - www.moximedia.com

See Also:

Serialized Form

Field Summary

static long	imsAliceblue A pre-defined color value
static long	imsAntiquewhite A pre-defined color value
static long	imsAqua A pre-defined color value
static long	imsAquamarine A pre-defined color value
static long	imsAzure A pre-defined color value
static long	imsBeige A pre-defined color value
static long	imsBisque A pre-defined color value
static long	imsBlack A pre-defined color value
static long	imsBlanchedalmond A pre-defined color value
static long	imsBlue A pre-defined color value
static long	imsBlueViolet A pre-defined color value
static long	imsBrown A pre-defined color value
static long	imsCadetblue A pre-defined color value
static long	imsChartreuse A pre-defined color value
static long	imsChocolate A pre-defined color value
static long	imsCoral A pre-defined color value
static long	imsCornflowerblue A pre-defined color value
static long	imsCornsilk A pre-defined color value
static long	imsCrimson A pre-defined color value
static long	imsCyan A pre-defined color value
static long	imsDarkblue A pre-defined color value
static long	imsDarkcyan A pre-defined color value
static long	imsDarkgoldenrod A pre-defined color value
static long	imsDarkgray A pre-defined color value
static long	imsDarkgreen A pre-defined color value
static long	imsDarkkhaki A pre-defined color value
static long	imsDarkmagenta A pre-defined color value
static long	imsDarkolivegreen A pre-defined color value
static long	imsDarkorange A pre-defined color value
static long	imsDarkred A pre-defined color value
static long	imsDarksalmon A pre-defined color value
static long	imsDarkseagreen A pre-defined color value
static long	imsDarkslateblue A pre-defined color value
static long	imsDarkslategray A pre-defined color value
static long	imsDarkturquoise A pre-defined color value
static long	imsDarkviolet A pre-defined color value
static long	imsDeeppink A pre-defined color value
static long	imsDeepskyblue A pre-defined color value
static long	imsDimgray A pre-defined color value
static long	imsDodgerblue A pre-defined color value
static long	imsFirebrick A pre-defined color value
static long	imsFloralwhite A pre-defined color value
static long	imsForestgreen A pre-defined color value
static long	imsFuchsia A pre-defined color value
static long	imsGainsboro A pre-defined color value
static long	imsGhostwhite A pre-defined color value
static long	imsGold A pre-defined color value
static long	imsGoldenrod A pre-defined color value
static long	imsGray A pre-defined color value
static long	imsGreen A pre-defined color value
static long	imsGreenyellow A pre-defined color value
static long	imsHoneydey A pre-defined color value
static long	imsHotPink A pre-defined color value
static long	imsIndianred A pre-defined color value
static long	imsIndigo A pre-defined color value
static long	imsIvory A pre-defined color value
static long	imsKhaki A pre-defined color value
static long	imsLavender A pre-defined color value
static long	imsLavenderblush A pre-defined color value
static long	imsLawngreen A pre-defined color value
static long	imsLemonchiffon A pre-defined color value
static long	imsLightblue A pre-defined color value
static long	imsLightcoral A pre-defined color value
static long	imsLightcyan A pre-defined color value
static long	imsLightgoldenrodyellow A pre-defined color value
static long	imsLightgray A pre-defined color value
static long	imsLightGreen A pre-defined color value
static long	imsLightpink A pre-defined color value
static long	imsLightsalmon A pre-defined color value
static long	imsLightseagreen A pre-defined color value
static long	imsLightskyblue A pre-defined color value
static long	imsLightslategray A pre-defined color value
static long	imsLightsteelblue A pre-defined color value
static long	imsLightyellow A pre-defined color value
static long	imsLime A pre-defined color value
static long	imsLimegreen A pre-defined color value
static long	imsLinen A pre-defined color value
static long	imsMagenta A pre-defined color value
static long	imsMaroon A pre-defined color value
static long	imsMediumaquamarine A pre-defined color value
static long	imsMediumblue A pre-defined color value
static long	imsMediumorchid A pre-defined color value
static long	imsMediumpurple A pre-defined color value
static long	imsMediumseagreen A pre-defined color value
static long	imsMediumslateblue A pre-defined color value
static long	imsMediumspringgreen A pre-defined color value
static long	imsMediumturquoise A pre-defined color value
static long	imsMediumvioletred A pre-defined color value
static long	imsMidnightblue A pre-defined color value
static long	imsMintcream A pre-defined color value
static long	imsMistyrose A pre-defined color value
static long	imsMoccasin A pre-defined color value
static long	imsNavajowhite A pre-defined color value
static long	imsNavy A pre-defined color value
static long	imsOldlace A pre-defined color value
static long	imsOlive A pre-defined color value
static long	imsOlivedrab A pre-defined color value
static long	imsOrange A pre-defined color value
static long	imsOrangered A pre-defined color value
static long	imsOrchid A pre-defined color value
static long	imsPalegoldenrod A pre-defined color value
static long	imsPalegreen A pre-defined color value
static long	imsPaleturquoise A pre-defined color value
static long	imsPalevioletred A pre-defined color value
static long	imsPapayawhip A pre-defined color value
static long	imsPeachpuff A pre-defined color value
static long	imsPeru A pre-defined color value
static long	imsPink A pre-defined color value
static long	imsPowderblue A pre-defined color value
static long	imsPurple A pre-defined color value
static long	imsRed A pre-defined color value
static long	imsRosybrown A pre-defined color value
static long	imsRoyalblue A pre-defined color value
static long	imsSaddlebrown A pre-defined color value
static long	imsSalmon A pre-defined color value
static long	imsSandybrown A pre-defined color value
static long	imsSeagreen A pre-defined color value
static long	imsSeashell A pre-defined color value
static long	imsSienna A pre-defined color value
static long	imsSilver A pre-defined color value
static long	imsSkyblue A pre-defined color value
static long	imsSlateblue A pre-defined color value
static long	imsSlategray A pre-defined color value
static long	imsSnow A pre-defined color value
static long	imsSteelblue A pre-defined color value
static long	imsTan A pre-defined color value
static long	imsThistle A pre-defined color value
static long	imsTomato A pre-defined color value
static long	imsTurquoise A pre-defined color value
static long	imsViolet A pre-defined color value
static long	imsWheat A pre-defined color value
static long	imsWhite A pre-defined color value
static long	imsWhitesmoke A pre-defined color value
static long	imsYellow A pre-defined color value
static long	imsYellowgreen A pre-defined color value

Constructor Summary

AimsColor()
Creates a new AimsColor object with default (black) color.

AimsColor(int r, int g, int b)
Creates a new AimsColor object with red, green, blue arguments.

AimsColor(long colornum)
Creates a new AimsColor object with a color number argument.

AimsColor(java.lang.String colorString)
Creates a new AimsColor object with red, green, blue arguments contained in a String.

Method Summary

java.lang.Object	clone() Creates a copy of this object.
int	getBlue() Returns the blue component of the color.
long	getColorValue(java.lang.String colorString) Returns the RGB color value for a string containing an rgb triplet.
int	getGreen() Returns the green component of the color.
static AimsColor	getRandomColor() Gets a random color.
int	getRed() Returns the red component of the color.
void	setAxlAttribute(java.lang.String tag, java.lang.String name, java.lang.String value) Sets one of the attributes of this object using a string value.
void	setColor(int r, int g, int b) Sets the color object with red, green, blue arguments.
void	setColor(java.lang.String colorString) Sets the color object with red, green, blue arguments contained in a String.
java.lang.String	toHexString() Returns a string representation of the color.
java.lang.String	toRBGString() Returns a string representation of the color.
java.lang.String	toString() Returns a string representation of the color.
java.lang.String	toWebHexString() Returns a string representation of the color.

Methods inherited from class java.lang.Object

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

Field Detail

imsAliceblue

public static long imsAliceblue

A pre-defined color value

imsAntiquewhite

public static long imsAntiquewhite

A pre-defined color value

imsAqua

public static long imsAqua

A pre-defined color value

imsAquamarine

public static long imsAquamarine

A pre-defined color value

imsAzure

public static long imsAzure

A pre-defined color value

imsBeige

public static long imsBeige

A pre-defined color value

imsBisque

public static long imsBisque

A pre-defined color value

imsBlack

public static long imsBlack

A pre-defined color value

imsBlanchedalmond

public static long imsBlanchedalmond

A pre-defined color value

imsBlue

public static long imsBlue

A pre-defined color value

imsBlueViolet

public static long imsBlueViolet

A pre-defined color value

imsBrown

public static long imsBrown

A pre-defined color value

imsCadetblue

public static long imsCadetblue

A pre-defined color value

imsChartreuse

public static long imsChartreuse

A pre-defined color value

imsChocolate

public static long imsChocolate

A pre-defined color value

imsCoral

public static long imsCoral

A pre-defined color value

imsCornflowerblue

public static long imsCornflowerblue

A pre-defined color value

imsCornsilk

public static long imsCornsilk

A pre-defined color value

imsCrimson

public static long imsCrimson

A pre-defined color value

imsCyan

public static long imsCyan

A pre-defined color value

imsDarkblue

public static long imsDarkblue

A pre-defined color value

imsDarkcyan

public static long imsDarkcyan

A pre-defined color value

imsDarkgoldenrod

public static long imsDarkgoldenrod

A pre-defined color value

imsDarkgray

public static long imsDarkgray

A pre-defined color value

imsDarkgreen

public static long imsDarkgreen

A pre-defined color value

imsDarkkhaki

public static long imsDarkkhaki

A pre-defined color value

imsDarkmagenta

public static long imsDarkmagenta

A pre-defined color value

imsDarkolivegreen

public static long imsDarkolivegreen

A pre-defined color value

imsDarkorange

public static long imsDarkorange

A pre-defined color value

imsDarkred

public static long imsDarkred

A pre-defined color value

imsDarksalmon

public static long imsDarksalmon

A pre-defined color value

imsDarkseagreen

public static long imsDarkseagreen

A pre-defined color value

imsDarkslateblue

public static long imsDarkslateblue

A pre-defined color value

imsDarkslategray

public static long imsDarkslategray

A pre-defined color value

imsDarkturquoise

public static long imsDarkturquoise

A pre-defined color value

imsDarkviolet

public static long imsDarkviolet

A pre-defined color value

imsDeeppink

public static long imsDeeppink

A pre-defined color value

imsDeepskyblue

public static long imsDeepskyblue

A pre-defined color value

imsDimgray

public static long imsDimgray

A pre-defined color value

imsDodgerblue

public static long imsDodgerblue

A pre-defined color value

imsFirebrick

public static long imsFirebrick

A pre-defined color value

imsFloralwhite

public static long imsFloralwhite

A pre-defined color value

imsForestgreen

public static long imsForestgreen

A pre-defined color value

imsFuchsia

public static long imsFuchsia

A pre-defined color value

imsGainsboro

public static long imsGainsboro

A pre-defined color value

imsGhostwhite

public static long imsGhostwhite

A pre-defined color value

imsGold

public static long imsGold

A pre-defined color value

imsGoldenrod

public static long imsGoldenrod

A pre-defined color value

imsGray

public static long imsGray

A pre-defined color value

imsGreen

public static long imsGreen

A pre-defined color value

imsGreenyellow

public static long imsGreenyellow

A pre-defined color value

imsHoneydey

public static long imsHoneydey

A pre-defined color value

imsHotPink

public static long imsHotPink

A pre-defined color value

imsIndianred

public static long imsIndianred

A pre-defined color value

imsIndigo

public static long imsIndigo

A pre-defined color value

imsIvory

public static long imsIvory

A pre-defined color value

imsKhaki

public static long imsKhaki

A pre-defined color value

imsLavender

public static long imsLavender

A pre-defined color value

imsLavenderblush

public static long imsLavenderblush

A pre-defined color value

imsLawngreen

public static long imsLawngreen

A pre-defined color value

imsLemonchiffon

public static long imsLemonchiffon

A pre-defined color value

imsLightblue

public static long imsLightblue

A pre-defined color value

imsLightcoral

public static long imsLightcoral

A pre-defined color value

imsLightcyan

public static long imsLightcyan

A pre-defined color value

imsLightgoldenrodyellow

public static long imsLightgoldenrodyellow

A pre-defined color value

imsLightGreen

public static long imsLightGreen

A pre-defined color value

imsLightgray

public static long imsLightgray

A pre-defined color value

imsLightpink

public static long imsLightpink

A pre-defined color value

imsLightsalmon

public static long imsLightsalmon

A pre-defined color value

imsLightseagreen

public static long imsLightseagreen

A pre-defined color value

imsLightskyblue

public static long imsLightskyblue

A pre-defined color value

imsLightslategray

public static long imsLightslategray

A pre-defined color value

imsLightsteelblue

public static long imsLightsteelblue

A pre-defined color value

imsLightyellow

public static long imsLightyellow

A pre-defined color value

imsLime

public static long imsLime

A pre-defined color value

imsLimegreen

public static long imsLimegreen

A pre-defined color value

imsLinen

public static long imsLinen

A pre-defined color value

imsMagenta

public static long imsMagenta

A pre-defined color value

imsMaroon

public static long imsMaroon

A pre-defined color value

imsMediumaquamarine

public static long imsMediumaquamarine

A pre-defined color value

imsMediumblue

public static long imsMediumblue

A pre-defined color value

imsMediumorchid

public static long imsMediumorchid

A pre-defined color value

imsMediumpurple

public static long imsMediumpurple

A pre-defined color value

imsMediumseagreen

public static long imsMediumseagreen

A pre-defined color value

imsMediumslateblue

public static long imsMediumslateblue

A pre-defined color value

imsMediumspringgreen

public static long imsMediumspringgreen

A pre-defined color value

imsMediumturquoise

public static long imsMediumturquoise

A pre-defined color value

imsMediumvioletred

public static long imsMediumvioletred

A pre-defined color value

imsMidnightblue

public static long imsMidnightblue

A pre-defined color value

imsMintcream

public static long imsMintcream

A pre-defined color value

imsMistyrose

public static long imsMistyrose

A pre-defined color value

imsMoccasin

public static long imsMoccasin

A pre-defined color value

imsNavajowhite

public static long imsNavajowhite

A pre-defined color value

imsNavy

public static long imsNavy

A pre-defined color value

imsOldlace

public static long imsOldlace

A pre-defined color value

imsOlive

public static long imsOlive

A pre-defined color value

imsOlivedrab

public static long imsOlivedrab

A pre-defined color value

imsOrange

public static long imsOrange

A pre-defined color value

imsOrangered

public static long imsOrangered

A pre-defined color value

imsOrchid

public static long imsOrchid

A pre-defined color value

imsPalegoldenrod

public static long imsPalegoldenrod

A pre-defined color value

imsPalegreen

public static long imsPalegreen

A pre-defined color value

imsPaleturquoise

public static long imsPaleturquoise

A pre-defined color value

imsPalevioletred

public static long imsPalevioletred

A pre-defined color value

imsPapayawhip

public static long imsPapayawhip

A pre-defined color value

imsPeachpuff

public static long imsPeachpuff

A pre-defined color value

imsPeru

public static long imsPeru

A pre-defined color value

imsPink

public static long imsPink

A pre-defined color value

imsPowderblue

public static long imsPowderblue

A pre-defined color value

imsPurple

public static long imsPurple

A pre-defined color value

imsRed

public static long imsRed

A pre-defined color value

imsRosybrown

public static long imsRosybrown

A pre-defined color value

imsRoyalblue

public static long imsRoyalblue

A pre-defined color value

imsSaddlebrown

public static long imsSaddlebrown

A pre-defined color value

imsSalmon

public static long imsSalmon

A pre-defined color value

imsSandybrown

public static long imsSandybrown

A pre-defined color value

imsSeagreen

public static long imsSeagreen

A pre-defined color value

imsSeashell

public static long imsSeashell

A pre-defined color value

imsSienna

public static long imsSienna

A pre-defined color value

imsSilver

public static long imsSilver

A pre-defined color value

imsSkyblue

public static long imsSkyblue

A pre-defined color value

imsSlateblue

public static long imsSlateblue

A pre-defined color value

imsSlategray

public static long imsSlategray

A pre-defined color value

imsSnow

public static long imsSnow

A pre-defined color value

imsSteelblue

public static long imsSteelblue

A pre-defined color value

imsTan

public static long imsTan

A pre-defined color value

imsThistle

public static long imsThistle

A pre-defined color value

imsTomato

public static long imsTomato

A pre-defined color value

imsTurquoise

public static long imsTurquoise

A pre-defined color value

imsViolet

public static long imsViolet

A pre-defined color value

imsWheat

public static long imsWheat

A pre-defined color value

imsWhite

public static long imsWhite

A pre-defined color value

imsWhitesmoke

public static long imsWhitesmoke

A pre-defined color value

imsYellow

public static long imsYellow

A pre-defined color value

imsYellowgreen

public static long imsYellowgreen

A pre-defined color value

Constructor Detail

AimsColor

public AimsColor()

Creates a new AimsColor object with default (black) color.

AimsColor

public AimsColor(long colornum)

Creates a new AimsColor object with a color number argument. To use a predefined color, follow this example:
AimsColor myYellow = new AimsColor(AimsColor.imsYellow); same as: AimsColor myYellow = new AimsColor(65535);

Parameters:

colornum - A color number.

AimsColor

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

Creates a new AimsColor object with red, green, blue arguments. The following is an example:
AimsColor myRed = new AimsColor(255,0,0);

Parameters:

r - A value for the red color intensity (0-255).

g - A value for the green color intensity (0-255).

b - A value for the blue color intensity (0-255).

AimsColor

public AimsColor(java.lang.String colorString)

Creates a new AimsColor object with red, green, blue arguments contained in a String. The following is an example:
AimsColor myRed = new AimsColor("255,0,0");

Parameters:

colorString - The color value in string format.

Method Detail

setColor

public void setColor(int r,
                     int g,
                     int b)

Sets the color object with red, green, blue arguments. The following is an example:

Parameters:

r - A value for the red color intensity (0-255).

g - A value for the green color intensity (0-255).

b - A value for the blue color intensity (0-255).

setColor

public void setColor(java.lang.String colorString)

Sets the color object with red, green, blue arguments contained in a String.

Parameters:

colorString - The color value in string format (eg. "255,0,0").

getRandomColor

public static AimsColor getRandomColor()

Gets a random color.

Returns:

A random color.

getColorValue

public long getColorValue(java.lang.String colorString)

Returns the RGB color value for a string containing an rgb triplet.

Parameters:

colorString - An rgb triplet separated by commas.

Returns:

The RGB value.

clone

public java.lang.Object clone()

Creates a copy of this object.

Returns:

An object that is a copy of this object. The object must be cast to an AimsColor object before use.

toString

public java.lang.String toString()

Returns a string representation of the color.

Returns:

The RBG color value as a string, e.g. "255,0,0".

setAxlAttribute

public void setAxlAttribute(java.lang.String tag,
                            java.lang.String name,
                            java.lang.String value)

Sets one of the attributes of this object using a string value. This method should only be called from the SAX event handler.

Parameters:

tag - The AXL element tag containing this attribute.

name - The AXL attribute name.

value - The AXL attribute value.

toRBGString

public java.lang.String toRBGString()

Returns a string representation of the color.

Returns:

The RBG color value as a string, e.g. "255,0,0".

getRed

public int getRed()

Returns the red component of the color.

Returns:

The red value, 0 to 255.

getGreen

public int getGreen()

Returns the green component of the color.

Returns:

The green value, 0 to 255.

getBlue

public int getBlue()

Returns the blue component of the color.

Returns:

The blue value, 0 to 255.

toHexString

public java.lang.String toHexString()

Returns a string representation of the color.

Returns:

The hex color value as a string, e.g. "FF0000".

toWebHexString

public java.lang.String toWebHexString()

Returns a string representation of the color.

Returns:

The hex color value as a string, e.g. "#FF0000".