net.slashie.libjcsi
Class CSIColor

java.lang.Object
  net.slashie.libjcsi.CSIColor

All Implemented Interfaces:

java.lang.Comparable

public class CSIColor
extends java.lang.Object
implements java.lang.Comparable

Allows for the use of custom colors. These colors are comparable for equality but the ordering of them has more to do with saturation than color, so if placed in order the output may not be what is expected. Has both a small pallet called DEFAULT_PALLET which contains the basic 16 colors from curses implementations. Has an extended pallet called FULL_PALLET which contains a wide variety of custom named colors. Can be used to make any color with aRGB values from 0-255.

Author:

Santiago Zapata, Eben Howard

Field Summary

static CSIColor	ALICE_BLUE
static CSIColor	ALIZARIN
static CSIColor	AMARANTH
static CSIColor	AMBER
static CSIColor	AMETHYST
static CSIColor	APRICOT
static CSIColor	AQUA
static CSIColor	AQUAMARINE
static CSIColor	ARMY_GREEN
static CSIColor	ASPARAGUS
static CSIColor	ATOMIC_TANGERINE
static CSIColor	AUBURN
static CSIColor	AZUL
static CSIColor	AZURE
static CSIColor	BABY_BLUE
static CSIColor	BEIGE
static CSIColor	BISTRE
static CSIColor	BLACK
static CSIColor	BLUE
static CSIColor	BLUE_GREEN
static CSIColor	BLUE_VIOLET
static CSIColor	BONDI_BLUE
static CSIColor	BRASS
static CSIColor	BRIGHT_GREEN
static CSIColor	BRIGHT_PINK
static CSIColor	BRIGHT_TURQUOISE
static CSIColor	BRILLIANT_ROSE
static CSIColor	BRONZE
static CSIColor	BROWN
static CSIColor	BROWNER
static CSIColor	BUFF
static CSIColor	BURGUNDY
static CSIColor	BURNT_ORANGE
static CSIColor	BURNT_SIENNA
static CSIColor	BURNT_UMBER
static CSIColor	CAMO_GREEN
static CSIColor	CAPUT_MORTUUM
static CSIColor	CARDINAL
static CSIColor	CARMINE
static CSIColor	CARNATION_PINK
static CSIColor	CAROLINA_BLUE
static CSIColor	CARROT_ORANGE
static CSIColor	CELADON
static CSIColor	CERISE
static CSIColor	CERULEAN
static CSIColor	CERULEAN_BLUE
static CSIColor	CHARTREUSE
static CSIColor	CHARTREUSE_GREEN
static CSIColor	CHERRY_BLOSSOM
static CSIColor	CHESTNUT
static CSIColor	CHOCOLATE
static CSIColor	CINNABAR
static CSIColor	CINNAMON
static CSIColor	COBALT
static CSIColor	COLUMBIA_BLUE
static CSIColor	COPPER
static CSIColor	COPPER_ROSE
static CSIColor	CORAL
static CSIColor	CORAL_RED
static CSIColor	CORN
static CSIColor	CORNFLOWER_BLUE
static CSIColor	COSMIC_LATTE
static CSIColor	CREAM
static CSIColor	CRIMSON
static CSIColor	CYAN
static CSIColor	DARK_BLUE
static CSIColor	DARK_BROWN
static CSIColor	DARK_CERULEAN
static CSIColor	DARK_CHESTNUT
static CSIColor	DARK_CORAL
static CSIColor	DARK_GOLDENROD
static CSIColor	DARK_GRAY
static CSIColor	DARK_GREEN
static CSIColor	DARK_KHAKI
static CSIColor	DARK_PASTEL_GREEN
static CSIColor	DARK_PINK
static CSIColor	DARK_RED
static CSIColor	DARK_SALMON
static CSIColor	DARK_SCARLET
static CSIColor	DARK_SLATE_GRAY
static CSIColor	DARK_SPRING_GREEN
static CSIColor	DARK_TAN
static CSIColor	DARK_TURQUOISE
static CSIColor	DARK_VIOLET
static CSIColor	DEEP_CERISE
static CSIColor	DEEP_CHESTNUT
static CSIColor	DEEP_FUCHSIA
static CSIColor	DEEP_LILAC
static CSIColor	DEEP_MAGENTA
static CSIColor	DEEP_PEACH
static CSIColor	DEEP_PINK
static CSIColor[]	DEFAULT_PALLET
static CSIColor	DENIM
static CSIColor	DODGER_BLUE
static CSIColor	ECRU
static CSIColor	EGGPLANT
static CSIColor	EGYPTIAN_BLUE
static CSIColor	ELECTRIC_BLUE
static CSIColor	ELECTRIC_GREEN
static CSIColor	ELECTRIC_INDIGO
static CSIColor	ELECTRIC_LIME
static CSIColor	ELECTRIC_PURPLE
static CSIColor	EMERALD
static CSIColor	FALU_RED
static CSIColor	FERN_GREEN
static CSIColor	FIREBRICK
static CSIColor	FLAX
static CSIColor	FOREST_GREEN
static CSIColor	FRENCH_ROSE
static CSIColor	FUCSHIA_PINK
static CSIColor[]	FULL_PALLET
static CSIColor	GAMBOGE
static CSIColor	GOLD
static CSIColor	GOLDEN
static CSIColor	GOLDEN_BROWN
static CSIColor	GOLDEN_YELLOW
static CSIColor	GOLDENROD
static CSIColor	GRAY
static CSIColor	GRAY_ASPARAGUS
static CSIColor	GREEN
static CSIColor	GREEN_YELLOW
static CSIColor	HAN_PURPLE
static CSIColor	HELIOTROPE
static CSIColor	HOLLYWOOD_CERISE
static CSIColor	HOT_MAGENTA
static CSIColor	HOT_PINK
static CSIColor	INDIGO
static CSIColor	INDIGO_DYE
static CSIColor	INTERNATIONAL_KLEIN_BLUE
static CSIColor	INTERNATIONAL_ORANGE
static CSIColor	ISLAMIC_GREEN
static CSIColor	IVORY
static CSIColor	JADE
static CSIColor	KELLY_GREEN
static CSIColor	KHAKI
static CSIColor	LAVENDER
static CSIColor	LAVENDER_BLUE
static CSIColor	LAVENDER_BLUSH
static CSIColor	LAVENDER_FLORAL
static CSIColor	LAVENDER_GRAY
static CSIColor	LAVENDER_MAGENTA
static CSIColor	LAVENDER_PINK
static CSIColor	LAVENDER_PURPLE
static CSIColor	LAVENDER_ROSE
static CSIColor	LAWN_GREEN
static CSIColor	LEMON
static CSIColor	LEMON_CHIFFON
static CSIColor	LIGHT_BLUE
static CSIColor	LIGHT_GRAY
static CSIColor	LIGHT_KHAKI
static CSIColor	LIGHT_LIME
static CSIColor	LIGHT_MAROON
static CSIColor	LIGHT_PINK
static CSIColor	LIGHT_VIOLET
static CSIColor	LILAC
static CSIColor	LIME
static CSIColor	LIME_GREEN
static CSIColor	LINEN
static CSIColor	MAGENTA
static CSIColor	MAGENTA_DYE
static CSIColor	MAGIC_MINT
static CSIColor	MAGNOLIA
static CSIColor	MALACHITE
static CSIColor	MAROON
static CSIColor	MAUVE
static CSIColor	MAUVE_TAUPE
static CSIColor	MAYA_BLUE
static CSIColor	MEDIUM_BLUE
static CSIColor	MEDIUM_CARMINE
static CSIColor	MEDIUM_LAVENDER_MAGENTA
static CSIColor	MEDIUM_PURPLE
static CSIColor	MEDIUM_SPRING_GREEN
static CSIColor	MIDNIGHT_BLUE
static CSIColor	MINT_GREEN
static CSIColor	MISTY_ROSE
static CSIColor	MOSS_GREEN
static CSIColor	MOUNTBATTEN_PINK
static CSIColor	MUSTARD
static CSIColor	MYRTLE
static CSIColor	NAVAJO_WHITE
static CSIColor	NAVY_BLUE
static CSIColor	OCHRE
static CSIColor	OLD_GOLD
static CSIColor	OLD_LACE
static CSIColor	OLD_LAVENDER
static CSIColor	OLD_ROSE
static CSIColor	OLIVE
static CSIColor	OLIVE_DRAB
static CSIColor	OLIVINE
static CSIColor	ORANGE
static CSIColor	ORANGE_PEEL
static CSIColor	ORANGE_RED
static CSIColor	ORCHID
static CSIColor	PALE_BLUE
static CSIColor	PALE_BROWN
static CSIColor	PALE_CARMINE
static CSIColor	PALE_CHESTNUT
static CSIColor	PALE_CORNFLOWER_BLUE
static CSIColor	PALE_MAGENTA
static CSIColor	PALE_PINK
static CSIColor	PALE_RED_VIOLET
static CSIColor	PAPAYA_WHIP
static CSIColor	PASTEL_GREEN
static CSIColor	PASTEL_PINK
static CSIColor	PEACH
static CSIColor	PEACH_ORANGE
static CSIColor	PEACH_YELLOW
static CSIColor	PEAR
static CSIColor	PERIWINKLE
static CSIColor	PERSIAN_BLUE
static CSIColor	PERSIAN_GREEN
static CSIColor	PERSIAN_INDIGO
static CSIColor	PERSIAN_PINK
static CSIColor	PERSIAN_RED
static CSIColor	PERSIAN_ROSE
static CSIColor	PERSIMMON
static CSIColor	PIGMENT_BLUE
static CSIColor	PINE_GREEN
static CSIColor	PINK
static CSIColor	PINK_ORANGE
static CSIColor	PLATINUM
static CSIColor	PLUM
static CSIColor	POWDER_BLUE
static CSIColor	PRUSSIAN_BLUE
static CSIColor	PSYCHEDELIC_PURPLE
static CSIColor	PUCE
static CSIColor	PUMPKIN
static CSIColor	PURPLE
static CSIColor	PURPLE_TAUPE
static CSIColor	RAW_UMBER
static CSIColor	RAZZMATAZZ
static CSIColor	RED
static CSIColor	RED_PIGMENT
static CSIColor	RED_VIOLET
static CSIColor	RICH_CARMINE
static CSIColor	ROBIN_EGG_BLUE
static CSIColor	ROSE
static CSIColor	ROSE_MADDER
static CSIColor	ROSE_TAUPE
static CSIColor	ROYAL_BLUE
static CSIColor	ROYAL_PURPLE
static CSIColor	RUBY
static CSIColor	RUSSET
static CSIColor	RUST
static CSIColor	SAFETY_ORANGE
static CSIColor	SAFFRON
static CSIColor	SALMON
static CSIColor	SANDY_BROWN
static CSIColor	SANGRIA
static CSIColor	SAPPHIRE
static CSIColor	SCARLET
static CSIColor	SCHOOL_BUS_YELLOW
static CSIColor	SEA_GREEN
static CSIColor	SEASHELL
static CSIColor	SELECTIVE_YELLOW
static CSIColor	SEPIA
static CSIColor	SHAMROCK_GREEN
static CSIColor	SHOCKING_PINK
static CSIColor	SILVER
static CSIColor	SKY_BLUE
static CSIColor	SLATE_GRAY
static CSIColor	SMALT
static CSIColor	SPRING_BUD
static CSIColor	SPRING_GREEN
static CSIColor	STEEL_BLUE
static CSIColor	TAN
static CSIColor	TANGERINE
static CSIColor	TANGERINE_YELLOW
static CSIColor	TAUPE
static CSIColor	TAWNY
static CSIColor	TEA_GREEN
static CSIColor	TEA_ORANGE
static CSIColor	TEA_ROSE
static CSIColor	TEAL
static CSIColor	TERRA_COTTA
static CSIColor	THISTLE
static CSIColor	TOMATO
static CSIColor	TRUE_PINK
static CSIColor	TURQUOISE
static CSIColor	TYRIAN_PURPLE
static CSIColor	ULTRAMARINE
static CSIColor	VEGAS_GOLD
static CSIColor	VERMILION
static CSIColor	VIOLET
static CSIColor	VIRIDIAN
static CSIColor	WHEAT
static CSIColor	WHITE
static CSIColor	WISTERIA
static CSIColor	YELLOW
static CSIColor	YELLOW_GREEN
static CSIColor	ZINNWALDITE

