1    
2    /* ====================================================================
3     * The Apache Software License, Version 1.1
4     *
5     * Copyright (c) 2002 The Apache Software Foundation.  All rights
6     * reserved.
7     *
8     * Redistribution and use in source and binary forms, with or without
9     * modification, are permitted provided that the following conditions
10    * are met:
11    *
12    * 1. Redistributions of source code must retain the above copyright
13    *    notice, this list of conditions and the following disclaimer.
14    *
15    * 2. Redistributions in binary form must reproduce the above copyright
16    *    notice, this list of conditions and the following disclaimer in
17    *    the documentation and/or other materials provided with the
18    *    distribution.
19    *
20    * 3. The end-user documentation included with the redistribution,
21    *    if any, must include the following acknowledgment:
22    *       "This product includes software developed by the
23    *        Apache Software Foundation (http://www.apache.org/)."
24    *    Alternately, this acknowledgment may appear in the software itself,
25    *    if and wherever such third-party acknowledgments normally appear.
26    *
27    * 4. The names "Apache" and "Apache Software Foundation" and
28    *    "Apache POI" must not be used to endorse or promote products
29    *    derived from this software without prior written permission. For
30    *    written permission, please contact apache@apache.org.
31    *
32    * 5. Products derived from this software may not be called "Apache",
33    *    "Apache POI", nor may "Apache" appear in their name, without
34    *    prior written permission of the Apache Software Foundation.
35    *
36    * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
37    * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
38    * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
39    * DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
40    * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
41    * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
42    * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
43    * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
44    * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
45    * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
46    * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
47    * SUCH DAMAGE.
48    * ====================================================================
49    *
50    * This software consists of voluntary contributions made by many
51    * individuals on behalf of the Apache Software Foundation.  For more
52    * information on the Apache Software Foundation, please see
53    * <http://www.apache.org/>.
54    */
55   
56   package org.apache.poi.hssf.record;
57   
58   import java.util.ArrayList;
59   import java.util.List;
60   
61   import org.apache.poi.util.LittleEndian;
62   
63   /**
64    * PaletteRecord - Supports custom palettes.
65    * @author Andrew C. Oliver (acoliver at apache dot org)
66    * @version 2.0-pre
67    */
68   
69   public class PaletteRecord
70       extends Record
71   {
72       public final static short sid = 0x92;
73   
74       private short field_1_numcolors;
75       private List  field_2_colors;
76   
77       public PaletteRecord()
78       {
79       }
80   
81       /**
82        * Constructs a PaletteRecord record and sets its fields appropriately.
83        *
84        * @param id     id must be 0x92 or an exception will be throw upon validation
85        * @param size  the size of the data area of the record
86        * @param data  data of the record (should not contain sid/len)
87        */
88   
89       public PaletteRecord(short id, short size, byte [] data)
90       {
91           super(id, size, data);
92       }
93   
94       /**
95        * Constructs a PaletteRecord record and sets its fields appropriately.
96        *
97        * @param id     id must be 0x0A or an exception will be throw upon validation
98        * @param size  the size of the data area of the record
99        * @param data  data of the record (should not contain sid/len)
100       * @param offset of the record's data
101       */
102  
103      public PaletteRecord(short id, short size, byte [] data, int offset)
104      {
105          super(id, size, data, offset);
106      }
107  
108      protected void validateSid(short id)
109      {
110          if (id != sid)
111          {
112              throw new RecordFormatException("NOT An Palette RECORD");
113          }
114      }
115  
116      protected void fillFields(byte [] data, short size, int offset)
117      {
118         field_1_numcolors = LittleEndian.getShort(data,offset+0); 
119         field_2_colors    = new ArrayList(field_1_numcolors);
120         for (int k = 0; k < field_1_numcolors; k++) {
121             field_2_colors.add(new PColor(
122                                           data[2+ offset+(k * 4) +0],
123                                           data[2+ offset+(k * 4) +1],
124                                           data[2+ offset+(k * 4) +2]
125                                          )
126                                );
127         } 
128      }
129  
130      public String toString()
131      {
132          StringBuffer buffer = new StringBuffer();
133  
134          buffer.append("[Palette]\n");
135          buffer.append("  numcolors     = ").append(field_1_numcolors)
136                .append('\n');
137          for (int k = 0; k < field_1_numcolors; k++) {
138          PColor c = (PColor) field_2_colors.get(k);
139          buffer.append("* colornum      = ").append(k)
140                .append('\n');
141          buffer.append(c.toString());
142          buffer.append("/*colornum      = ").append(k)
143                .append('\n');
144          }
145          buffer.append("[/Palette]\n");
146          return buffer.toString();
147      }
148  
149      public int serialize(int offset, byte [] data)
150      {
151          LittleEndian.putShort(data, 0 + offset, sid);
152          for (int k = 0; k < field_1_numcolors; k++) {
153            PColor c = (PColor)field_2_colors.get(k);
154            c.serialize(data, (2+offset+(k*4)));
155          }
156  
157          return getRecordSize();
158      }
159  
160      public int getRecordSize()
161      {
162          return 2 + (field_1_numcolors * 4);
163      }
164  
165      public short getSid()
166      {
167          return this.sid;
168      }
169  
170  }
171  
172  /**
173   * PColor - element in the list of colors - consider it a "struct"
174   */
175  class PColor {
176    public byte red;
177    public byte green;
178    public byte blue;
179    public PColor(byte red, byte green, byte blue) {
180      this.red=red;
181      this.green=green;
182      this.blue=blue;
183    }
184  
185    public void serialize(byte[] data, int offset) {
186       data[offset + 0] = red;
187       data[offset + 1] = green;
188       data[offset + 2] = blue;
189       data[offset + 3] = 0;
190    }
191  
192    public String toString() {
193          StringBuffer buffer = new StringBuffer();
194          buffer.append("  red           = ").append(red).append('\n');
195          buffer.append("  green         = ").append(green).append('\n');
196          buffer.append("  blue          = ").append(blue).append('\n');
197          return buffer.toString();
198    }
199  }
200