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: Save Recalc Record <P> 62 * Description: defines whether to recalculate before saving (set to true)<P> 63 * REFERENCE: PG 381 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)<P> 64 * @author Andrew C. Oliver (acoliver at apache dot org) 65 * @author Jason Height (jheight at chariot dot net dot au) 66 * @version 2.0-pre 67 */ 68 69 public class SaveRecalcRecord 70 extends Record 71 { 72 public final static short sid = 0x5f; 73 private short field_1_recalc; 74 75 public SaveRecalcRecord() 76 { 77 } 78 79 /** 80 * Constructs an SaveRecalc record and sets its fields appropriately. 81 * 82 * @param id id must be 0x5f or an exception will be throw upon validation 83 * @param size the size of the data area of the record 84 * @param data data of the record (should not contain sid/len) 85 */ 86 87 public SaveRecalcRecord(short id, short size, byte [] data) 88 { 89 super(id, size, data); 90 } 91 92 /** 93 * Constructs an SaveRecalc record and sets its fields appropriately. 94 * 95 * @param id id must be 0x5f or an exception will be throw upon validation 96 * @param size the size of the data area of the record 97 * @param data data of the record (should not contain sid/len) 98 * @param offset of the the data 99 */ 100 101 public SaveRecalcRecord(short id, short size, byte [] data, int offset) 102 { 103 super(id, size, data, offset); 104 } 105 106 protected void validateSid(short id) 107 { 108 if (id != sid) 109 { 110 throw new RecordFormatException("NOT A Save Recalc RECORD"); 111 } 112 } 113 114 protected void fillFields(byte [] data, short size, int offset) 115 { 116 field_1_recalc = LittleEndian.getShort(data, 0 + offset); 117 } 118 119 /** 120 * set whether to recalculate formulas/etc before saving or not 121 * @param recalc - whether to recalculate or not 122 */ 123 124 public void setRecalc(boolean recalc) 125 { 126 field_1_recalc = ( short ) ((recalc == true) ? 1 127 : 0); 128 } 129 130 /** 131 * get whether to recalculate formulas/etc before saving or not 132 * @return recalc - whether to recalculate or not 133 */ 134 135 public boolean getRecalc() 136 { 137 return (field_1_recalc == 1); 138 } 139 140 public String toString() 141 { 142 StringBuffer buffer = new StringBuffer(); 143 144 buffer.append("[SAVERECALC]\n"); 145 buffer.append(" .recalc = ").append(getRecalc()) 146 .append("\n"); 147 buffer.append("[/SAVERECALC]\n"); 148 return buffer.toString(); 149 } 150 151 public int serialize(int offset, byte [] data) 152 { 153 LittleEndian.putShort(data, 0 + offset, sid); 154 LittleEndian.putShort(data, 2 + offset, ( short ) 0x2); 155 LittleEndian.putShort(data, 4 + offset, field_1_recalc); 156 return getRecordSize(); 157 } 158 159 public int getRecordSize() 160 { 161 return 6; 162 } 163 164 public short getSid() 165 { 166 return this.sid; 167 } 168 169 public Object clone() { 170 SaveRecalcRecord rec = new SaveRecalcRecord(); 171 rec.field_1_recalc = field_1_recalc; 172 return rec; 173 } 174 } 175