Constructor Summary

CSIColor()
A constructor with no passed values.

CSIColor(CSIColor color)
A constructor which builds a new color based on an existing color.

CSIColor(int hex)
A constructor which builds a new color based on a hex value which represents bit shifted values for aRGB color space.

CSIColor(int pr, int pg, int pb)
A constructor with information for just RGB values.

CSIColor(int pr, int pg, int pb, int pa)
A constructor with information for all color channels in the aRGB colorspace.

Method Summary

int	compareTo(CSIColor color) Compares the current color to another color.
int	compareTo(java.lang.Object arg0) Compares the current color to another object of any type.
boolean	equals(CSIColor b) Compares current color to passed in color to determine if they are equal.
int	getA()
int	getB()
int	getCodeFromColor(CSIColor color) Attempts to return the index of the passed in color in the default pallet.
int	getColor()
int	getColor(java.lang.String colorName) Allows you to get an int that is the array position of the String color name passed in within the default pallet.
CSIColor	getColorFromCode(int code) Attempts to return a CSIColor object from the default pallet.
int	getG()
int	getR()
void	setA(int a) Sets the value of the alpha channel (or transparency) of the color. 0 is transparent. 255 is opaque or solid.
void	setB(int b) Sets the value of the blue component of the color.
void	setColor(int color) Set the value of current color equal to an existing color.
void	setG(int g) Sets the value of the green component of the color.
void	setR(int r) Sets the value of the red component of the color.

