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 data format record is used to index into a series. 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 DataFormatRecord 74 extends Record 75 { 76 public final static short sid = 0x1006; 77 private short field_1_pointNumber; 78 private short field_2_seriesIndex; 79 private short field_3_seriesNumber; 80 private short field_4_formatFlags; 81 private BitField useExcel4Colors = new BitField(0x1); 82 83 84 public DataFormatRecord() 85 { 86 87 } 88 89 /** 90 * Constructs a DataFormat record and sets its fields appropriately. 91 * 92 * @param id id must be 0x1006 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 DataFormatRecord(short id, short size, byte [] data) 99 { 100 super(id, size, data); 101 } 102 103 /** 104 * Constructs a DataFormat record and sets its fields appropriately. 105 * 106 * @param id id must be 0x1006 or an exception 107 * will be throw upon validation 108 * @param size size the size of the data area of the record 109 * @param data data of the record (should not contain sid/len) 110 * @param offset of the record's data 111 */ 112 113 public DataFormatRecord(short id, short size, byte [] data, int offset) 114 { 115 super(id, size, data, offset); 116 } 117 118 /** 119 * Checks the sid matches the expected side for this record 120 * 121 * @param id the expected sid. 122 */ 123 protected void validateSid(short id) 124 { 125 if (id != sid) 126 { 127 throw new RecordFormatException("Not a DataFormat record"); 128 } 129 } 130 131 protected void fillFields(byte [] data, short size, int offset) 132 { 133 field_1_pointNumber = LittleEndian.getShort(data, 0x0 + offset); 134 field_2_seriesIndex = LittleEndian.getShort(data, 0x2 + offset); 135 field_3_seriesNumber = LittleEndian.getShort(data, 0x4 + offset); 136 field_4_formatFlags = LittleEndian.getShort(data, 0x6 + offset); 137 138 } 139 140 public String toString() 141 { 142 StringBuffer buffer = new StringBuffer(); 143 144 buffer.append("[DataFormat]\n"); 145 146 buffer.append(" .pointNumber = ") 147 .append("0x") 148 .append(HexDump.toHex((short)getPointNumber())) 149 .append(" (").append(getPointNumber()).append(" )\n"); 150 151 buffer.append(" .seriesIndex = ") 152 .append("0x") 153 .append(HexDump.toHex((short)getSeriesIndex())) 154 .append(" (").append(getSeriesIndex()).append(" )\n"); 155 156 buffer.append(" .seriesNumber = ") 157 .append("0x") 158 .append(HexDump.toHex((short)getSeriesNumber())) 159 .append(" (").append(getSeriesNumber()).append(" )\n"); 160 161 buffer.append(" .formatFlags = ") 162 .append("0x") 163 .append(HexDump.toHex((short)getFormatFlags())) 164 .append(" (").append(getFormatFlags()).append(" )\n"); 165 buffer.append(" .useExcel4Colors = ").append(isUseExcel4Colors ()).append('\n'); 166 167 buffer.append("[/DataFormat]\n"); 168 return buffer.toString(); 169 } 170 171 public int serialize(int offset, byte[] data) 172 { 173 LittleEndian.putShort(data, 0 + offset, sid); 174 LittleEndian.putShort(data, 2 + offset, (short)(getRecordSize() - 4)); 175 176 LittleEndian.putShort(data, 4 + offset, field_1_pointNumber); 177 LittleEndian.putShort(data, 6 + offset, field_2_seriesIndex); 178 LittleEndian.putShort(data, 8 + offset, field_3_seriesNumber); 179 LittleEndian.putShort(data, 10 + offset, field_4_formatFlags); 180 181 return getRecordSize(); 182 } 183 184 /** 185 * Size of record (exluding 4 byte header) 186 */ 187 public int getRecordSize() 188 { 189 return 4 + 2 + 2 + 2 + 2; 190 } 191 192 public short getSid() 193 { 194 return this.sid; 195 } 196 197 198 /** 199 * Get the point number field for the DataFormat record. 200 */ 201 public short getPointNumber() 202 { 203 return field_1_pointNumber; 204 } 205 206 /** 207 * Set the point number field for the DataFormat record. 208 */ 209 public void setPointNumber(short field_1_pointNumber) 210 { 211 this.field_1_pointNumber = field_1_pointNumber; 212 } 213 214 /** 215 * Get the series index field for the DataFormat record. 216 */ 217 public short getSeriesIndex() 218 { 219 return field_2_seriesIndex; 220 } 221 222 /** 223 * Set the series index field for the DataFormat record. 224 */ 225 public void setSeriesIndex(short field_2_seriesIndex) 226 { 227 this.field_2_seriesIndex = field_2_seriesIndex; 228 } 229 230 /** 231 * Get the series number field for the DataFormat record. 232 */ 233 public short getSeriesNumber() 234 { 235 return field_3_seriesNumber; 236 } 237 238 /** 239 * Set the series number field for the DataFormat record. 240 */ 241 public void setSeriesNumber(short field_3_seriesNumber) 242 { 243 this.field_3_seriesNumber = field_3_seriesNumber; 244 } 245 246 /** 247 * Get the format flags field for the DataFormat record. 248 */ 249 public short getFormatFlags() 250 { 251 return field_4_formatFlags; 252 } 253 254 /** 255 * Set the format flags field for the DataFormat record. 256 */ 257 public void setFormatFlags(short field_4_formatFlags) 258 { 259 this.field_4_formatFlags = field_4_formatFlags; 260 } 261 262 /** 263 * Sets the use excel 4 colors field value. 264 * set true to use excel 4 colors. 265 */ 266 public void setUseExcel4Colors(boolean value) 267 { 268 field_4_formatFlags = useExcel4Colors.setShortBoolean(field_4_formatFlags, value); 269 } 270 271 /** 272 * set true to use excel 4 colors. 273 * @return the use excel 4 colors field value. 274 */ 275 public boolean isUseExcel4Colors() 276 { 277 return useExcel4Colors.isSet(field_4_formatFlags); 278 } 279 280 281 } // END OF CLASS 282 283 284 285 286