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