Methods inherited from class java.lang.Object

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

Field Detail

BLACK

public static final CSIColor BLACK

BLUE

public static final CSIColor BLUE

BROWN

public static final CSIColor BROWN

CYAN

public static final CSIColor CYAN

DARK_BLUE

public static final CSIColor DARK_BLUE

DARK_GRAY

public static final CSIColor DARK_GRAY

DARK_RED

public static final CSIColor DARK_RED

GRAY

public static final CSIColor GRAY

GREEN

public static final CSIColor GREEN

LIME

public static final CSIColor LIME

LIGHT_GRAY

public static final CSIColor LIGHT_GRAY

MAGENTA

public static final CSIColor MAGENTA

ORANGE

public static final CSIColor ORANGE

PINK

public static final CSIColor PINK

PURPLE

public static final CSIColor PURPLE

TEAL

public static final CSIColor TEAL

RED

public static final CSIColor RED

WHITE

public static final CSIColor WHITE

YELLOW

public static final CSIColor YELLOW

ALICE_BLUE

public static final CSIColor ALICE_BLUE

ALIZARIN

public static final CSIColor ALIZARIN

AMARANTH

public static final CSIColor AMARANTH

AMBER

public static final CSIColor AMBER

AMETHYST

public static final CSIColor AMETHYST

