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       * Constructs a AreaFormat record and sets its fields appropriately.
105       *
106       * @param id    id must be 0x100a or an exception
107       *              will be throw upon validation
108       * @param size  size the size of the data area of the record
109       * @param data  data of the record (should not contain sid/len)
110       * @param offset of the record's data
111       */
112  
113      public AreaFormatRecord(short id, short size, byte [] data, int offset)
114      {
115          super(id, size, data, offset);
116      }
117  
118      /**
119       * Checks the sid matches the expected side for this record
120       *
121       * @param id   the expected sid.
122       */
123      protected void validateSid(short id)
124      {
125          if (id != sid)
126          {
127              throw new RecordFormatException("Not a AreaFormat record");
128          }
129      }
130  
131      protected void fillFields(byte [] data, short size, int offset)
132      {
133          field_1_foregroundColor         = LittleEndian.getInt(data, 0x0 + offset);
134          field_2_backgroundColor         = LittleEndian.getInt(data, 0x4 + offset);
135          field_3_pattern                 = LittleEndian.getShort(data, 0x8 + offset);
136          field_4_formatFlags             = LittleEndian.getShort(data, 0xa + offset);
137          field_5_forecolorIndex          = LittleEndian.getShort(data, 0xc + offset);
138          field_6_backcolorIndex          = LittleEndian.getShort(data, 0xe + offset);
139  
140      }
141  
142      public String toString()
143      {
144          StringBuffer buffer = new StringBuffer();
145  
146          buffer.append("[AreaFormat]\n");
147  
148          buffer.append("    .foregroundColor      = ")
149              .append("0x")
150              .append(HexDump.toHex((int)getForegroundColor()))
151              .append(" (").append(getForegroundColor()).append(" )\n");
152  
153          buffer.append("    .backgroundColor      = ")
154              .append("0x")
155              .append(HexDump.toHex((int)getBackgroundColor()))
156              .append(" (").append(getBackgroundColor()).append(" )\n");
157  
158          buffer.append("    .pattern              = ")
159              .append("0x")
160              .append(HexDump.toHex((short)getPattern()))
161              .append(" (").append(getPattern()).append(" )\n");
162  
163          buffer.append("    .formatFlags          = ")
164              .append("0x")
165              .append(HexDump.toHex((short)getFormatFlags()))
166              .append(" (").append(getFormatFlags()).append(" )\n");
167          buffer.append("         .automatic                = ").append(isAutomatic           ()).append('\n');
168          buffer.append("         .invert                   = ").append(isInvert              ()).append('\n');
169  
170          buffer.append("    .forecolorIndex       = ")
171              .append("0x")
172              .append(HexDump.toHex((short)getForecolorIndex()))
173              .append(" (").append(getForecolorIndex()).append(" )\n");
174  
175          buffer.append("    .backcolorIndex       = ")
176              .append("0x")
177              .append(HexDump.toHex((short)getBackcolorIndex()))
178              .append(" (").append(getBackcolorIndex()).append(" )\n");
179  
180          buffer.append("[/AreaFormat]\n");
181          return buffer.toString();
182      }
183  
184      public int serialize(int offset, byte[] data)
185      {
186          LittleEndian.putShort(data, 0 + offset, sid);
187          LittleEndian.putShort(data, 2 + offset, (short)(getRecordSize() - 4));
188  
189          LittleEndian.putInt(data, 4 + offset, field_1_foregroundColor);
190          LittleEndian.putInt(data, 8 + offset, field_2_backgroundColor);
191          LittleEndian.putShort(data, 12 + offset, field_3_pattern);
192          LittleEndian.putShort(data, 14 + offset, field_4_formatFlags);
193          LittleEndian.putShort(data, 16 + offset, field_5_forecolorIndex);
194          LittleEndian.putShort(data, 18 + offset, 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  
213      /**
214       * Get the foreground color field for the AreaFormat record.
215       */
216      public int getForegroundColor()
217      {
218          return field_1_foregroundColor;
219      }
220  
221      /**
222       * Set the foreground color field for the AreaFormat record.
223       */
224      public void setForegroundColor(int field_1_foregroundColor)
225      {
226          this.field_1_foregroundColor = field_1_foregroundColor;
227      }
228  
229      /**
230       * Get the background color field for the AreaFormat record.
231       */
232      public int getBackgroundColor()
233      {
234          return field_2_backgroundColor;
235      }
236  
237      /**
238       * Set the background color field for the AreaFormat record.
239       */
240      public void setBackgroundColor(int field_2_backgroundColor)
241      {
242          this.field_2_backgroundColor = field_2_backgroundColor;
243      }
244  
245      /**
246       * Get the pattern field for the AreaFormat record.
247       */
248      public short getPattern()
249      {
250          return field_3_pattern;
251      }
252  
253      /**
254       * Set the pattern field for the AreaFormat record.
255       */
256      public void setPattern(short field_3_pattern)
257      {
258          this.field_3_pattern = field_3_pattern;
259      }
260  
261      /**
262       * Get the format flags field for the AreaFormat record.
263       */
264      public short getFormatFlags()
265      {
266          return field_4_formatFlags;
267      }
268  
269      /**
270       * Set the format flags field for the AreaFormat record.
271       */
272      public void setFormatFlags(short field_4_formatFlags)
273      {
274          this.field_4_formatFlags = field_4_formatFlags;
275      }
276  
277      /**
278       * Get the forecolor index field for the AreaFormat record.
279       */
280      public short getForecolorIndex()
281      {
282          return field_5_forecolorIndex;
283      }
284  
285      /**
286       * Set the forecolor index field for the AreaFormat record.
287       */
288      public void setForecolorIndex(short field_5_forecolorIndex)
289      {
290          this.field_5_forecolorIndex = field_5_forecolorIndex;
291      }
292  
293      /**
294       * Get the backcolor index field for the AreaFormat record.
295       */
296      public short getBackcolorIndex()
297      {
298          return field_6_backcolorIndex;
299      }
300  
301      /**
302       * Set the backcolor index field for the AreaFormat record.
303       */
304      public void setBackcolorIndex(short field_6_backcolorIndex)
305      {
306          this.field_6_backcolorIndex = field_6_backcolorIndex;
307      }
308  
309      /**
310       * Sets the automatic field value.
311       * automatic formatting
312       */
313      public void setAutomatic(boolean value)
314      {
315          field_4_formatFlags = automatic.setShortBoolean(field_4_formatFlags, value);
316      }
317  
318      /**
319       * automatic formatting
320       * @return  the automatic field value.
321       */
322      public boolean isAutomatic()
323      {
324          return automatic.isSet(field_4_formatFlags);
325      }
326  
327      /**
328       * Sets the invert field value.
329       * swap foreground and background colours when data is negative
330       */
331      public void setInvert(boolean value)
332      {
333          field_4_formatFlags = invert.setShortBoolean(field_4_formatFlags, value);
334      }
335  
336      /**
337       * swap foreground and background colours when data is negative
338       * @return  the invert field value.
339       */
340      public boolean isInvert()
341      {
342          return invert.isSet(field_4_formatFlags);
343      }
344  
345  
346  }  // END OF CLASS
347  
348  
349  
350  
351