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 bar record is used to define a bar 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 BarRecord
71       extends Record
72   {
73       public final static short      sid                             = 0x1017;
74       private  short      field_1_barSpace;
75       private  short      field_2_categorySpace;
76       private  short      field_3_formatFlags;
77       private  BitField   horizontal                                  = new BitField(0x1);
78       private  BitField   stacked                                     = new BitField(0x2);
79       private  BitField   displayAsPercentage                         = new BitField(0x4);
80       private  BitField   shadow                                      = new BitField(0x8);
81   
82   
83       public BarRecord()
84       {
85   
86       }
87   
88       /**
89        * Constructs a Bar record and sets its fields appropriately.
90        *
91        * @param id    id must be 0x1017 or an exception
92        *              will be throw upon validation
93        * @param size  size the size of the data area of the record
94        * @param data  data of the record (should not contain sid/len)
95        */
96   
97       public BarRecord(short id, short size, byte [] data)
98       {
99           super(id, size, data);
100      
101      }
102  
103      /**
104       * Constructs a Bar record and sets its fields appropriately.
105       *
106       * @param id    id must be 0x1017 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 BarRecord(short id, short size, byte [] data, int offset)
114      {
115          super(id, size, data, offset);
116      
117      }
118  
119      /**
120       * Checks the sid matches the expected side for this record
121       *
122       * @param id   the expected sid.
123       */
124      protected void validateSid(short id)
125      {
126          if (id != sid)
127          {
128              throw new RecordFormatException("Not a Bar record");
129          }
130      }
131  
132      protected void fillFields(byte [] data, short size, int offset)
133      {
134  
135          int pos = 0;
136          field_1_barSpace               = LittleEndian.getShort(data, pos + 0x0 + offset);
137          field_2_categorySpace          = LittleEndian.getShort(data, pos + 0x2 + offset);
138          field_3_formatFlags            = LittleEndian.getShort(data, pos + 0x4 + offset);
139  
140      }
141  
142      public String toString()
143      {
144          StringBuffer buffer = new StringBuffer();
145  
146          buffer.append("[BAR]\n");
147          buffer.append("    .barSpace             = ")
148              .append("0x").append(HexDump.toHex(  getBarSpace ()))
149              .append(" (").append( getBarSpace() ).append(" )");
150          buffer.append(System.getProperty("line.separator")); 
151          buffer.append("    .categorySpace        = ")
152              .append("0x").append(HexDump.toHex(  getCategorySpace ()))
153              .append(" (").append( getCategorySpace() ).append(" )");
154          buffer.append(System.getProperty("line.separator")); 
155          buffer.append("    .formatFlags          = ")
156              .append("0x").append(HexDump.toHex(  getFormatFlags ()))
157              .append(" (").append( getFormatFlags() ).append(" )");
158          buffer.append(System.getProperty("line.separator")); 
159          buffer.append("         .horizontal               = ").append(isHorizontal()).append('\n'); 
160          buffer.append("         .stacked                  = ").append(isStacked()).append('\n'); 
161          buffer.append("         .displayAsPercentage      = ").append(isDisplayAsPercentage()).append('\n'); 
162          buffer.append("         .shadow                   = ").append(isShadow()).append('\n'); 
163  
164          buffer.append("[/BAR]\n");
165          return buffer.toString();
166      }
167  
168      public int serialize(int offset, byte[] data)
169      {
170          int pos = 0;
171  
172          LittleEndian.putShort(data, 0 + offset, sid);
173          LittleEndian.putShort(data, 2 + offset, (short)(getRecordSize() - 4));
174  
175          LittleEndian.putShort(data, 4 + offset + pos, field_1_barSpace);
176          LittleEndian.putShort(data, 6 + offset + pos, field_2_categorySpace);
177          LittleEndian.putShort(data, 8 + offset + pos, field_3_formatFlags);
178  
179          return getRecordSize();
180      }
181  
182      /**
183       * Size of record (exluding 4 byte header)
184       */
185      public int getRecordSize()
186      {
187          return 4  + 2 + 2 + 2;
188      }
189  
190      public short getSid()
191      {
192          return this.sid;
193      }
194  
195      public Object clone() {
196          BarRecord rec = new BarRecord();
197      
198          rec.field_1_barSpace = field_1_barSpace;
199          rec.field_2_categorySpace = field_2_categorySpace;
200          rec.field_3_formatFlags = field_3_formatFlags;
201          return rec;
202      }
203  
204  
205  
206  
207      /**
208       * Get the bar space field for the Bar record.
209       */
210      public short getBarSpace()
211      {
212          return field_1_barSpace;
213      }
214  
215      /**
216       * Set the bar space field for the Bar record.
217       */
218      public void setBarSpace(short field_1_barSpace)
219      {
220          this.field_1_barSpace = field_1_barSpace;
221      }
222  
223      /**
224       * Get the category space field for the Bar record.
225       */
226      public short getCategorySpace()
227      {
228          return field_2_categorySpace;
229      }
230  
231      /**
232       * Set the category space field for the Bar record.
233       */
234      public void setCategorySpace(short field_2_categorySpace)
235      {
236          this.field_2_categorySpace = field_2_categorySpace;
237      }
238  
239      /**
240       * Get the format flags field for the Bar record.
241       */
242      public short getFormatFlags()
243      {
244          return field_3_formatFlags;
245      }
246  
247      /**
248       * Set the format flags field for the Bar record.
249       */
250      public void setFormatFlags(short field_3_formatFlags)
251      {
252          this.field_3_formatFlags = field_3_formatFlags;
253      }
254  
255      /**
256       * Sets the horizontal field value.
257       * true to display horizontal bar charts, false for vertical
258       */
259      public void setHorizontal(boolean value)
260      {
261          field_3_formatFlags = horizontal.setShortBoolean(field_3_formatFlags, value);
262      }
263  
264      /**
265       * true to display horizontal bar charts, false for vertical
266       * @return  the horizontal field value.
267       */
268      public boolean isHorizontal()
269      {
270          return horizontal.isSet(field_3_formatFlags);
271      }
272  
273      /**
274       * Sets the stacked field value.
275       * stack displayed values
276       */
277      public void setStacked(boolean value)
278      {
279          field_3_formatFlags = stacked.setShortBoolean(field_3_formatFlags, value);
280      }
281  
282      /**
283       * stack displayed values
284       * @return  the stacked field value.
285       */
286      public boolean isStacked()
287      {
288          return stacked.isSet(field_3_formatFlags);
289      }
290  
291      /**
292       * Sets the display as percentage field value.
293       * display chart values as a percentage
294       */
295      public void setDisplayAsPercentage(boolean value)
296      {
297          field_3_formatFlags = displayAsPercentage.setShortBoolean(field_3_formatFlags, value);
298      }
299  
300      /**
301       * display chart values as a percentage
302       * @return  the display as percentage field value.
303       */
304      public boolean isDisplayAsPercentage()
305      {
306          return displayAsPercentage.isSet(field_3_formatFlags);
307      }
308  
309      /**
310       * Sets the shadow field value.
311       * display a shadow for the chart
312       */
313      public void setShadow(boolean value)
314      {
315          field_3_formatFlags = shadow.setShortBoolean(field_3_formatFlags, value);
316      }
317  
318      /**
319       * display a shadow for the chart
320       * @return  the shadow field value.
321       */
322      public boolean isShadow()
323      {
324          return shadow.isSet(field_3_formatFlags);
325      }
326  
327  
328  }  // END OF CLASS
329  
330  
331  
332  
333