APRICOT

public static final CSIColor APRICOT

AQUA

public static final CSIColor AQUA

AQUAMARINE

public static final CSIColor AQUAMARINE

ARMY_GREEN

public static final CSIColor ARMY_GREEN

ASPARAGUS

public static final CSIColor ASPARAGUS

ATOMIC_TANGERINE

public static final CSIColor ATOMIC_TANGERINE

AUBURN

public static final CSIColor AUBURN

AZUL

public static final CSIColor AZUL

AZURE

public static final CSIColor AZURE

BABY_BLUE

public static final CSIColor BABY_BLUE

BEIGE

public static final CSIColor BEIGE

BISTRE

public static final CSIColor BISTRE

PIGMENT_BLUE

public static final CSIColor PIGMENT_BLUE

BLUE_GREEN

public static final CSIColor BLUE_GREEN

BLUE_VIOLET

public static final CSIColor BLUE_VIOLET

BONDI_BLUE

public static final CSIColor BONDI_BLUE

BRASS

public static final CSIColor BRASS

BRIGHT_GREEN

public static final CSIColor BRIGHT_GREEN

BRIGHT_PINK

public static final CSIColor BRIGHT_PINK

BRIGHT_TURQUOISE

public static final CSIColor BRIGHT_TURQUOISE

BRILLIANT_ROSE

public static final CSIColor BRILLIANT_ROSE

BRONZE

public static final CSIColor BRONZE

BROWNER

public static final CSIColor BROWNER

BUFF

public static final CSIColor BUFF

BURGUNDY

public static final CSIColor BURGUNDY

BURNT_ORANGE

public static final CSIColor BURNT_ORANGE

BURNT_SIENNA

public static final CSIColor BURNT_SIENNA

BURNT_UMBER

public static final CSIColor BURNT_UMBER

CAMO_GREEN

public static final CSIColor CAMO_GREEN

CAPUT_MORTUUM

public static final CSIColor CAPUT_MORTUUM

CARDINAL

public static final CSIColor CARDINAL

CARMINE

public static final CSIColor CARMINE

CARNATION_PINK

public static final CSIColor CARNATION_PINK

CAROLINA_BLUE

public static final CSIColor CAROLINA_BLUE

CARROT_ORANGE

public static final CSIColor CARROT_ORANGE

CELADON

public static final CSIColor CELADON

CERISE

public static final CSIColor CERISE

CERULEAN

public static final CSIColor CERULEAN

CERULEAN_BLUE

public static final CSIColor CERULEAN_BLUE

CHARTREUSE

public static final CSIColor CHARTREUSE

CHARTREUSE_GREEN

public static final CSIColor CHARTREUSE_GREEN

CHERRY_BLOSSOM

public static final CSIColor CHERRY_BLOSSOM

CHESTNUT

public static final CSIColor CHESTNUT

CHOCOLATE

public static final CSIColor CHOCOLATE

CINNABAR

public static final CSIColor CINNABAR

CINNAMON

public static final CSIColor CINNAMON

COBALT

public static final CSIColor COBALT

COLUMBIA_BLUE

public static final CSIColor COLUMBIA_BLUE

COPPER

public static final CSIColor COPPER

COPPER_ROSE

public static final CSIColor COPPER_ROSE

CORAL

public static final CSIColor CORAL

