KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > poi > hssf > record > SaveRecalcRecord


1
2 /* ====================================================================
3    Copyright 2002-2004 Apache Software Foundation
4
5    Licensed under the Apache License, Version 2.0 (the "License");
6    you may not use this file except in compliance with the License.
7    You may obtain a copy of the License at
8
9        http://www.apache.org/licenses/LICENSE-2.0
10
11    Unless required by applicable law or agreed to in writing, software
12    distributed under the License is distributed on an "AS IS" BASIS,
13    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14    See the License for the specific language governing permissions and
15    limitations under the License.
16 ==================================================================== */
17         
18
19 package org.apache.poi.hssf.record;
20
21 import org.apache.poi.util.LittleEndian;
22
23 /**
24  * Title: Save Recalc Record <P>
25  * Description: defines whether to recalculate before saving (set to true)<P>
26  * REFERENCE: PG 381 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)<P>
27  * @author Andrew C. Oliver (acoliver at apache dot org)
28  * @author Jason Height (jheight at chariot dot net dot au)
29  * @version 2.0-pre
30  */
31
32 public class SaveRecalcRecord
33     extends Record
34 {
35     public final static short sid = 0x5f;
36     private short field_1_recalc;
37
38     public SaveRecalcRecord()
39     {
40     }
41
42     /**
43      * Constructs an SaveRecalc record and sets its fields appropriately.
44      *
45      * @param id id must be 0x5f or an exception will be throw upon validation
46      * @param size the size of the data area of the record
47      * @param data data of the record (should not contain sid/len)
48      */
49
50     public SaveRecalcRecord(short id, short size, byte [] data)
51     {
52         super(id, size, data);
53     }
54
55     /**
56      * Constructs an SaveRecalc record and sets its fields appropriately.
57      *
58      * @param id id must be 0x5f or an exception will be throw upon validation
59      * @param size the size of the data area of the record
60      * @param data data of the record (should not contain sid/len)
61      * @param offset of the the data
62      */
63
64     public SaveRecalcRecord(short id, short size, byte [] data, int offset)
65     {
66         super(id, size, data, offset);
67     }
68
69     protected void validateSid(short id)
70     {
71         if (id != sid)
72         {
73             throw new RecordFormatException("NOT A Save Recalc RECORD");
74         }
75     }
76
77     protected void fillFields(byte [] data, short size, int offset)
78     {
79         field_1_recalc = LittleEndian.getShort(data, 0 + offset);
80     }
81
82     /**
83      * set whether to recalculate formulas/etc before saving or not
84      * @param recalc - whether to recalculate or not
85      */
86
87     public void setRecalc(boolean recalc)
88     {
89         field_1_recalc = ( short ) ((recalc == true) ? 1
90                                                      : 0);
91     }
92
93     /**
94      * get whether to recalculate formulas/etc before saving or not
95      * @return recalc - whether to recalculate or not
96      */
97
98     public boolean getRecalc()
99     {
100         return (field_1_recalc == 1);
101     }
102
103     public String JavaDoc toString()
104     {
105         StringBuffer JavaDoc buffer = new StringBuffer JavaDoc();
106
107         buffer.append("[SAVERECALC]\n");
108         buffer.append(" .recalc = ").append(getRecalc())
109             .append("\n");
110         buffer.append("[/SAVERECALC]\n");
111         return buffer.toString();
112     }
113
114     public int serialize(int offset, byte [] data)
115     {
116         LittleEndian.putShort(data, 0 + offset, sid);
117         LittleEndian.putShort(data, 2 + offset, ( short ) 0x2);
118         LittleEndian.putShort(data, 4 + offset, field_1_recalc);
119         return getRecordSize();
120     }
121
122     public int getRecordSize()
123     {
124         return 6;
125     }
126
127     public short getSid()
128     {
129         return this.sid;
130     }
131
132     public Object JavaDoc clone() {
133       SaveRecalcRecord rec = new SaveRecalcRecord();
134       rec.field_1_recalc = field_1_recalc;
135       return rec;
136     }
137 }
138
Popular Tags