颜色类HSSFColor

最新推荐文章于 2023-05-23 14:38:04 发布

原创最新推荐文章于 2023-05-23 14:38:04 发布 · 8.7k 阅读

6 ·

CC 4.0 BY-SA版权

文章标签：

#POI颜色 #HSSFColor #Color

POI - HSSF - 3.17 专栏收录该内容

22 篇文章

订阅专栏

1.HSSFColor

/**
 * 1.旨在为三元组非常恶劣的索引问题提供支持，并可能会用枚举替代HSSF 2.0的色彩常数接口。
 * 2.此类包含用于表示颜色的静态内部类成员。
 * 3.每个颜色都有一个索引（对于Excel（tm）中的标准调色板HSSFPalette）,本地（RGB）三元组和字符串三元组。 字符串三元组的颜色将由Gnumeric表示。
 *   这有字符串三元组，是HSSF和HSSFSerializer之间的一个功能的冲突，但我认为这是合理的。
 *
 * 4.本类根据给定的颜色的调色板索引（和可选的第二个索引），预定义了一些颜色HSSFColors
 * @since POI 3.16 beta 2
 */
public class HSSFColor implements Color {
    private static Map<Integer,HSSFColor> indexHash;
	// 记录预定义的颜色
    private static Map<HSSFColorPredefined,HSSFColor> enumList;

	// 颜色
    private java.awt.Color color;
	// 颜色的调色板索引
    private int index;
	// 颜色的可选第二索引
    private int index2;

    /**
     * 用枚举预定义的一些颜色，替代之前用静态内部类预定义的颜色
     */
    public enum HSSFColorPredefined {
	.....
	}
	
	/*
	 * 创建一个默认的新的HSSFColor实例
	 * 默认颜色：黑色
	 * 黑色在调色板中索引：0x40, 可选第二索引为：-1
	 */
    public HSSFColor() {
        // automatic index
        this(0x40, -1, java.awt.Color.BLACK);
    }

	/**
	 * 创建一个新的HSSFColor实例
	 * @param index 颜色在调色板中索引
	 * @param index2 可选第二索引
	 * @param color java中颜色实例对象
	 */
    public HSSFColor(int index, int index2, java.awt.Color color) {
        this.index = index;
        this.index2 = index2;
        this.color = color;
    }
	
    /**
     * 返回颜色在标准调色面板中的索引值
     */
    public short getIndex() {
        return (short)index;
    }

    /**
     * 返回颜色在标准调色面板中的替代索引（即第二索引），返回-1表示没有定义第二索引
     */
    public short getIndex2() {
        return (short)index2;
    }

    /**
     * 返回颜色的三元组形式，即RGB格式(0, 0, 0)
     */
    public short [] getTriplet() {
        return new short[] { (short)color.getRed(), (short)color.getGreen(), (short)color.getBlue() };
    }

    /**
     * 返回冒号分隔的十六进制字符串："0x255:0x255:0x255", 像一个gnumeric三元组
     */
    public String getHexString() {
        return (Integer.toHexString(color.getRed()*0x101) + ":" +
               Integer.toHexString(color.getGreen()*0x101) + ":" +
               Integer.toHexString(color.getBlue()*0x101)).toUpperCase(Locale.ROOT);
    }

    /**
     * 将Color类型转换为HSSFColor类型
     * @throws IllegalArgumentException如果颜色为空或不是HSSFColor的实例
     */
    public static HSSFColor toHSSFColor(Color color) {
		/**
		 * 如果可以将任何Color转换为HSSFColor，此方法将会更有用
         * 这个方法目前唯一的好处就是抛出一个IllegalArgumentException
         * 而不是ClassCastException。
		 */
        if (color != null && !(color instanceof HSSFColor)) {
            throw new IllegalArgumentException("Only HSSFColor objects are supported");
        }
        return (HSSFColor)color;
    }
}