CORAL_RED

public static final CSIColor CORAL_RED

CORN

public static final CSIColor CORN

CORNFLOWER_BLUE

public static final CSIColor CORNFLOWER_BLUE

COSMIC_LATTE

public static final CSIColor COSMIC_LATTE

CREAM

public static final CSIColor CREAM

CRIMSON

public static final CSIColor CRIMSON

DARK_BROWN

public static final CSIColor DARK_BROWN

DARK_CERULEAN

public static final CSIColor DARK_CERULEAN

DARK_CHESTNUT

public static final CSIColor DARK_CHESTNUT

DARK_CORAL

public static final CSIColor DARK_CORAL

DARK_GOLDENROD

public static final CSIColor DARK_GOLDENROD

DARK_GREEN

public static final CSIColor DARK_GREEN

DARK_KHAKI

public static final CSIColor DARK_KHAKI

DARK_PASTEL_GREEN

public static final CSIColor DARK_PASTEL_GREEN

DARK_PINK

public static final CSIColor DARK_PINK

DARK_SCARLET

public static final CSIColor DARK_SCARLET

DARK_SALMON

public static final CSIColor DARK_SALMON

DARK_SLATE_GRAY

public static final CSIColor DARK_SLATE_GRAY

DARK_SPRING_GREEN

public static final CSIColor DARK_SPRING_GREEN

DARK_TAN

public static final CSIColor DARK_TAN

DARK_TURQUOISE

public static final CSIColor DARK_TURQUOISE

DARK_VIOLET

public static final CSIColor DARK_VIOLET

DEEP_CERISE

public static final CSIColor DEEP_CERISE

DEEP_CHESTNUT

public static final CSIColor DEEP_CHESTNUT

DEEP_FUCHSIA

public static final CSIColor DEEP_FUCHSIA

DEEP_LILAC

public static final CSIColor DEEP_LILAC

DEEP_MAGENTA

public static final CSIColor DEEP_MAGENTA

DEEP_PEACH

public static final CSIColor DEEP_PEACH

DEEP_PINK

public static final CSIColor DEEP_PINK

DENIM

public static final CSIColor DENIM

DODGER_BLUE

public static final CSIColor DODGER_BLUE

ECRU

public static final CSIColor ECRU

EGYPTIAN_BLUE

public static final CSIColor EGYPTIAN_BLUE

ELECTRIC_BLUE

public static final CSIColor ELECTRIC_BLUE

ELECTRIC_GREEN

public static final CSIColor ELECTRIC_GREEN

ELECTRIC_INDIGO

public static final CSIColor ELECTRIC_INDIGO

ELECTRIC_LIME

public static final CSIColor ELECTRIC_LIME

ELECTRIC_PURPLE

public static final CSIColor ELECTRIC_PURPLE

EMERALD

public static final CSIColor EMERALD

EGGPLANT

public static final CSIColor EGGPLANT

FALU_RED

public static final CSIColor FALU_RED

FERN_GREEN

public static final CSIColor FERN_GREEN

FIREBRICK

public static final CSIColor FIREBRICK

FLAX

public static final CSIColor FLAX

FOREST_GREEN

public static final CSIColor FOREST_GREEN

FRENCH_ROSE

public static final CSIColor FRENCH_ROSE

FUCSHIA_PINK

public static final CSIColor FUCSHIA_PINK

GAMBOGE

public static final CSIColor GAMBOGE

GOLD

public static final CSIColor GOLD

GOLDEN

public static final CSIColor GOLDEN

GOLDEN_BROWN

public static final CSIColor GOLDEN_BROWN

GOLDEN_YELLOW

public static final CSIColor GOLDEN_YELLOW

GOLDENROD

public static final CSIColor GOLDENROD

GRAY_ASPARAGUS

public static final CSIColor GRAY_ASPARAGUS

GREEN_YELLOW

public static final CSIColor GREEN_YELLOW

HAN_PURPLE

public static final CSIColor HAN_PURPLE

HELIOTROPE

public static final CSIColor HELIOTROPE

HOLLYWOOD_CERISE

public static final CSIColor HOLLYWOOD_CERISE

HOT_MAGENTA

public static final CSIColor HOT_MAGENTA

HOT_PINK

public static final CSIColor HOT_PINK

INDIGO_DYE

public static final CSIColor INDIGO_DYE

INDIGO

public static final CSIColor INDIGO

INTERNATIONAL_KLEIN_BLUE

public static final CSIColor INTERNATIONAL_KLEIN_BLUE

INTERNATIONAL_ORANGE

public static final CSIColor INTERNATIONAL_ORANGE

ISLAMIC_GREEN

