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   
57   package org.apache.poi.hssf.record;
58   
59   
60   
61   import org.apache.poi.util.*;
62   
63   /**
64    * The area format record is used to define the colours and patterns for an area.
65    * NOTE: This source is automatically generated please do not modify this file.  Either subclass or
66    *       remove the record in src/records/definitions.
67   
68    * @author Glen Stampoultzis (glens at apache.org)
69    */
70   public class AreaFormatRecord
71       extends Record
72   {
73       public final static short      sid                             = 0x100a;
74       private  int        field_1_foregroundColor;
75       private  int        field_2_backgroundColor;
76       private  short      field_3_pattern;
77       private  short      field_4_formatFlags;
78       private  BitField   automatic                                   = new BitField(0x1);
79       private  BitField   invert                                      = new BitField(0x2);
80       private  short      field_5_forecolorIndex;
81       private  short      field_6_backcolorIndex;
82   
83   
84       public AreaFormatRecord()
85       {
86   
87       }
88   
89       /**
90        * Constructs a AreaFormat record and sets its fields appropriately.
91        *
92        * @param id    id must be 0x100a or an exception
93        *              will be throw upon validation
94        * @param size  size the size of the data area of the record
95        * @param data  data of the record (should not contain sid/len)
96        */
97   
98       public AreaFormatRecord(short id, short size, byte [] data)
99       {
100          super(id, size, data);
101      
102      }
103  
104      /**
105       * Constructs a AreaFormat record and sets its fields appropriately.
106       *
107       * @param id    id must be 0x100a or an exception
108       *              will be throw upon validation
109       * @param size  size the size of the data area of the record
110       * @param data  data of the record (should not contain sid/len)
111       * @param offset of the record's data
112       */
113  
114      public AreaFormatRecord(short id, short size, byte [] data, int offset)
115      {
116          super(id, size, data, offset);
117      
118      }
119  
120      /**
121       * Checks the sid matches the expected side for this record
122       *
123       * @param id   the expected sid.
124       */
125      protected void validateSid(short id)
126      {
127          if (id != sid)
128          {
129              throw new RecordFormatException("Not a AreaFormat record");
130          }
131      }
132  
133      protected void fillFields(byte [] data, short size, int offset)
134      {
135  
136          int pos = 0;
137          field_1_foregroundColor        = LittleEndian.getInt(data, pos + 0x0 + offset);
138          field_2_backgroundColor        = LittleEndian.getInt(data, pos + 0x4 + offset);
139          field_3_pattern                = LittleEndian.getShort(data, pos + 0x8 + offset);
140          field_4_formatFlags            = LittleEndian.getShort(data, pos + 0xa + offset);
141          field_5_forecolorIndex         = LittleEndian.getShort(data, pos + 0xc + offset);
142          field_6_backcolorIndex         = LittleEndian.getShort(data, pos + 0xe + offset);
143  
144      }
145  
146      public String toString()
147      {
148          StringBuffer buffer = new StringBuffer();
149  
150          buffer.append("[AREAFORMAT]\n");
151          buffer.append("    .foregroundColor      = ")
152              .append("0x").append(HexDump.toHex(  getForegroundColor ()))
153              .append(" (").append( getForegroundColor() ).append(" )");
154          buffer.append(System.getProperty("line.separator")); 
155          buffer.append("    .backgroundColor      = ")
156              .append("0x").append(HexDump.toHex(  getBackgroundColor ()))
157              .append(" (").append( getBackgroundColor() ).append(" )");
158          buffer.append(System.getProperty("line.separator")); 
159          buffer.append("    .pattern              = ")
160              .append("0x").append(HexDump.toHex(  getPattern ()))
161              .append(" (").append( getPattern() ).append(" )");
162          buffer.append(System.getProperty("line.separator")); 
163          buffer.append("    .formatFlags          = ")
164              .append("0x").append(HexDump.toHex(  getFormatFlags ()))
165              .append(" (").append( getFormatFlags() ).append(" )");
166          buffer.append(System.getProperty("line.separator")); 
167          buffer.append("         .automatic                = ").append(isAutomatic()).append('\n'); 
168          buffer.append("         .invert                   = ").append(isInvert()).append('\n'); 
169          buffer.append("    .forecolorIndex       = ")
170              .append("0x").append(HexDump.toHex(  getForecolorIndex ()))
171              .append(" (").append( getForecolorIndex() ).append(" )");
172          buffer.append(System.getProperty("line.separator")); 
173          buffer.append("    .backcolorIndex       = ")
174              .append("0x").append(HexDump.toHex(  getBackcolorIndex ()))
175              .append(" (").append( getBackcolorIndex() ).append(" )");
176          buffer.append(System.getProperty("line.separator")); 
177  
178          buffer.append("[/AREAFORMAT]\n");
179          return buffer.toString();
180      }
181  
182      public int serialize(int offset, byte[] data)
183      {
184          int pos = 0;
185  
186          LittleEndian.putShort(data, 0 + offset, sid);
187          LittleEndian.putShort(data, 2 + offset, (short)(getRecordSize() - 4));
188  
189          LittleEndian.putInt(data, 4 + offset + pos, field_1_foregroundColor);
190          LittleEndian.putInt(data, 8 + offset + pos, field_2_backgroundColor);
191          LittleEndian.putShort(data, 12 + offset + pos, field_3_pattern);
192          LittleEndian.putShort(data, 14 + offset + pos, field_4_formatFlags);
193          LittleEndian.putShort(data, 16 + offset + pos, field_5_forecolorIndex);
194          LittleEndian.putShort(data, 18 + offset + pos, field_6_backcolorIndex);
195  
196          return getRecordSize();
197      }
198  
199      /**
200       * Size of record (exluding 4 byte header)
201       */
202      public int getRecordSize()
203      {
204          return 4  + 4 + 4 + 2 + 2 + 2 + 2;
205      }
206  
207      public short getSid()
208      {
209          return this.sid;
210      }
211  
212      public Object clone() {
213          AreaFormatRecord rec = new AreaFormatRecord();
214      
215          rec.field_1_foregroundColor = field_1_foregroundColor;
216          rec.field_2_backgroundColor = field_2_backgroundColor;
217          rec.field_3_pattern = field_3_pattern;
218          rec.field_4_formatFlags = field_4_formatFlags;
219          rec.field_5_forecolorIndex = field_5_forecolorIndex;
220          rec.field_6_backcolorIndex = field_6_backcolorIndex;
221          return rec;
222      }
223  
224  
225  
226  
227      /**
228       * Get the foreground color field for the AreaFormat record.
229       */
230      public int getForegroundColor()
231      {
232          return field_1_foregroundColor;
233      }
234  
235      /**
236       * Set the foreground color field for the AreaFormat record.
237       */
238      public void setForegroundColor(int field_1_foregroundColor)
239      {
240          this.field_1_foregroundColor = field_1_foregroundColor;
241      }
242  
243      /**
244       * Get the background color field for the AreaFormat record.
245       */
246      public int getBackgroundColor()
247      {
248          return field_2_backgroundColor;
249      }
250  
251      /**
252       * Set the background color field for the AreaFormat record.
253       */
254      public void setBackgroundColor(int field_2_backgroundColor)
255      {
256          this.field_2_backgroundColor = field_2_backgroundColor;
257      }
258  
259      /**
260       * Get the pattern field for the AreaFormat record.
261       */
262      public short getPattern()
263      {
264          return field_3_pattern;
265      }
266  
267      /**
268       * Set the pattern field for the AreaFormat record.
269       */
270      public void setPattern(short field_3_pattern)
271      {
272          this.field_3_pattern = field_3_pattern;
273      }
274  
275      /**
276       * Get the format flags field for the AreaFormat record.
277       */
278      public short getFormatFlags()
279      {
280          return field_4_formatFlags;
281      }
282  
283      /**
284       * Set the format flags field for the AreaFormat record.
285       */
286      public void setFormatFlags(short field_4_formatFlags)
287      {
288          this.field_4_formatFlags = field_4_formatFlags;
289      }
290  
291      /**
292       * Get the forecolor index field for the AreaFormat record.
293       */
294      public short getForecolorIndex()
295      {
296          return field_5_forecolorIndex;
297      }
298  
299      /**
300       * Set the forecolor index field for the AreaFormat record.
301       */
302      public void setForecolorIndex(short field_5_forecolorIndex)
303      {
304          this.field_5_forecolorIndex = field_5_forecolorIndex;
305      }
306  
307      /**
308       * Get the backcolor index field for the AreaFormat record.
309       */
310      public short getBackcolorIndex()
311      {
312          return field_6_backcolorIndex;
313      }
314  
315      /**
316       * Set the backcolor index field for the AreaFormat record.
317       */
318      public void setBackcolorIndex(short field_6_backcolorIndex)
319      {
320          this.field_6_backcolorIndex = field_6_backcolorIndex;
321      }
322  
323      /**
324       * Sets the automatic field value.
325       * automatic formatting
326       */
327      public void setAutomatic(boolean value)
328      {
329          field_4_formatFlags = automatic.setShortBoolean(field_4_formatFlags, value);
330      }
331  
332      /**
333       * automatic formatting
334       * @return  the automatic field value.
335       */
336      public boolean isAutomatic()
337      {
338          return automatic.isSet(field_4_formatFlags);
339      }
340  
341      /**
342       * Sets the invert field value.
343       * swap foreground and background colours when data is negative
344       */
345      public void setInvert(boolean value)
346      {
347          field_4_formatFlags = invert.setShortBoolean(field_4_formatFlags, value);
348      }
349  
350      /**
351       * swap foreground and background colours when data is negative
352       * @return  the invert field value.
353       */
354      public boolean isInvert()
355      {
356          return invert.isSet(field_4_formatFlags);
357      }
358  
359  
360  }  // END OF CLASS
361  
362  
363  
364  
365