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 record is used to define a area chart.
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 AreaRecord
71       extends Record
72   {
73       public final static short      sid                             = 0x101A;
74       private  short      field_1_formatFlags;
75       private  BitField   stacked                                     = new BitField(0x1);
76       private  BitField   displayAsPercentage                         = new BitField(0x2);
77       private  BitField   shadow                                      = new BitField(0x4);
78   
79   
80       public AreaRecord()
81       {
82   
83       }
84   
85       /**
86        * Constructs a Area record and sets its fields appropriately.
87        *
88        * @param id    id must be 0x101A or an exception
89        *              will be throw upon validation
90        * @param size  size the size of the data area of the record
91        * @param data  data of the record (should not contain sid/len)
92        */
93   
94       public AreaRecord(short id, short size, byte [] data)
95       {
96           super(id, size, data);
97       }
98   
99       /**
100       * Constructs a Area record and sets its fields appropriately.
101       *
102       * @param id    id must be 0x101A or an exception
103       *              will be throw upon validation
104       * @param size  size the size of the data area of the record
105       * @param data  data of the record (should not contain sid/len)
106       * @param offset of the record's data
107       */
108  
109      public AreaRecord(short id, short size, byte [] data, int offset)
110      {
111          super(id, size, data, offset);
112      }
113  
114      /**
115       * Checks the sid matches the expected side for this record
116       *
117       * @param id   the expected sid.
118       */
119      protected void validateSid(short id)
120      {
121          if (id != sid)
122          {
123              throw new RecordFormatException("Not a Area record");
124          }
125      }
126  
127      protected void fillFields(byte [] data, short size, int offset)
128      {
129          field_1_formatFlags             = LittleEndian.getShort(data, 0x0 + offset);
130  
131      }
132  
133      public String toString()
134      {
135          StringBuffer buffer = new StringBuffer();
136  
137          buffer.append("[Area]\n");
138  
139          buffer.append("    .formatFlags          = ")
140              .append("0x")
141              .append(HexDump.toHex((short)getFormatFlags()))
142              .append(" (").append(getFormatFlags()).append(" )\n");
143          buffer.append("         .stacked                  = ").append(isStacked             ()).append('\n');
144          buffer.append("         .displayAsPercentage      = ").append(isDisplayAsPercentage ()).append('\n');
145          buffer.append("         .shadow                   = ").append(isShadow              ()).append('\n');
146  
147          buffer.append("[/Area]\n");
148          return buffer.toString();
149      }
150  
151      public int serialize(int offset, byte[] data)
152      {
153          LittleEndian.putShort(data, 0 + offset, sid);
154          LittleEndian.putShort(data, 2 + offset, (short)(getRecordSize() - 4));
155  
156          LittleEndian.putShort(data, 4 + offset, field_1_formatFlags);
157  
158          return getRecordSize();
159      }
160  
161      /**
162       * Size of record (exluding 4 byte header)
163       */
164      public int getRecordSize()
165      {
166          return 4 + 2;
167      }
168  
169      public short getSid()
170      {
171          return this.sid;
172      }
173  
174  
175      /**
176       * Get the format flags field for the Area record.
177       */
178      public short getFormatFlags()
179      {
180          return field_1_formatFlags;
181      }
182  
183      /**
184       * Set the format flags field for the Area record.
185       */
186      public void setFormatFlags(short field_1_formatFlags)
187      {
188          this.field_1_formatFlags = field_1_formatFlags;
189      }
190  
191      /**
192       * Sets the stacked field value.
193       * series is stacked
194       */
195      public void setStacked(boolean value)
196      {
197          field_1_formatFlags = stacked.setShortBoolean(field_1_formatFlags, value);
198      }
199  
200      /**
201       * series is stacked
202       * @return  the stacked field value.
203       */
204      public boolean isStacked()
205      {
206          return stacked.isSet(field_1_formatFlags);
207      }
208  
209      /**
210       * Sets the display as percentage field value.
211       * results displayed as percentages
212       */
213      public void setDisplayAsPercentage(boolean value)
214      {
215          field_1_formatFlags = displayAsPercentage.setShortBoolean(field_1_formatFlags, value);
216      }
217  
218      /**
219       * results displayed as percentages
220       * @return  the display as percentage field value.
221       */
222      public boolean isDisplayAsPercentage()
223      {
224          return displayAsPercentage.isSet(field_1_formatFlags);
225      }
226  
227      /**
228       * Sets the shadow field value.
229       * display a shadow for the chart
230       */
231      public void setShadow(boolean value)
232      {
233          field_1_formatFlags = shadow.setShortBoolean(field_1_formatFlags, value);
234      }
235  
236      /**
237       * display a shadow for the chart
238       * @return  the shadow field value.
239       */
240      public boolean isShadow()
241      {
242          return shadow.isSet(field_1_formatFlags);
243      }
244  
245  
246  }  // END OF CLASS
247  
248  
249  
250  
251