public static final CSIColor ISLAMIC_GREEN

IVORY

public static final CSIColor IVORY

JADE

public static final CSIColor JADE

KELLY_GREEN

public static final CSIColor KELLY_GREEN

KHAKI

public static final CSIColor KHAKI

LIGHT_KHAKI

public static final CSIColor LIGHT_KHAKI

LAVENDER_FLORAL

public static final CSIColor LAVENDER_FLORAL

LAVENDER

public static final CSIColor LAVENDER

LAVENDER_BLUE

public static final CSIColor LAVENDER_BLUE

LAVENDER_BLUSH

public static final CSIColor LAVENDER_BLUSH

LAVENDER_GRAY

public static final CSIColor LAVENDER_GRAY

LAVENDER_MAGENTA

public static final CSIColor LAVENDER_MAGENTA

LAVENDER_PINK

public static final CSIColor LAVENDER_PINK

LAVENDER_PURPLE

public static final CSIColor LAVENDER_PURPLE

LAVENDER_ROSE

public static final CSIColor LAVENDER_ROSE

LAWN_GREEN

public static final CSIColor LAWN_GREEN

LEMON_CHIFFON

public static final CSIColor LEMON_CHIFFON

LIGHT_BLUE

public static final CSIColor LIGHT_BLUE

LIGHT_PINK

public static final CSIColor LIGHT_PINK

LILAC

public static final CSIColor LILAC

LEMON

public static final CSIColor LEMON

LIGHT_LIME

public static final CSIColor LIGHT_LIME

LIME_GREEN

public static final CSIColor LIME_GREEN

LINEN

public static final CSIColor LINEN

MAGENTA_DYE

public static final CSIColor MAGENTA_DYE

MAGIC_MINT

public static final CSIColor MAGIC_MINT

MAGNOLIA

public static final CSIColor MAGNOLIA

MALACHITE

public static final CSIColor MALACHITE

MAROON

public static final CSIColor MAROON

LIGHT_MAROON

public static final CSIColor LIGHT_MAROON

MAYA_BLUE

public static final CSIColor MAYA_BLUE

MAUVE

public static final CSIColor MAUVE

MAUVE_TAUPE

public static final CSIColor MAUVE_TAUPE

MEDIUM_BLUE

public static final CSIColor MEDIUM_BLUE

MEDIUM_CARMINE

public static final CSIColor MEDIUM_CARMINE

MEDIUM_LAVENDER_MAGENTA

public static final CSIColor MEDIUM_LAVENDER_MAGENTA

MEDIUM_PURPLE

public static final CSIColor MEDIUM_PURPLE

MEDIUM_SPRING_GREEN

public static final CSIColor MEDIUM_SPRING_GREEN

MIDNIGHT_BLUE

public static final CSIColor MIDNIGHT_BLUE

MINT_GREEN

public static final CSIColor MINT_GREEN

MISTY_ROSE

public static final CSIColor MISTY_ROSE

MOSS_GREEN

public static final CSIColor MOSS_GREEN

MOUNTBATTEN_PINK

public static final CSIColor MOUNTBATTEN_PINK

MUSTARD

public static final CSIColor MUSTARD

MYRTLE

public static final CSIColor MYRTLE

NAVAJO_WHITE

public static final CSIColor NAVAJO_WHITE

NAVY_BLUE

public static final CSIColor NAVY_BLUE

OCHRE

public static final CSIColor OCHRE

OLD_GOLD

public static final CSIColor OLD_GOLD

OLD_LACE

public static final CSIColor OLD_LACE

OLD_LAVENDER

public static final CSIColor OLD_LAVENDER

OLD_ROSE

public static final CSIColor OLD_ROSE

OLIVE

public static final CSIColor OLIVE

OLIVE_DRAB

public static final CSIColor OLIVE_DRAB

OLIVINE

public static final CSIColor OLIVINE

ORANGE_PEEL

public static final CSIColor ORANGE_PEEL

ORANGE_RED

public static final CSIColor ORANGE_RED

ORCHID

public static final CSIColor ORCHID

PALE_BLUE

public static final CSIColor PALE_BLUE

PALE_BROWN

public static final CSIColor PALE_BROWN

PALE_CARMINE

public static final CSIColor PALE_CARMINE

PALE_CHESTNUT

public static final CSIColor PALE_CHESTNUT

PALE_CORNFLOWER_BLUE

public static final CSIColor PALE_CORNFLOWER_BLUE

PALE_MAGENTA

public static final CSIColor PALE_MAGENTA

PALE_PINK

public static final CSIColor PALE_PINK

PALE_RED_VIOLET

public static final CSIColor PALE_RED_VIOLET

PAPAYA_WHIP

