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 57 package org.apache.poi.hssf.record; 58 59 60 61 import org.apache.poi.util.BitField; 62 import org.apache.poi.util.LittleEndian; 63 import org.apache.poi.util.StringUtil; 64 import org.apache.poi.util.HexDump; 65 66 /** 67 * The font basis record stores various font metrics. 68 * NOTE: This source is automatically generated please do not modify this file. Either subclass or 69 * remove the record in src/records/definitions. 70 71 * @author Glen Stampoultzis (glens at apache.org) 72 */ 73 public class FontBasisRecord 74 extends Record 75 { 76 public final static short sid = 0x1060; 77 private short field_1_xBasis; 78 private short field_2_yBasis; 79 private short field_3_heightBasis; 80 private short field_4_scale; 81 private short field_5_indexToFontTable; 82 83 84 public FontBasisRecord() 85 { 86 87 } 88 89 /** 90 * Constructs a FontBasis record and sets its fields appropriately. 91 * 92 * @param id id must be 0x1060 or an exception 93 * will be throw upon validation 94 * @param size size the size of the data area of the record 95 * @param data data of the record (should not contain sid/len) 96 */ 97 98 public FontBasisRecord(short id, short size, byte [] data) 99 { 100 super(id, size, data); 101 } 102 103 /** 104 * Constructs a FontBasis record and sets its fields appropriately. 105 * 106 * @param id id must be 0x1060 or an exception 107 * will be throw upon validation 108 * @param size size the size of the data area of the record 109 * @param data data of the record (should not contain sid/len) 110 * @param offset of the record's data 111 */ 112 113 public FontBasisRecord(short id, short size, byte [] data, int offset) 114 { 115 super(id, size, data, offset); 116 } 117 118 /** 119 * Checks the sid matches the expected side for this record 120 * 121 * @param id the expected sid. 122 */ 123 protected void validateSid(short id) 124 { 125 if (id != sid) 126 { 127 throw new RecordFormatException("Not a FontBasis record"); 128 } 129 } 130 131 protected void fillFields(byte [] data, short size, int offset) 132 { 133 field_1_xBasis = LittleEndian.getShort(data, 0x0 + offset); 134 field_2_yBasis = LittleEndian.getShort(data, 0x2 + offset); 135 field_3_heightBasis = LittleEndian.getShort(data, 0x4 + offset); 136 field_4_scale = LittleEndian.getShort(data, 0x6 + offset); 137 field_5_indexToFontTable = LittleEndian.getShort(data, 0x8 + offset); 138 139 } 140 141 public String toString() 142 { 143 StringBuffer buffer = new StringBuffer(); 144 145 buffer.append("[FontBasis]\n"); 146 147 buffer.append(" .xBasis = ") 148 .append("0x") 149 .append(HexDump.toHex((short)getXBasis())) 150 .append(" (").append(getXBasis()).append(" )\n"); 151 152 buffer.append(" .yBasis = ") 153 .append("0x") 154 .append(HexDump.toHex((short)getYBasis())) 155 .append(" (").append(getYBasis()).append(" )\n"); 156 157 buffer.append(" .heightBasis = ") 158 .append("0x") 159 .append(HexDump.toHex((short)getHeightBasis())) 160 .append(" (").append(getHeightBasis()).append(" )\n"); 161 162 buffer.append(" .scale = ") 163 .append("0x") 164 .append(HexDump.toHex((short)getScale())) 165 .append(" (").append(getScale()).append(" )\n"); 166 167 buffer.append(" .indexToFontTable = ") 168 .append("0x") 169 .append(HexDump.toHex((short)getIndexToFontTable())) 170 .append(" (").append(getIndexToFontTable()).append(" )\n"); 171 172 buffer.append("[/FontBasis]\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)(getRecordSize() - 4)); 180 181 LittleEndian.putShort(data, 4 + offset, field_1_xBasis); 182 LittleEndian.putShort(data, 6 + offset, field_2_yBasis); 183 LittleEndian.putShort(data, 8 + offset, field_3_heightBasis); 184 LittleEndian.putShort(data, 10 + offset, field_4_scale); 185 LittleEndian.putShort(data, 12 + offset, field_5_indexToFontTable); 186 187 return getRecordSize(); 188 } 189 190 /** 191 * Size of record (exluding 4 byte header) 192 */ 193 public int getRecordSize() 194 { 195 return 4 + 2 + 2 + 2 + 2 + 2; 196 } 197 198 public short getSid() 199 { 200 return this.sid; 201 } 202 203 204 /** 205 * Get the x Basis field for the FontBasis record. 206 */ 207 public short getXBasis() 208 { 209 return field_1_xBasis; 210 } 211 212 /** 213 * Set the x Basis field for the FontBasis record. 214 */ 215 public void setXBasis(short field_1_xBasis) 216 { 217 this.field_1_xBasis = field_1_xBasis; 218 } 219 220 /** 221 * Get the y Basis field for the FontBasis record. 222 */ 223 public short getYBasis() 224 { 225 return field_2_yBasis; 226 } 227 228 /** 229 * Set the y Basis field for the FontBasis record. 230 */ 231 public void setYBasis(short field_2_yBasis) 232 { 233 this.field_2_yBasis = field_2_yBasis; 234 } 235 236 /** 237 * Get the height basis field for the FontBasis record. 238 */ 239 public short getHeightBasis() 240 { 241 return field_3_heightBasis; 242 } 243 244 /** 245 * Set the height basis field for the FontBasis record. 246 */ 247 public void setHeightBasis(short field_3_heightBasis) 248 { 249 this.field_3_heightBasis = field_3_heightBasis; 250 } 251 252 /** 253 * Get the scale field for the FontBasis record. 254 */ 255 public short getScale() 256 { 257 return field_4_scale; 258 } 259 260 /** 261 * Set the scale field for the FontBasis record. 262 */ 263 public void setScale(short field_4_scale) 264 { 265 this.field_4_scale = field_4_scale; 266 } 267 268 /** 269 * Get the index to font table field for the FontBasis record. 270 */ 271 public short getIndexToFontTable() 272 { 273 return field_5_indexToFontTable; 274 } 275 276 /** 277 * Set the index to font table field for the FontBasis record. 278 */ 279 public void setIndexToFontTable(short field_5_indexToFontTable) 280 { 281 this.field_5_indexToFontTable = field_5_indexToFontTable; 282 } 283 284 285 } // END OF CLASS 286 287 288 289 290