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   package org.apache.poi.hssf.record;
57   
58   import org.apache.poi.util.LittleEndian;
59   
60   /**
61    * Title:        Calc Mode Record<P>
62    * Description:  Tells the gui whether to calculate formulas
63    *               automatically, manually or automatically
64    *               except for tables.<P>
65    * REFERENCE:  PG 292 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)<P>
66    * @author Andrew C. Oliver (acoliver at apache dot org)
67    * @author Jason Height (jheight at chariot dot net dot au)
68    * @version 2.0-pre
69    * @see org.apache.poi.hssf.record.CalcCountRecord
70    */
71   
72   public class CalcModeRecord
73       extends Record
74   {
75       public final static short sid                     = 0xD;
76   
77       /**
78        * manually calculate formulas (0)
79        */
80   
81       public final static short MANUAL                  = 0;
82   
83       /**
84        * automatically calculate formulas (1)
85        */
86   
87       public final static short AUTOMATIC               = 1;
88   
89       /**
90        * automatically calculate formulas except for tables (-1)
91        */
92   
93       public final static short AUTOMATIC_EXCEPT_TABLES = -1;
94       private short             field_1_calcmode;
95   
96       public CalcModeRecord()
97       {
98       }
99   
100      /**
101       * Constructs a CalcModeRecord and sets its fields appropriately
102       *
103       * @param id     id must be 0xD or an exception will be throw upon validation
104       * @param size  the size of the data area of the record
105       * @param data  data of the record (should not contain sid/len)
106       */
107  
108      public CalcModeRecord(short id, short size, byte [] data)
109      {
110          super(id, size, data);
111      }
112  
113      /**
114       * Constructs a CalcModeRecord and sets its fields appropriately
115       *
116       * @param id     id must be 0xD or an exception will be throw upon validation
117       * @param size  the size of the data area of the record
118       * @param data  data of the record (should not contain sid/len)
119       * @param offset of the record's start data
120       */
121  
122      public CalcModeRecord(short id, short size, byte [] data, int offset)
123      {
124          super(id, size, data, offset);
125      }
126  
127      protected void validateSid(short id)
128      {
129          if (id != sid)
130          {
131              throw new RecordFormatException("NOT An Calc Mode RECORD");
132          }
133      }
134  
135      protected void fillFields(byte [] data, short size, int offset)
136      {
137          field_1_calcmode = LittleEndian.getShort(data, 0 + offset);
138      }
139  
140      /**
141       * set the calc mode flag for formulas
142       *
143       * @see #MANUAL
144       * @see #AUTOMATIC
145       * @see #AUTOMATIC_EXCEPT_TABLES
146       *
147       * @param calcmode one of the three flags above
148       */
149  
150      public void setCalcMode(short calcmode)
151      {
152          field_1_calcmode = calcmode;
153      }
154  
155      /**
156       * get the calc mode flag for formulas
157       *
158       * @see #MANUAL
159       * @see #AUTOMATIC
160       * @see #AUTOMATIC_EXCEPT_TABLES
161       *
162       * @return calcmode one of the three flags above
163       */
164  
165      public short getCalcMode()
166      {
167          return field_1_calcmode;
168      }
169  
170      public String toString()
171      {
172          StringBuffer buffer = new StringBuffer();
173  
174          buffer.append("[CALCMODE]\n");
175          buffer.append("    .calcmode       = ")
176              .append(Integer.toHexString(getCalcMode())).append("\n");
177          buffer.append("[/CALCMODE]\n");
178          return buffer.toString();
179      }
180  
181      public int serialize(int offset, byte [] data)
182      {
183          LittleEndian.putShort(data, 0 + offset, sid);
184          LittleEndian.putShort(data, 2 + offset, ( short ) 0x2);
185          LittleEndian.putShort(data, 4 + offset, getCalcMode());
186          return getRecordSize();
187      }
188  
189      public int getRecordSize()
190      {
191          return 6;
192      }
193  
194      public short getSid()
195      {
196          return this.sid;
197      }
198  
199      public Object clone() {
200        CalcModeRecord rec = new CalcModeRecord();
201        rec.field_1_calcmode = field_1_calcmode;
202        return rec;
203      }
204  }
205