public static final CSIColor PAPAYA_WHIP

PASTEL_GREEN

public static final CSIColor PASTEL_GREEN

PASTEL_PINK

public static final CSIColor PASTEL_PINK

PEACH

public static final CSIColor PEACH

PEACH_ORANGE

public static final CSIColor PEACH_ORANGE

PEACH_YELLOW

public static final CSIColor PEACH_YELLOW

PEAR

public static final CSIColor PEAR

PERIWINKLE

public static final CSIColor PERIWINKLE

PERSIAN_BLUE

public static final CSIColor PERSIAN_BLUE

PERSIAN_GREEN

public static final CSIColor PERSIAN_GREEN

PERSIAN_INDIGO

public static final CSIColor PERSIAN_INDIGO

PERSIAN_RED

public static final CSIColor PERSIAN_RED

PERSIAN_PINK

public static final CSIColor PERSIAN_PINK

PERSIAN_ROSE

public static final CSIColor PERSIAN_ROSE

PERSIMMON

public static final CSIColor PERSIMMON

PINE_GREEN

public static final CSIColor PINE_GREEN

TRUE_PINK

public static final CSIColor TRUE_PINK

PINK_ORANGE

public static final CSIColor PINK_ORANGE

PLATINUM

public static final CSIColor PLATINUM

PLUM

public static final CSIColor PLUM

POWDER_BLUE

public static final CSIColor POWDER_BLUE

PUCE

public static final CSIColor PUCE

PRUSSIAN_BLUE

public static final CSIColor PRUSSIAN_BLUE

PSYCHEDELIC_PURPLE

public static final CSIColor PSYCHEDELIC_PURPLE

PUMPKIN

public static final CSIColor PUMPKIN

PURPLE_TAUPE

public static final CSIColor PURPLE_TAUPE

RAW_UMBER

public static final CSIColor RAW_UMBER

RAZZMATAZZ

public static final CSIColor RAZZMATAZZ

RED_PIGMENT

public static final CSIColor RED_PIGMENT

RED_VIOLET

public static final CSIColor RED_VIOLET

RICH_CARMINE

public static final CSIColor RICH_CARMINE

ROBIN_EGG_BLUE

public static final CSIColor ROBIN_EGG_BLUE

ROSE

public static final CSIColor ROSE

ROSE_MADDER

public static final CSIColor ROSE_MADDER

ROSE_TAUPE

public static final CSIColor ROSE_TAUPE

ROYAL_BLUE

public static final CSIColor ROYAL_BLUE

ROYAL_PURPLE

public static final CSIColor ROYAL_PURPLE

RUBY

public static final CSIColor RUBY

RUSSET

public static final CSIColor RUSSET

RUST

public static final CSIColor RUST

SAFETY_ORANGE

public static final CSIColor SAFETY_ORANGE

SAFFRON

public static final CSIColor SAFFRON

SALMON

public static final CSIColor SALMON

SANDY_BROWN

public static final CSIColor SANDY_BROWN

SANGRIA

public static final CSIColor SANGRIA

SAPPHIRE

public static final CSIColor SAPPHIRE

SCARLET

public static final CSIColor SCARLET

SCHOOL_BUS_YELLOW

public static final CSIColor SCHOOL_BUS_YELLOW

SEA_GREEN

public static final CSIColor SEA_GREEN

SEASHELL

public static final CSIColor SEASHELL

SELECTIVE_YELLOW

public static final CSIColor SELECTIVE_YELLOW

SEPIA

public static final CSIColor SEPIA

SHAMROCK_GREEN

public static final CSIColor SHAMROCK_GREEN

SHOCKING_PINK

public static final CSIColor SHOCKING_PINK

SILVER

public static final CSIColor SILVER

SKY_BLUE

public static final CSIColor SKY_BLUE

SLATE_GRAY

public static final CSIColor SLATE_GRAY

SMALT

public static final CSIColor SMALT

SPRING_BUD

public static final CSIColor SPRING_BUD

SPRING_GREEN

public static final CSIColor SPRING_GREEN

STEEL_BLUE

public static final CSIColor STEEL_BLUE

TAN

public static final CSIColor TAN

TANGERINE

public static final CSIColor TANGERINE

TANGERINE_YELLOW

public static final CSIColor TANGERINE_YELLOW

TAUPE

public static final CSIColor TAUPE

TEA_GREEN

public static final CSIColor TEA_GREEN

TEA_ORANGE

public static final CSIColor TEA_ORANGE

TEA_ROSE

public static final CSIColor TEA_ROSE

TAWNY

public static final CSIColor TAWNY

TERRA_COTTA

public static final CSIColor TERRA_COTTA

THISTLE