2.枚举类：预定义的颜色

    /**
     * 枚举预定义一些颜色
     * 并在枚举中添加一些自定义方法
     *
     * @since POI 3.16 beta 2
     */
    public enum HSSFColorPredefined {
       /*
	    * 利用构造函数传参 ：索引值index, 第二索引，颜色的RGB值
        * 通过括号赋值,而且必须有带参构造器和属性和方法，否则编译出错  
        * 赋值必须是都赋值或都不赋值，不能一部分赋值一部分不赋值  
        * 如果不赋值则不能写构造器，赋值编译也出错 
        * */  
        BLACK                (0x08,   -1, 0x000000),
        BROWN                (0x3C,   -1, 0x993300),
        OLIVE_GREEN          (0x3B,   -1, 0x333300),
        DARK_GREEN           (0x3A,   -1, 0x003300),
        DARK_TEAL            (0x38,   -1, 0x003366),
        DARK_BLUE            (0x12, 0x20, 0x000080),
        INDIGO               (0x3E,   -1, 0x333399),
        GREY_80_PERCENT      (0x3F,   -1, 0x333333),
        ORANGE               (0x35,   -1, 0xFF6600),
        DARK_YELLOW          (0x13,   -1, 0x808000),
        GREEN                (0x11,   -1, 0x008000),
        TEAL                 (0x15, 0x26, 0x008080),
        BLUE                 (0x0C, 0x27, 0x0000FF),
        BLUE_GREY            (0x36,   -1, 0x666699),
        GREY_50_PERCENT      (0x17,   -1, 0x808080),
        RED                  (0x0A,   -1, 0xFF0000),
        LIGHT_ORANGE         (0x34,   -1, 0xFF9900),
        LIME                 (0x32,   -1, 0x99CC00),
        SEA_GREEN            (0x39,   -1, 0x339966),
        AQUA                 (0x31,   -1, 0x33CCCC),
        LIGHT_BLUE           (0x30,   -1, 0x3366FF),
        VIOLET               (0x14, 0x24, 0x800080),
        GREY_40_PERCENT      (0x37,   -1, 0x969696),
        PINK                 (0x0E, 0x21, 0xFF00FF),
        GOLD                 (0x33,   -1, 0xFFCC00),
        YELLOW               (0x0D, 0x22, 0xFFFF00),
        BRIGHT_GREEN         (0x0B,   -1, 0x00FF00),
        TURQUOISE            (0x0F, 0x23, 0x00FFFF),
        DARK_RED             (0x10, 0x25, 0x800000),
        SKY_BLUE             (0x28,   -1, 0x00CCFF),
        PLUM                 (0x3D, 0x19, 0x993366),
        GREY_25_PERCENT      (0x16,   -1, 0xC0C0C0),
        ROSE                 (0x2D,   -1, 0xFF99CC),
        LIGHT_YELLOW         (0x2B,   -1, 0xFFFF99),
        LIGHT_GREEN          (0x2A,   -1, 0xCCFFCC),
        LIGHT_TURQUOISE      (0x29, 0x1B, 0xCCFFFF),
        PALE_BLUE            (0x2C,   -1, 0x99CCFF),
        LAVENDER             (0x2E,   -1, 0xCC99FF),
        WHITE                (0x09,   -1, 0xFFFFFF),
        CORNFLOWER_BLUE      (0x18,   -1, 0x9999FF),
        LEMON_CHIFFON        (0x1A,   -1, 0xFFFFCC),
        MAROON               (0x19,   -1, 0x7F0000),
        ORCHID               (0x1C,   -1, 0x660066),
        CORAL                (0x1D,   -1, 0xFF8080),
        ROYAL_BLUE           (0x1E,   -1, 0x0066CC),
        LIGHT_CORNFLOWER_BLUE(0x1F,   -1, 0xCCCCFF),
        TAN                  (0x2F,   -1, 0xFFCC99),

        /**
         * 特殊默认/正常/自动颜色
         * 注意，它在默认Map中不能通过HSSFColor返回
		 * 这个索引是个特例，它在各种setXXXColor中被解释执行
         */
        AUTOMATIC            (0x40,   -1, 0x000000);
		
		// 定义私有变量
        private HSSFColor color;
		
		/**
		 * 私有的构造函数，只供内部使用
		 * @param index 颜色在调色板中的索引值
		 * @param index2 可选的第二索引
		 * @param 颜色RGB值
		 */ 
        HSSFColorPredefined(int index, int index2, int rgb) {
            this.color = new HSSFColor(index, index2, new java.awt.Color(rgb));
        }

        /**
         * 返回调用颜色在调色板HSSFPalette中索引值
         */
        public short getIndex() {
            return color.getIndex();
        }

        /**
         * 返回调用颜色的可选第二索引值
         */
        public short getIndex2() {
            return color.getIndex2();
        }

        /**
         * 返回颜色的三元组表示，即RGB格式
         */
        public short [] getTriplet() {
            return color.getTriplet();
        }

        /**
         * 返回以冒号分隔的十六进制字符串，像一个gnumeric三元组
         */
        public String getHexString() {
            return color.getHexString();
        }

        /**
         * 返回枚举中预定义的某个颜色的副本
         */
        public HSSFColor getColor() {
            return new HSSFColor(getIndex(), getIndex2(), color.color);
        }
    }

3.方法