001: /* ====================================================================
002: Licensed to the Apache Software Foundation (ASF) under one or more
003: contributor license agreements. See the NOTICE file distributed with
004: this work for additional information regarding copyright ownership.
005: The ASF licenses this file to You under the Apache License, Version 2.0
006: (the "License"); you may not use this file except in compliance with
007: the License. You may obtain a copy of the License at
008:
009: http://www.apache.org/licenses/LICENSE-2.0
010:
011: Unless required by applicable law or agreed to in writing, software
012: distributed under the License is distributed on an "AS IS" BASIS,
013: WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014: See the License for the specific language governing permissions and
015: limitations under the License.
016: ==================================================================== */
017:
018: package org.apache.poi.hssf.record;
019:
020: import org.apache.poi.util.LittleEndian;
021:
022: /**
023: * Title: Save Recalc Record <P>
024: * Description: defines whether to recalculate before saving (set to true)<P>
025: * REFERENCE: PG 381 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)<P>
026: * @author Andrew C. Oliver (acoliver at apache dot org)
027: * @author Jason Height (jheight at chariot dot net dot au)
028: * @version 2.0-pre
029: */
030:
031: public class SaveRecalcRecord extends Record {
032: public final static short sid = 0x5f;
033: private short field_1_recalc;
034:
035: public SaveRecalcRecord() {
036: }
037:
038: /**
039: * Constructs an SaveRecalc record and sets its fields appropriately.
040: * @param in the RecordInputstream to read the record from
041: */
042:
043: public SaveRecalcRecord(RecordInputStream in) {
044: super (in);
045: }
046:
047: protected void validateSid(short id) {
048: if (id != sid) {
049: throw new RecordFormatException("NOT A Save Recalc RECORD");
050: }
051: }
052:
053: protected void fillFields(RecordInputStream in) {
054: field_1_recalc = in.readShort();
055: }
056:
057: /**
058: * set whether to recalculate formulas/etc before saving or not
059: * @param recalc - whether to recalculate or not
060: */
061:
062: public void setRecalc(boolean recalc) {
063: field_1_recalc = (short) ((recalc == true) ? 1 : 0);
064: }
065:
066: /**
067: * get whether to recalculate formulas/etc before saving or not
068: * @return recalc - whether to recalculate or not
069: */
070:
071: public boolean getRecalc() {
072: return (field_1_recalc == 1);
073: }
074:
075: public String toString() {
076: StringBuffer buffer = new StringBuffer();
077:
078: buffer.append("[SAVERECALC]\n");
079: buffer.append(" .recalc = ").append(getRecalc())
080: .append("\n");
081: buffer.append("[/SAVERECALC]\n");
082: return buffer.toString();
083: }
084:
085: public int serialize(int offset, byte[] data) {
086: LittleEndian.putShort(data, 0 + offset, sid);
087: LittleEndian.putShort(data, 2 + offset, (short) 0x2);
088: LittleEndian.putShort(data, 4 + offset, field_1_recalc);
089: return getRecordSize();
090: }
091:
092: public int getRecordSize() {
093: return 6;
094: }
095:
096: public short getSid() {
097: return sid;
098: }
099:
100: public Object clone() {
101: SaveRecalcRecord rec = new SaveRecalcRecord();
102: rec.field_1_recalc = field_1_recalc;
103: return rec;
104: }
105: }
|