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: RefMode Record<P> 62 * Description: Describes which reference mode to use<P> 63 * REFERENCE: PG 376 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 RefModeRecord 70 extends Record 71 { 72 public final static short sid = 0xf; 73 public final static short USE_A1_MODE = 1; 74 public final static short USE_R1C1_MODE = 0; 75 private short field_1_mode; 76 77 public RefModeRecord() 78 { 79 } 80 81 /** 82 * Constructs a RefMode record and sets its fields appropriately. 83 * 84 * @param id id must be 0xf or an exception will be throw upon validation 85 * @param size the size of the data area of the record 86 * @param data data of the record (should not contain sid/len) 87 */ 88 89 public RefModeRecord(short id, short size, byte [] data) 90 { 91 super(id, size, data); 92 } 93 94 /** 95 * Constructs a RefMode record and sets its fields appropriately. 96 * 97 * @param id id must be 0xf or an exception will be throw upon validation 98 * @param size the size of the data area of the record 99 * @param data data of the record (should not contain sid/len) 100 * @param offset of the record's data 101 */ 102 103 public RefModeRecord(short id, short size, byte [] data, int offset) 104 { 105 super(id, size, data, offset); 106 } 107 108 protected void validateSid(short id) 109 { 110 if (id != sid) 111 { 112 throw new RecordFormatException("NOT An RefMode RECORD"); 113 } 114 } 115 116 protected void fillFields(byte [] data, short size, int offset) 117 { 118 field_1_mode = LittleEndian.getShort(data, 0 + offset); 119 } 120 121 /** 122 * set the reference mode to use (HSSF uses/assumes A1) 123 * @param mode the mode to use 124 * @see #USE_A1_MODE 125 * @see #USE_R1C1_MODE 126 * 127 */ 128 129 public void setMode(short mode) 130 { 131 field_1_mode = mode; 132 } 133 134 /** 135 * get the reference mode to use (HSSF uses/assumes A1) 136 * @return mode to use 137 * @see #USE_A1_MODE 138 * @see #USE_R1C1_MODE 139 */ 140 141 public short getMode() 142 { 143 return field_1_mode; 144 } 145 146 public String toString() 147 { 148 StringBuffer buffer = new StringBuffer(); 149 150 buffer.append("[REFMODE]\n"); 151 buffer.append(" .mode = ") 152 .append(Integer.toHexString(getMode())).append("\n"); 153 buffer.append("[/REFMODE]\n"); 154 return buffer.toString(); 155 } 156 157 public int serialize(int offset, byte [] data) 158 { 159 LittleEndian.putShort(data, 0 + offset, sid); 160 LittleEndian.putShort(data, 2 + offset, ( short ) 0x2); 161 LittleEndian.putShort(data, 4 + offset, getMode()); 162 return getRecordSize(); 163 } 164 165 public int getRecordSize() 166 { 167 return 6; 168 } 169 170 public short getSid() 171 { 172 return this.sid; 173 } 174 175 public Object clone() { 176 RefModeRecord rec = new RefModeRecord(); 177 rec.field_1_mode = field_1_mode; 178 return rec; 179 } 180 } 181