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: Dimensions Record<P> 62 * Description: provides the minumum and maximum bounds 63 * of a sheet.<P> 64 * REFERENCE: PG 303 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 DimensionsRecord 70 extends Record 71 { 72 public final static short sid = 0x200; 73 private int field_1_first_row; 74 private int field_2_last_row; // plus 1 75 private short field_3_first_col; 76 private short field_4_last_col; 77 private short field_5_zero; // must be 0 (reserved) 78 79 public DimensionsRecord() 80 { 81 } 82 83 /** 84 * Constructs a Dimensions record and sets its fields appropriately. 85 * 86 * @param id id must be 0x200 or an exception will be throw upon validation 87 * @param size the size of the data area of the record 88 * @param data data of the record (should not contain sid/len) 89 */ 90 91 public DimensionsRecord(short id, short size, byte [] data) 92 { 93 super(id, size, data); 94 } 95 96 /** 97 * Constructs a Dimensions record and sets its fields appropriately. 98 * 99 * @param id id must be 0x200 or an exception will be throw upon validation 100 * @param size the size of the data area of the record 101 * @param data data of the record (should not contain sid/len) 102 * @param offset of the record's data 103 */ 104 105 public DimensionsRecord(short id, short size, byte [] data, int offset) 106 { 107 super(id, size, data, offset); 108 } 109 110 protected void validateSid(short id) 111 { 112 if (id != sid) 113 { 114 throw new RecordFormatException("NOT A valid DIMENSIONS RECORD"); 115 } 116 } 117 118 protected void fillFields(byte [] data, short size, int offset) 119 { 120 field_1_first_row = LittleEndian.getInt(data, 0 + offset); 121 field_2_last_row = LittleEndian.getInt(data, 4 + offset); 122 field_3_first_col = LittleEndian.getShort(data, 8 + offset); 123 field_4_last_col = LittleEndian.getShort(data, 10 + offset); 124 field_5_zero = LittleEndian.getShort(data, 12 + offset); 125 } 126 127 /** 128 * set the first row number for the sheet 129 * @param row - first row on the sheet 130 */ 131 132 public void setFirstRow(int row) 133 { 134 field_1_first_row = row; 135 } 136 137 /** 138 * set the last row number for the sheet 139 * @param row - last row on the sheet 140 */ 141 142 public void setLastRow(int row) 143 { 144 field_2_last_row = row; 145 } 146 147 /** 148 * set the first column number for the sheet 149 * @param col first column on the sheet 150 */ 151 152 public void setFirstCol(short col) 153 { 154 field_3_first_col = col; 155 } 156 157 /** 158 * set the last col number for the sheet 159 * @param col last column on the sheet 160 */ 161 162 public void setLastCol(short col) 163 { 164 field_4_last_col = col; 165 } 166 167 /** 168 * get the first row number for the sheet 169 * @return row - first row on the sheet 170 */ 171 172 public int getFirstRow() 173 { 174 return field_1_first_row; 175 } 176 177 /** 178 * get the last row number for the sheet 179 * @return row - last row on the sheet 180 */ 181 182 public int getLastRow() 183 { 184 return field_2_last_row; 185 } 186 187 /** 188 * get the first column number for the sheet 189 * @return column - first column on the sheet 190 */ 191 192 public short getFirstCol() 193 { 194 return field_3_first_col; 195 } 196 197 /** 198 * get the last col number for the sheet 199 * @return column - last column on the sheet 200 */ 201 202 public short getLastCol() 203 { 204 return field_4_last_col; 205 } 206 207 public String toString() 208 { 209 StringBuffer buffer = new StringBuffer(); 210 211 buffer.append("[DIMENSIONS]\n"); 212 buffer.append(" .firstrow = ") 213 .append(Integer.toHexString(getFirstRow())).append("\n"); 214 buffer.append(" .lastrow = ") 215 .append(Integer.toHexString(getLastRow())).append("\n"); 216 buffer.append(" .firstcol = ") 217 .append(Integer.toHexString(getFirstCol())).append("\n"); 218 buffer.append(" .lastcol = ") 219 .append(Integer.toHexString(getLastCol())).append("\n"); 220 buffer.append(" .zero = ") 221 .append(Integer.toHexString(field_5_zero)).append("\n"); 222 buffer.append("[/DIMENSIONS]\n"); 223 return buffer.toString(); 224 } 225 226 public int serialize(int offset, byte [] data) 227 { 228 LittleEndian.putShort(data, 0 + offset, sid); 229 LittleEndian.putShort(data, 2 + offset, ( short ) 14); 230 LittleEndian.putInt(data, 4 + offset, getFirstRow()); 231 LittleEndian.putInt(data, 8 + offset, getLastRow()); 232 LittleEndian.putShort(data, 12 + offset, getFirstCol()); 233 LittleEndian.putShort(data, 14 + offset, getLastCol()); 234 LittleEndian.putShort(data, 16 + offset, ( short ) 0); 235 return getRecordSize(); 236 } 237 238 public int getRecordSize() 239 { 240 return 18; 241 } 242 243 public short getSid() 244 { 245 return this.sid; 246 } 247 } 248