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 series label record defines the type of label associated with the data format record.
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 SeriesLabelsRecord
71       extends Record
72   {
73       public final static short      sid                             = 0x100c;
74       private  short      field_1_formatFlags;
75       private  BitField   showActual                                  = new BitField(0x1);
76       private  BitField   showPercent                                 = new BitField(0x2);
77       private  BitField   labelAsPercentage                           = new BitField(0x4);
78       private  BitField   smoothedLine                                = new BitField(0x8);
79       private  BitField   showLabel                                   = new BitField(0x10);
80       private  BitField   showBubbleSizes                             = new BitField(0x20);
81   
82   
83       public SeriesLabelsRecord()
84       {
85   
86       }
87   
88       /**
89        * Constructs a SeriesLabels record and sets its fields appropriately.
90        *
91        * @param id    id must be 0x100c 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 SeriesLabelsRecord(short id, short size, byte [] data)
98       {
99           super(id, size, data);
100      }
101  
102      /**
103       * Constructs a SeriesLabels record and sets its fields appropriately.
104       *
105       * @param id    id must be 0x100c or an exception
106       *              will be throw upon validation
107       * @param size  size the size of the data area of the record
108       * @param data  data of the record (should not contain sid/len)
109       * @param offset of the record's data
110       */
111  
112      public SeriesLabelsRecord(short id, short size, byte [] data, int offset)
113      {
114          super(id, size, data, offset);
115      }
116  
117      /**
118       * Checks the sid matches the expected side for this record
119       *
120       * @param id   the expected sid.
121       */
122      protected void validateSid(short id)
123      {
124          if (id != sid)
125          {
126              throw new RecordFormatException("Not a SeriesLabels record");
127          }
128      }
129  
130      protected void fillFields(byte [] data, short size, int offset)
131      {
132          field_1_formatFlags             = LittleEndian.getShort(data, 0x0 + offset);
133  
134      }
135  
136      public String toString()
137      {
138          StringBuffer buffer = new StringBuffer();
139  
140          buffer.append("[SeriesLabels]\n");
141  
142          buffer.append("    .formatFlags          = ")
143              .append("0x")
144              .append(HexDump.toHex((short)getFormatFlags()))
145              .append(" (").append(getFormatFlags()).append(" )\n");
146          buffer.append("         .showActual               = ").append(isShowActual          ()).append('\n');
147          buffer.append("         .showPercent              = ").append(isShowPercent         ()).append('\n');
148          buffer.append("         .labelAsPercentage        = ").append(isLabelAsPercentage   ()).append('\n');
149          buffer.append("         .smoothedLine             = ").append(isSmoothedLine        ()).append('\n');
150          buffer.append("         .showLabel                = ").append(isShowLabel           ()).append('\n');
151          buffer.append("         .showBubbleSizes          = ").append(isShowBubbleSizes     ()).append('\n');
152  
153          buffer.append("[/SeriesLabels]\n");
154          return buffer.toString();
155      }
156  
157      public int serialize(int offset, byte[] data)
158      {
159          LittleEndian.putShort(data, 0 + offset, sid);
160          LittleEndian.putShort(data, 2 + offset, (short)(getRecordSize() - 4));
161  
162          LittleEndian.putShort(data, 4 + offset, field_1_formatFlags);
163  
164          return getRecordSize();
165      }
166  
167      /**
168       * Size of record (exluding 4 byte header)
169       */
170      public int getRecordSize()
171      {
172          return 4 + 2;
173      }
174  
175      public short getSid()
176      {
177          return this.sid;
178      }
179  
180  
181      /**
182       * Get the format flags field for the SeriesLabels record.
183       */
184      public short getFormatFlags()
185      {
186          return field_1_formatFlags;
187      }
188  
189      /**
190       * Set the format flags field for the SeriesLabels record.
191       */
192      public void setFormatFlags(short field_1_formatFlags)
193      {
194          this.field_1_formatFlags = field_1_formatFlags;
195      }
196  
197      /**
198       * Sets the show actual field value.
199       * show actual value of the data point
200       */
201      public void setShowActual(boolean value)
202      {
203          field_1_formatFlags = showActual.setShortBoolean(field_1_formatFlags, value);
204      }
205  
206      /**
207       * show actual value of the data point
208       * @return  the show actual field value.
209       */
210      public boolean isShowActual()
211      {
212          return showActual.isSet(field_1_formatFlags);
213      }
214  
215      /**
216       * Sets the show percent field value.
217       * show value as percentage of total (pie charts only)
218       */
219      public void setShowPercent(boolean value)
220      {
221          field_1_formatFlags = showPercent.setShortBoolean(field_1_formatFlags, value);
222      }
223  
224      /**
225       * show value as percentage of total (pie charts only)
226       * @return  the show percent field value.
227       */
228      public boolean isShowPercent()
229      {
230          return showPercent.isSet(field_1_formatFlags);
231      }
232  
233      /**
234       * Sets the label as percentage field value.
235       * show category label/value as percentage (pie charts only)
236       */
237      public void setLabelAsPercentage(boolean value)
238      {
239          field_1_formatFlags = labelAsPercentage.setShortBoolean(field_1_formatFlags, value);
240      }
241  
242      /**
243       * show category label/value as percentage (pie charts only)
244       * @return  the label as percentage field value.
245       */
246      public boolean isLabelAsPercentage()
247      {
248          return labelAsPercentage.isSet(field_1_formatFlags);
249      }
250  
251      /**
252       * Sets the smoothed line field value.
253       * show smooth line
254       */
255      public void setSmoothedLine(boolean value)
256      {
257          field_1_formatFlags = smoothedLine.setShortBoolean(field_1_formatFlags, value);
258      }
259  
260      /**
261       * show smooth line
262       * @return  the smoothed line field value.
263       */
264      public boolean isSmoothedLine()
265      {
266          return smoothedLine.isSet(field_1_formatFlags);
267      }
268  
269      /**
270       * Sets the show label field value.
271       * display category label
272       */
273      public void setShowLabel(boolean value)
274      {
275          field_1_formatFlags = showLabel.setShortBoolean(field_1_formatFlags, value);
276      }
277  
278      /**
279       * display category label
280       * @return  the show label field value.
281       */
282      public boolean isShowLabel()
283      {
284          return showLabel.isSet(field_1_formatFlags);
285      }
286  
287      /**
288       * Sets the show bubble sizes field value.
289       * ??
290       */
291      public void setShowBubbleSizes(boolean value)
292      {
293          field_1_formatFlags = showBubbleSizes.setShortBoolean(field_1_formatFlags, value);
294      }
295  
296      /**
297       * ??
298       * @return  the show bubble sizes field value.
299       */
300      public boolean isShowBubbleSizes()
301      {
302          return showBubbleSizes.isSet(field_1_formatFlags);
303      }
304  
305  
306  }  // END OF CLASS
307  
308  
309  
310  
311