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