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