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 * Links text to an object on the chart or identifies it as the title. 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 Andrew C. Oliver (acoliver at apache.org) 69 */ 70 public class ObjectLinkRecord 71 extends Record 72 { 73 public final static short sid = 0x1027; 74 private short field_1_anchorId; 75 public final static short ANCHOR_ID_CHART_TITLE = 1; 76 public final static short ANCHOR_ID_Y_AXIS = 2; 77 public final static short ANCHOR_ID_X_AXIS = 3; 78 public final static short ANCHOR_ID_SERIES_OR_POINT = 4; 79 public final static short ANCHOR_ID_Z_AXIS = 7; 80 private short field_2_link1; 81 private short field_3_link2; 82 83 84 public ObjectLinkRecord() 85 { 86 87 } 88 89 /** 90 * Constructs a ObjectLink record and sets its fields appropriately. 91 * 92 * @param id id must be 0x1027 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 ObjectLinkRecord(short id, short size, byte [] data) 99 { 100 super(id, size, data); 101 102 } 103 104 /** 105 * Constructs a ObjectLink record and sets its fields appropriately. 106 * 107 * @param id id must be 0x1027 or an exception 108 * will be throw upon validation 109 * @param size size the size of the data area of the record 110 * @param data data of the record (should not contain sid/len) 111 * @param offset of the record's data 112 */ 113 114 public ObjectLinkRecord(short id, short size, byte [] data, int offset) 115 { 116 super(id, size, data, offset); 117 118 } 119 120 /** 121 * Checks the sid matches the expected side for this record 122 * 123 * @param id the expected sid. 124 */ 125 protected void validateSid(short id) 126 { 127 if (id != sid) 128 { 129 throw new RecordFormatException("Not a ObjectLink record"); 130 } 131 } 132 133 protected void fillFields(byte [] data, short size, int offset) 134 { 135 136 int pos = 0; 137 field_1_anchorId = LittleEndian.getShort(data, pos + 0x0 + offset); 138 field_2_link1 = LittleEndian.getShort(data, pos + 0x2 + offset); 139 field_3_link2 = LittleEndian.getShort(data, pos + 0x4 + offset); 140 141 } 142 143 public String toString() 144 { 145 StringBuffer buffer = new StringBuffer(); 146 147 buffer.append("[OBJECTLINK]\n"); 148 buffer.append(" .anchorId = ") 149 .append("0x").append(HexDump.toHex( getAnchorId ())) 150 .append(" (").append( getAnchorId() ).append(" )"); 151 buffer.append(System.getProperty("line.separator")); 152 buffer.append(" .link1 = ") 153 .append("0x").append(HexDump.toHex( getLink1 ())) 154 .append(" (").append( getLink1() ).append(" )"); 155 buffer.append(System.getProperty("line.separator")); 156 buffer.append(" .link2 = ") 157 .append("0x").append(HexDump.toHex( getLink2 ())) 158 .append(" (").append( getLink2() ).append(" )"); 159 buffer.append(System.getProperty("line.separator")); 160 161 buffer.append("[/OBJECTLINK]\n"); 162 return buffer.toString(); 163 } 164 165 public int serialize(int offset, byte[] data) 166 { 167 int pos = 0; 168 169 LittleEndian.putShort(data, 0 + offset, sid); 170 LittleEndian.putShort(data, 2 + offset, (short)(getRecordSize() - 4)); 171 172 LittleEndian.putShort(data, 4 + offset + pos, field_1_anchorId); 173 LittleEndian.putShort(data, 6 + offset + pos, field_2_link1); 174 LittleEndian.putShort(data, 8 + offset + pos, field_3_link2); 175 176 return getRecordSize(); 177 } 178 179 /** 180 * Size of record (exluding 4 byte header) 181 */ 182 public int getRecordSize() 183 { 184 return 4 + 2 + 2 + 2; 185 } 186 187 public short getSid() 188 { 189 return this.sid; 190 } 191 192 public Object clone() { 193 ObjectLinkRecord rec = new ObjectLinkRecord(); 194 195 rec.field_1_anchorId = field_1_anchorId; 196 rec.field_2_link1 = field_2_link1; 197 rec.field_3_link2 = field_3_link2; 198 return rec; 199 } 200 201 202 203 204 /** 205 * Get the anchor id field for the ObjectLink record. 206 * 207 * @return One of 208 * ANCHOR_ID_CHART_TITLE 209 * ANCHOR_ID_Y_AXIS 210 * ANCHOR_ID_X_AXIS 211 * ANCHOR_ID_SERIES_OR_POINT 212 * ANCHOR_ID_Z_AXIS 213 */ 214 public short getAnchorId() 215 { 216 return field_1_anchorId; 217 } 218 219 /** 220 * Set the anchor id field for the ObjectLink record. 221 * 222 * @param field_1_anchorId 223 * One of 224 * ANCHOR_ID_CHART_TITLE 225 * ANCHOR_ID_Y_AXIS 226 * ANCHOR_ID_X_AXIS 227 * ANCHOR_ID_SERIES_OR_POINT 228 * ANCHOR_ID_Z_AXIS 229 */ 230 public void setAnchorId(short field_1_anchorId) 231 { 232 this.field_1_anchorId = field_1_anchorId; 233 } 234 235 /** 236 * Get the link 1 field for the ObjectLink record. 237 */ 238 public short getLink1() 239 { 240 return field_2_link1; 241 } 242 243 /** 244 * Set the link 1 field for the ObjectLink record. 245 */ 246 public void setLink1(short field_2_link1) 247 { 248 this.field_2_link1 = field_2_link1; 249 } 250 251 /** 252 * Get the link 2 field for the ObjectLink record. 253 */ 254 public short getLink2() 255 { 256 return field_3_link2; 257 } 258 259 /** 260 * Set the link 2 field for the ObjectLink record. 261 */ 262 public void setLink2(short field_3_link2) 263 { 264 this.field_3_link2 = field_3_link2; 265 } 266 267 268 } // END OF CLASS 269 270 271 272 273