Save This Page
Home » poi-src-3.2-FINAL-20081019 » org.apache » poi » hssf » util » [javadoc | source]
org.apache.poi.hssf.util
public class: HSSFColor [javadoc | source]
java.lang.Object
   org.apache.poi.hssf.util.HSSFColor

Direct Known Subclasses:
    CORNFLOWER_BLUE, GOLD, LAVENDER, ORCHID, GREEN, BLUE, LIGHT_TURQUOISE, LEMON_CHIFFON, BRIGHT_GREEN, LIGHT_GREEN, LIGHT_ORANGE, TEAL, GREY_50_PERCENT, PALE_BLUE, BLACK, BROWN, BLUE_GREY, RED, TAN, MAROON, GREY_40_PERCENT, ROSE, PINK, YELLOW, DARK_TEAL, DARK_YELLOW, SKY_BLUE, WHITE, DARK_GREEN, DARK_BLUE, LIGHT_YELLOW, LIGHT_BLUE, SEA_GREEN, CORAL, DARK_RED, INDIGO, OLIVE_GREEN, VIOLET, AQUA, ROYAL_BLUE, PLUM, TURQUOISE, CustomColor, AUTOMATIC, GREY_25_PERCENT, LIGHT_CORNFLOWER_BLUE, LIME, ORANGE, GREY_80_PERCENT

Intends to provide support for the very evil index to triplet issue and will likely replace the color constants interface for HSSF 2.0. This class contains static inner class members for representing colors. Each color has an index (for the standard palette in Excel (tm) ), native (RGB) triplet and string triplet. The string triplet is as the color would be represented by Gnumeric. Having (string) this here is a bit of a collusion of function between HSSF and the HSSFSerializer but I think its a reasonable one in this case.
Nested Class Summary:
public static final class  HSSFColor.BLACK  Class BLACK 
public static final class  HSSFColor.BROWN  Class BROWN 
public static class  HSSFColor.OLIVE_GREEN  Class OLIVE_GREEN 
public static final class  HSSFColor.DARK_GREEN  Class DARK_GREEN 
public static final class  HSSFColor.DARK_TEAL  Class DARK_TEAL 
public static final class  HSSFColor.DARK_BLUE  Class DARK_BLUE 
public static final class  HSSFColor.INDIGO  Class INDIGO 
public static final class  HSSFColor.GREY_80_PERCENT  Class GREY_80_PERCENT 
public static final class  HSSFColor.DARK_RED  Class DARK_RED 
public static final class  HSSFColor.ORANGE  Class ORANGE 
public static final class  HSSFColor.DARK_YELLOW  Class DARK_YELLOW 
public static final class  HSSFColor.GREEN  Class GREEN 
public static final class  HSSFColor.TEAL  Class TEAL 
public static final class  HSSFColor.BLUE  Class BLUE 
public static final class  HSSFColor.BLUE_GREY  Class BLUE_GREY 
public static final class  HSSFColor.GREY_50_PERCENT  Class GREY_50_PERCENT 
public static final class  HSSFColor.RED  Class RED 
public static final class  HSSFColor.LIGHT_ORANGE  Class LIGHT_ORANGE 
public static final class  HSSFColor.LIME  Class LIME 
public static final class  HSSFColor.SEA_GREEN  Class SEA_GREEN 
public static final class  HSSFColor.AQUA  Class AQUA 
public static final class  HSSFColor.LIGHT_BLUE  Class LIGHT_BLUE 
public static final class  HSSFColor.VIOLET  Class VIOLET 
public static final class  HSSFColor.GREY_40_PERCENT  Class GREY_40_PERCENT 
public static final class  HSSFColor.PINK  Class PINK 
public static final class  HSSFColor.GOLD  Class GOLD 
public static final class  HSSFColor.YELLOW  Class YELLOW 
public static final class  HSSFColor.BRIGHT_GREEN  Class BRIGHT_GREEN 
public static final class  HSSFColor.TURQUOISE  Class TURQUOISE 
public static final class  HSSFColor.SKY_BLUE  Class SKY_BLUE 
public static final class  HSSFColor.PLUM  Class PLUM 
public static final class  HSSFColor.GREY_25_PERCENT  Class GREY_25_PERCENT 
public static final class  HSSFColor.ROSE  Class ROSE 
public static final class  HSSFColor.TAN  Class TAN 
public static final class  HSSFColor.LIGHT_YELLOW  Class LIGHT_YELLOW 
public static final class  HSSFColor.LIGHT_GREEN  Class LIGHT_GREEN 
public static final class  HSSFColor.LIGHT_TURQUOISE  Class LIGHT_TURQUOISE 
public static final class  HSSFColor.PALE_BLUE  Class PALE_BLUE 
public static final class  HSSFColor.LAVENDER  Class LAVENDER 
public static final class  HSSFColor.WHITE  Class WHITE 
public static final class  HSSFColor.CORNFLOWER_BLUE  Class CORNFLOWER_BLUE 
public static final class  HSSFColor.LEMON_CHIFFON  Class LEMON_CHIFFON 
public static final class  HSSFColor.MAROON  Class MAROON 
public static final class  HSSFColor.ORCHID  Class ORCHID 
public static final class  HSSFColor.CORAL  Class CORAL 
public static final class  HSSFColor.ROYAL_BLUE  Class ROYAL_BLUE 
public static final class  HSSFColor.LIGHT_CORNFLOWER_BLUE  Class LIGHT_CORNFLOWER_BLUE 
public static final class  HSSFColor.AUTOMATIC  Special Default/Normal/Automatic color.

Note: This class is NOT in the default HashTables returned by HSSFColor. The index is a special case which is interpreted in the various setXXXColor calls. 

Constructor:
 public HSSFColor() 
Method from org.apache.poi.hssf.util.HSSFColor Summary:
getHexString,   getIndex,   getIndexHash,   getTriplet,   getTripletHash
Methods from java.lang.Object:
equals,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait
Method from org.apache.poi.hssf.util.HSSFColor Detail:
 public String getHexString() 
 public short getIndex() 
 public static final Hashtable getIndexHash() 
    this function returns all colors in a hastable. Its not implemented as a static member/staticly initialized because that would be dirty in a server environment as it is intended. This means you'll eat the time it takes to create it once per request but you will not hold onto it if you have none of those requests.
 public short[] getTriplet() 
 public static final Hashtable getTripletHash() 
    this function returns all colors in a hastable. Its not implemented as a static member/staticly initialized because that would be dirty in a server environment as it is intended. This means you'll eat the time it takes to create it once per request but you will not hold onto it if you have none of those requests.