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