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: Sheet Tab Index Array Record<P> 62 * Description: Contains an array of sheet id's. Sheets always keep their ID 63 * regardless of what their name is.<P> 64 * REFERENCE: PG 412 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)<P> 65 * @author Andrew C. Oliver (acoliver at apache dot org) 66 * @version 2.0-pre 67 */ 68 69 public class TabIdRecord 70 extends Record 71 { 72 public final static short sid = 0x13d; 73 public short[] field_1_tabids; 74 75 public TabIdRecord() 76 { 77 } 78 79 /** 80 * Constructs a TabID record and sets its fields appropriately. 81 * 82 * @param id id must be 0x13d 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 TabIdRecord(short id, short size, byte [] data) 88 { 89 super(id, size, data); 90 } 91 92 /** 93 * Constructs a TabID record and sets its fields appropriately. 94 * 95 * @param id id must be 0x13d 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 record 99 */ 100 101 public TabIdRecord(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 TABID RECORD"); 111 } 112 } 113 114 protected void fillFields(byte [] data, short size, int offset) 115 { 116 field_1_tabids = new short[ size / 2 ]; 117 for (int k = 0; k < field_1_tabids.length; k++) 118 { 119 field_1_tabids[ k ] = LittleEndian.getShort(data, 120 (k * 2) + offset); 121 } 122 } 123 124 /** 125 * set the tab array. (0,1,2). 126 * @param array of tab id's {0,1,2} 127 */ 128 129 public void setTabIdArray(short [] array) 130 { 131 field_1_tabids = array; 132 } 133 134 /** 135 * get the tab array. (0,1,2). 136 * @return array of tab id's {0,1,2} 137 */ 138 139 public short [] getTabIdArray() 140 { 141 return field_1_tabids; 142 } 143 144 public String toString() 145 { 146 StringBuffer buffer = new StringBuffer(); 147 148 buffer.append("[TABID]\n"); 149 buffer.append(" .elements = ").append(field_1_tabids.length) 150 .append("\n"); 151 for (int k = 0; k < field_1_tabids.length; k++) 152 { 153 buffer.append(" .element_" + k + " = ") 154 .append(field_1_tabids[ k ]).append("\n"); 155 } 156 buffer.append("[/TABID]\n"); 157 return buffer.toString(); 158 } 159 160 public int serialize(int offset, byte [] data) 161 { 162 short[] tabids = getTabIdArray(); 163 short length = ( short ) (tabids.length * 2); 164 int byteoffset = 4; 165 166 LittleEndian.putShort(data, 0 + offset, sid); 167 LittleEndian.putShort(data, 2 + offset, 168 (( short ) length)); // nubmer tabids * 169 170 // 2 (num bytes in a short) 171 for (int k = 0; k < (length / 2); k++) 172 { 173 LittleEndian.putShort(data, byteoffset + offset, tabids[ k ]); 174 byteoffset += 2; 175 } 176 return getRecordSize(); 177 } 178 179 public int getRecordSize() 180 { 181 return 4 + (getTabIdArray().length * 2); 182 } 183 184 public short getSid() 185 { 186 return this.sid; 187 } 188 } 189