public static final CSIColor THISTLE

TOMATO

public static final CSIColor TOMATO

TURQUOISE

public static final CSIColor TURQUOISE

TYRIAN_PURPLE

public static final CSIColor TYRIAN_PURPLE

ULTRAMARINE

public static final CSIColor ULTRAMARINE

VEGAS_GOLD

public static final CSIColor VEGAS_GOLD

VERMILION

public static final CSIColor VERMILION

VIOLET

public static final CSIColor VIOLET

LIGHT_VIOLET

public static final CSIColor LIGHT_VIOLET

VIRIDIAN

public static final CSIColor VIRIDIAN

WHEAT

public static final CSIColor WHEAT

WISTERIA

public static final CSIColor WISTERIA

YELLOW_GREEN

public static final CSIColor YELLOW_GREEN

ZINNWALDITE

public static final CSIColor ZINNWALDITE

FULL_PALLET

public static CSIColor[] FULL_PALLET

DEFAULT_PALLET

public static CSIColor[] DEFAULT_PALLET

Constructor Detail

CSIColor

public CSIColor(int pr,
                int pg,
                int pb,
                int pa)

A constructor with information for all color channels in the aRGB colorspace. All values should be between 0 and 255, with 0 be none and 255 being max of that color.

Parameters:

pr - Red value

pg - Green value

pb - Blue value

pa - Alpha (or transparency) value, with 255 being fully opaque and 0 being fully transparent

CSIColor

public CSIColor(int pr,
                int pg,
                int pb)

A constructor with information for just RGB values. The alpha value is assumed to be 255 for full opaqueness.

Parameters:

pr - Red Value

pg - Green Value

pb - Blue Value

CSIColor

public CSIColor()

A constructor with no passed values. Builds a white (opaque all channels) object.

CSIColor

public CSIColor(CSIColor color)

A constructor which builds a new color based on an existing color.

Parameters:

color - The color who's value should be copied for the new color.

CSIColor

public CSIColor(int hex)

A constructor which builds a new color based on a hex value which represents bit shifted values for aRGB color space.

Parameters:

hex -

Method Detail

equals

public boolean equals(CSIColor b)

Compares current color to passed in color to determine if they are equal.

Parameters:

b - Color to compare to

Returns:

true if equal in value

setColor

public void setColor(int color)

Set the value of current color equal to an existing color.

Parameters:

color - The existing color to set current color equal to.

getColor

public int getColor()

Returns:

color's hex value

getR

public int getR()

Returns:

value of red pulled out

setR

public void setR(int r)

Sets the value of the red component of the color.

Parameters:

r - the value that red should become

getG

public int getG()

Returns:

green value seperated out

setG

public void setG(int g)

Sets the value of the green component of the color.

Parameters:

g - the value that green should become

getB

public int getB()

Returns:

blue value seperated out

setB

public void setB(int b)

Sets the value of the blue component of the color.

Parameters:

b - the value that blue should become

getA

public int getA()

Returns:

alpha (or transparency) value seperated

setA

public void setA(int a)

Sets the value of the alpha channel (or transparency) of the color. 0 is transparent. 255 is opaque or solid.

Parameters:

a - the value that alpha should become

getColor

public int getColor(java.lang.String colorName)

Allows you to get an int that is the array position of the String color name passed in within the default pallet. If the String is not in the default pallet then a -1 is returned.

Parameters:

colorName - the String to get information on

Returns:

the position of the color named by the String or -1 if no such color

getColorFromCode

public CSIColor getColorFromCode(int code)

Attempts to return a CSIColor object from the default pallet. If the int passed in is to large or small for a position in the default pallet then CSIColor.BLACK is returned instead.

Parameters:

code - the pallet position whose color is to be returned

Returns:

the color in the position at code or BLACK if code is outside the default pallet

getCodeFromColor

public int getCodeFromColor(CSIColor color)

Attempts to return the index of the passed in color in the default pallet. If the color is not in the default pallet then it will return -1.

Parameters:

color - the color to search the default pallet for

Returns:

either the default pallet index matching the color or -1 if no match

compareTo

public int compareTo(CSIColor color)

Compares the current color to another color. Comparision is not guaranteed to lead to a logical color ordering that may be expected.

Parameters:

color - new color to compare with current color

Returns:

indicator of comparison between colors

compareTo

public int compareTo(java.lang.Object arg0)

Compares the current color to another object of any type. If the second object is not a CSIColor object than an exception will be thrown.

Specified by:

compareTo in interface java.lang.Comparable

Parameters:

arg0 - second object to be compared to

Returns:

indicator of comparison between colors

Throws:

java.lang.UnsupportedOperationException - if second object not a CSIColor object