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 dat record is used to store options for the 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 DatRecord
71       extends Record
72   {
73       public final static short      sid                             = 0x1063;
74       private  short      field_1_options;
75       private  BitField   horizontalBorder                            = new BitField(0x1);
76       private  BitField   verticalBorder                              = new BitField(0x2);
77       private  BitField   border                                      = new BitField(0x4);
78       private  BitField   showSeriesKey                               = new BitField(0x8);
79   
80   
81       public DatRecord()
82       {
83   
84       }
85   
86       /**
87        * Constructs a Dat record and sets its fields appropriately.
88        *
89        * @param id    id must be 0x1063 or an exception
90        *              will be throw upon validation
91        * @param size  size the size of the data area of the record
92        * @param data  data of the record (should not contain sid/len)
93        */
94   
95       public DatRecord(short id, short size, byte [] data)
96       {
97           super(id, size, data);
98       
99       }
100  
101      /**
102       * Constructs a Dat record and sets its fields appropriately.
103       *
104       * @param id    id must be 0x1063 or an exception
105       *              will be throw upon validation
106       * @param size  size the size of the data area of the record
107       * @param data  data of the record (should not contain sid/len)
108       * @param offset of the record's data
109       */
110  
111      public DatRecord(short id, short size, byte [] data, int offset)
112      {
113          super(id, size, data, offset);
114      
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 Dat record");
127          }
128      }
129  
130      protected void fillFields(byte [] data, short size, int offset)
131      {
132  
133          int pos = 0;
134          field_1_options                = LittleEndian.getShort(data, pos + 0x0 + offset);
135  
136      }
137  
138      public String toString()
139      {
140          StringBuffer buffer = new StringBuffer();
141  
142          buffer.append("[DAT]\n");
143          buffer.append("    .options              = ")
144              .append("0x").append(HexDump.toHex(  getOptions ()))
145              .append(" (").append( getOptions() ).append(" )");
146          buffer.append(System.getProperty("line.separator")); 
147          buffer.append("         .horizontalBorder         = ").append(isHorizontalBorder()).append('\n'); 
148          buffer.append("         .verticalBorder           = ").append(isVerticalBorder()).append('\n'); 
149          buffer.append("         .border                   = ").append(isBorder()).append('\n'); 
150          buffer.append("         .showSeriesKey            = ").append(isShowSeriesKey()).append('\n'); 
151  
152          buffer.append("[/DAT]\n");
153          return buffer.toString();
154      }
155  
156      public int serialize(int offset, byte[] data)
157      {
158          int pos = 0;
159  
160          LittleEndian.putShort(data, 0 + offset, sid);
161          LittleEndian.putShort(data, 2 + offset, (short)(getRecordSize() - 4));
162  
163          LittleEndian.putShort(data, 4 + offset + pos, field_1_options);
164  
165          return getRecordSize();
166      }
167  
168      /**
169       * Size of record (exluding 4 byte header)
170       */
171      public int getRecordSize()
172      {
173          return 4  + 2;
174      }
175  
176      public short getSid()
177      {
178          return this.sid;
179      }
180  
181      public Object clone() {
182          DatRecord rec = new DatRecord();
183      
184          rec.field_1_options = field_1_options;
185          return rec;
186      }
187  
188  
189  
190  
191      /**
192       * Get the options field for the Dat record.
193       */
194      public short getOptions()
195      {
196          return field_1_options;
197      }
198  
199      /**
200       * Set the options field for the Dat record.
201       */
202      public void setOptions(short field_1_options)
203      {
204          this.field_1_options = field_1_options;
205      }
206  
207      /**
208       * Sets the horizontal border field value.
209       * has a horizontal border
210       */
211      public void setHorizontalBorder(boolean value)
212      {
213          field_1_options = horizontalBorder.setShortBoolean(field_1_options, value);
214      }
215  
216      /**
217       * has a horizontal border
218       * @return  the horizontal border field value.
219       */
220      public boolean isHorizontalBorder()
221      {
222          return horizontalBorder.isSet(field_1_options);
223      }
224  
225      /**
226       * Sets the vertical border field value.
227       * has vertical border
228       */
229      public void setVerticalBorder(boolean value)
230      {
231          field_1_options = verticalBorder.setShortBoolean(field_1_options, value);
232      }
233  
234      /**
235       * has vertical border
236       * @return  the vertical border field value.
237       */
238      public boolean isVerticalBorder()
239      {
240          return verticalBorder.isSet(field_1_options);
241      }
242  
243      /**
244       * Sets the border field value.
245       * data table has a border
246       */
247      public void setBorder(boolean value)
248      {
249          field_1_options = border.setShortBoolean(field_1_options, value);
250      }
251  
252      /**
253       * data table has a border
254       * @return  the border field value.
255       */
256      public boolean isBorder()
257      {
258          return border.isSet(field_1_options);
259      }
260  
261      /**
262       * Sets the show series key field value.
263       * shows the series key
264       */
265      public void setShowSeriesKey(boolean value)
266      {
267          field_1_options = showSeriesKey.setShortBoolean(field_1_options, value);
268      }
269  
270      /**
271       * shows the series key
272       * @return  the show series key field value.
273       */
274      public boolean isShowSeriesKey()
275      {
276          return showSeriesKey.isSet(field_1_options);
277      }
278  
279  
280  }  // END OF CLASS
281  
282  
283  
284  
285