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 chart record is used to define the location and size of a chart. 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 ChartRecord 74 extends Record 75 { 76 public final static short sid = 0x1002; 77 private int field_1_x; 78 private int field_2_y; 79 private int field_3_width; 80 private int field_4_height; 81 82 83 public ChartRecord() 84 { 85 86 } 87 88 /** 89 * Constructs a Chart record and sets its fields appropriately. 90 * 91 * @param id id must be 0x1002 or an exception 92 * will be throw upon validation 93 * @param size size the size of the data area of the record 94 * @param data data of the record (should not contain sid/len) 95 */ 96 97 public ChartRecord(short id, short size, byte [] data) 98 { 99 super(id, size, data); 100 } 101 102 /** 103 * Constructs a Chart record and sets its fields appropriately. 104 * 105 * @param id id must be 0x1002 or an exception 106 * will be throw upon validation 107 * @param size size the size of the data area of the record 108 * @param data data of the record (should not contain sid/len) 109 * @param offset of the record's data 110 */ 111 112 public ChartRecord(short id, short size, byte [] data, int offset) 113 { 114 super(id, size, data, offset); 115 } 116 117 /** 118 * Checks the sid matches the expected side for this record 119 * 120 * @param id the expected sid. 121 */ 122 protected void validateSid(short id) 123 { 124 if (id != sid) 125 { 126 throw new RecordFormatException("Not a Chart record"); 127 } 128 } 129 130 protected void fillFields(byte [] data, short size, int offset) 131 { 132 field_1_x = LittleEndian.getInt(data, 0x0 + offset); 133 field_2_y = LittleEndian.getInt(data, 0x4 + offset); 134 field_3_width = LittleEndian.getInt(data, 0x8 + offset); 135 field_4_height = LittleEndian.getInt(data, 0xc + offset); 136 137 } 138 139 public String toString() 140 { 141 StringBuffer buffer = new StringBuffer(); 142 143 buffer.append("[Chart]\n"); 144 145 buffer.append(" .x = ") 146 .append("0x") 147 .append(HexDump.toHex((int)getX())) 148 .append(" (").append(getX()).append(" )\n"); 149 150 buffer.append(" .y = ") 151 .append("0x") 152 .append(HexDump.toHex((int)getY())) 153 .append(" (").append(getY()).append(" )\n"); 154 155 buffer.append(" .width = ") 156 .append("0x") 157 .append(HexDump.toHex((int)getWidth())) 158 .append(" (").append(getWidth()).append(" )\n"); 159 160 buffer.append(" .height = ") 161 .append("0x") 162 .append(HexDump.toHex((int)getHeight())) 163 .append(" (").append(getHeight()).append(" )\n"); 164 165 buffer.append("[/Chart]\n"); 166 return buffer.toString(); 167 } 168 169 public int serialize(int offset, byte[] data) 170 { 171 LittleEndian.putShort(data, 0 + offset, sid); 172 LittleEndian.putShort(data, 2 + offset, (short)(getRecordSize() - 4)); 173 174 LittleEndian.putInt(data, 4 + offset, field_1_x); 175 LittleEndian.putInt(data, 8 + offset, field_2_y); 176 LittleEndian.putInt(data, 12 + offset, field_3_width); 177 LittleEndian.putInt(data, 16 + offset, field_4_height); 178 179 return getRecordSize(); 180 } 181 182 /** 183 * Size of record (exluding 4 byte header) 184 */ 185 public int getRecordSize() 186 { 187 return 4 + 4 + 4 + 4 + 4; 188 } 189 190 public short getSid() 191 { 192 return this.sid; 193 } 194 195 196 /** 197 * Get the x field for the Chart record. 198 */ 199 public int getX() 200 { 201 return field_1_x; 202 } 203 204 /** 205 * Set the x field for the Chart record. 206 */ 207 public void setX(int field_1_x) 208 { 209 this.field_1_x = field_1_x; 210 } 211 212 /** 213 * Get the y field for the Chart record. 214 */ 215 public int getY() 216 { 217 return field_2_y; 218 } 219 220 /** 221 * Set the y field for the Chart record. 222 */ 223 public void setY(int field_2_y) 224 { 225 this.field_2_y = field_2_y; 226 } 227 228 /** 229 * Get the width field for the Chart record. 230 */ 231 public int getWidth() 232 { 233 return field_3_width; 234 } 235 236 /** 237 * Set the width field for the Chart record. 238 */ 239 public void setWidth(int field_3_width) 240 { 241 this.field_3_width = field_3_width; 242 } 243 244 /** 245 * Get the height field for the Chart record. 246 */ 247 public int getHeight() 248 { 249 return field_4_height; 250 } 251 252 /** 253 * Set the height field for the Chart record. 254 */ 255 public void setHeight(int field_4_height) 256 { 257 this.field_4_height = field_4_height; 258 } 259 260 261 } // END OF CLASS 262 263 264 265 266