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 frame record indicates whether there is a border around the displayed text 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 FrameRecord 71 extends Record 72 { 73 public final static short sid = 0x1032; 74 private short field_1_borderType; 75 public final static short BORDER_TYPE_REGULAR = 0; 76 public final static short BORDER_TYPE_SHADOW = 1; 77 private short field_2_options; 78 private BitField autoSize = new BitField(0x1); 79 private BitField autoPosition = new BitField(0x2); 80 81 82 public FrameRecord() 83 { 84 85 } 86 87 /** 88 * Constructs a Frame record and sets its fields appropriately. 89 * 90 * @param id id must be 0x1032 or an exception 91 * will be throw upon validation 92 * @param size size the size of the data area of the record 93 * @param data data of the record (should not contain sid/len) 94 */ 95 96 public FrameRecord(short id, short size, byte [] data) 97 { 98 super(id, size, data); 99 } 100 101 /** 102 * Constructs a Frame record and sets its fields appropriately. 103 * 104 * @param id id must be 0x1032 or an exception 105 * will be throw upon validation 106 * @param size size the size of the data area of the record 107 * @param data data of the record (should not contain sid/len) 108 * @param offset of the record's data 109 */ 110 111 public FrameRecord(short id, short size, byte [] data, int offset) 112 { 113 super(id, size, data, offset); 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 Frame record"); 126 } 127 } 128 129 protected void fillFields(byte [] data, short size, int offset) 130 { 131 field_1_borderType = LittleEndian.getShort(data, 0x0 + offset); 132 field_2_options = LittleEndian.getShort(data, 0x2 + offset); 133 134 } 135 136 public String toString() 137 { 138 StringBuffer buffer = new StringBuffer(); 139 140 buffer.append("[Frame]\n"); 141 142 buffer.append(" .borderType = ") 143 .append("0x") 144 .append(HexDump.toHex((short)getBorderType())) 145 .append(" (").append(getBorderType()).append(" )\n"); 146 147 buffer.append(" .options = ") 148 .append("0x") 149 .append(HexDump.toHex((short)getOptions())) 150 .append(" (").append(getOptions()).append(" )\n"); 151 buffer.append(" .autoSize = ").append(isAutoSize ()).append('\n'); 152 buffer.append(" .autoPosition = ").append(isAutoPosition ()).append('\n'); 153 154 buffer.append("[/Frame]\n"); 155 return buffer.toString(); 156 } 157 158 public int serialize(int offset, byte[] data) 159 { 160 LittleEndian.putShort(data, 0 + offset, sid); 161 LittleEndian.putShort(data, 2 + offset, (short)(getRecordSize() - 4)); 162 163 LittleEndian.putShort(data, 4 + offset, field_1_borderType); 164 LittleEndian.putShort(data, 6 + offset, field_2_options); 165 166 return getRecordSize(); 167 } 168 169 /** 170 * Size of record (exluding 4 byte header) 171 */ 172 public int getRecordSize() 173 { 174 return 4 + 2 + 2; 175 } 176 177 public short getSid() 178 { 179 return this.sid; 180 } 181 182 public Object clone() { 183 FrameRecord rec = new FrameRecord(); 184 185 rec.field_1_borderType = field_1_borderType; 186 rec.field_2_options = field_2_options; 187 188 return rec; 189 } 190 191 192 /** 193 * Get the border type field for the Frame record. 194 * 195 * @return One of 196 * BORDER_TYPE_REGULAR 197 * BORDER_TYPE_SHADOW 198 */ 199 public short getBorderType() 200 { 201 return field_1_borderType; 202 } 203 204 /** 205 * Set the border type field for the Frame record. 206 * 207 * @param field_1_borderType 208 * One of 209 * BORDER_TYPE_REGULAR 210 * BORDER_TYPE_SHADOW 211 */ 212 public void setBorderType(short field_1_borderType) 213 { 214 this.field_1_borderType = field_1_borderType; 215 } 216 217 /** 218 * Get the options field for the Frame record. 219 */ 220 public short getOptions() 221 { 222 return field_2_options; 223 } 224 225 /** 226 * Set the options field for the Frame record. 227 */ 228 public void setOptions(short field_2_options) 229 { 230 this.field_2_options = field_2_options; 231 } 232 233 /** 234 * Sets the auto size field value. 235 * excel calculates the size automatically if true 236 */ 237 public void setAutoSize(boolean value) 238 { 239 field_2_options = autoSize.setShortBoolean(field_2_options, value); 240 } 241 242 /** 243 * excel calculates the size automatically if true 244 * @return the auto size field value. 245 */ 246 public boolean isAutoSize() 247 { 248 return autoSize.isSet(field_2_options); 249 } 250 251 /** 252 * Sets the auto position field value. 253 * excel calculates the position automatically 254 */ 255 public void setAutoPosition(boolean value) 256 { 257 field_2_options = autoPosition.setShortBoolean(field_2_options, value); 258 } 259 260 /** 261 * excel calculates the position automatically 262 * @return the auto position field value. 263 */ 264 public boolean isAutoPosition() 265 { 266 return autoPosition.isSet(field_2_options); 267 } 268 269 270 } // END OF CLASS 271 272 273 274 275