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: Default Row Height Record 62 * Description: Row height for rows with undefined or not explicitly defined 63 * heights. 64 * REFERENCE: PG 301 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 DefaultRowHeightRecord 71 extends Record 72 { 73 public final static short sid = 0x225; 74 private short field_1_option_flags; 75 private short field_2_row_height; 76 77 public DefaultRowHeightRecord() 78 { 79 } 80 81 /** 82 * Constructs a DefaultRowHeight record and sets its fields appropriately. 83 * 84 * @param id id must be 0x225 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 DefaultRowHeightRecord(short id, short size, byte [] data) 90 { 91 super(id, size, data); 92 } 93 94 /** 95 * Constructs a DefaultRowHeight record and sets its fields appropriately. 96 * 97 * @param id id must be 0x225 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 records data 101 */ 102 103 public DefaultRowHeightRecord(short id, short size, byte [] data, 104 int offset) 105 { 106 super(id, size, data, offset); 107 } 108 109 protected void validateSid(short id) 110 { 111 if (id != sid) 112 { 113 throw new RecordFormatException("NOT A DefaultRowHeight RECORD"); 114 } 115 } 116 117 protected void fillFields(byte [] data, short size, int offset) 118 { 119 field_1_option_flags = LittleEndian.getShort(data, 0 + offset); 120 field_2_row_height = LittleEndian.getShort(data, 2 + offset); 121 } 122 123 /** 124 * set the (currently unimportant to HSSF) option flags 125 * @param flags the bitmask to set 126 */ 127 128 public void setOptionFlags(short flags) 129 { 130 field_1_option_flags = flags; 131 } 132 133 /** 134 * set the default row height 135 * @param height for undefined rows/rows w/undefined height 136 */ 137 138 public void setRowHeight(short height) 139 { 140 field_2_row_height = height; 141 } 142 143 /** 144 * get the (currently unimportant to HSSF) option flags 145 * @return flags - the current bitmask 146 */ 147 148 public short getOptionFlags() 149 { 150 return field_1_option_flags; 151 } 152 153 /** 154 * get the default row height 155 * @return rowheight for undefined rows/rows w/undefined height 156 */ 157 158 public short getRowHeight() 159 { 160 return field_2_row_height; 161 } 162 163 public String toString() 164 { 165 StringBuffer buffer = new StringBuffer(); 166 167 buffer.append("[DEFAULTROWHEIGHT]\n"); 168 buffer.append(" .optionflags = ") 169 .append(Integer.toHexString(getOptionFlags())).append("\n"); 170 buffer.append(" .rowheight = ") 171 .append(Integer.toHexString(getRowHeight())).append("\n"); 172 buffer.append("[/DEFAULTROWHEIGHT]\n"); 173 return buffer.toString(); 174 } 175 176 public int serialize(int offset, byte [] data) 177 { 178 LittleEndian.putShort(data, 0 + offset, sid); 179 LittleEndian.putShort(data, 2 + offset, ( short ) 0x4); 180 LittleEndian.putShort(data, 4 + offset, getOptionFlags()); 181 LittleEndian.putShort(data, 6 + offset, getRowHeight()); 182 return getRecordSize(); 183 } 184 185 public int getRecordSize() 186 { 187 return 8; 188 } 189 190 public short getSid() 191 { 192 return this.sid; 193 } 194 195 public Object clone() { 196 DefaultRowHeightRecord rec = new DefaultRowHeightRecord(); 197 rec.field_1_option_flags = field_1_option_flags; 198 rec.field_2_row_height = field_2_row_height; 199 return rec; 200 } 201 } 202