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 dat record is used to store options for the 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 DatRecord 71 extends Record 72 { 73 public final static short sid = 0x1063; 74 private short field_1_options; 75 private BitField horizontalBorder = new BitField(0x1); 76 private BitField verticalBorder = new BitField(0x2); 77 private BitField border = new BitField(0x4); 78 private BitField showSeriesKey = new BitField(0x8); 79 80 81 public DatRecord() 82 { 83 84 } 85 86 /** 87 * Constructs a Dat record and sets its fields appropriately. 88 * 89 * @param id id must be 0x1063 or an exception 90 * will be throw upon validation 91 * @param size size the size of the data area of the record 92 * @param data data of the record (should not contain sid/len) 93 */ 94 95 public DatRecord(short id, short size, byte [] data) 96 { 97 super(id, size, data); 98 } 99 100 /** 101 * Constructs a Dat record and sets its fields appropriately. 102 * 103 * @param id id must be 0x1063 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 DatRecord(short id, short size, byte [] data, int offset) 111 { 112 super(id, size, data, offset); 113 } 114 115 /** 116 * Checks the sid matches the expected side for this record 117 * 118 * @param id the expected sid. 119 */ 120 protected void validateSid(short id) 121 { 122 if (id != sid) 123 { 124 throw new RecordFormatException("Not a Dat record"); 125 } 126 } 127 128 protected void fillFields(byte [] data, short size, int offset) 129 { 130 field_1_options = LittleEndian.getShort(data, 0x0 + offset); 131 132 } 133 134 public String toString() 135 { 136 StringBuffer buffer = new StringBuffer(); 137 138 buffer.append("[Dat]\n"); 139 140 buffer.append(" .options = ") 141 .append("0x") 142 .append(HexDump.toHex((short)getOptions())) 143 .append(" (").append(getOptions()).append(" )\n"); 144 buffer.append(" .horizontalBorder = ").append(isHorizontalBorder ()).append('\n'); 145 buffer.append(" .verticalBorder = ").append(isVerticalBorder ()).append('\n'); 146 buffer.append(" .border = ").append(isBorder ()).append('\n'); 147 buffer.append(" .showSeriesKey = ").append(isShowSeriesKey ()).append('\n'); 148 149 buffer.append("[/Dat]\n"); 150 return buffer.toString(); 151 } 152 153 public int serialize(int offset, byte[] data) 154 { 155 LittleEndian.putShort(data, 0 + offset, sid); 156 LittleEndian.putShort(data, 2 + offset, (short)(getRecordSize() - 4)); 157 158 LittleEndian.putShort(data, 4 + offset, field_1_options); 159 160 return getRecordSize(); 161 } 162 163 /** 164 * Size of record (exluding 4 byte header) 165 */ 166 public int getRecordSize() 167 { 168 return 4 + 2; 169 } 170 171 public short getSid() 172 { 173 return this.sid; 174 } 175 176 public Object clone() { 177 DatRecord rec = new DatRecord(); 178 179 rec.field_1_options = field_1_options; 180 181 return rec; 182 } 183 184 185 /** 186 * Get the options field for the Dat record. 187 */ 188 public short getOptions() 189 { 190 return field_1_options; 191 } 192 193 /** 194 * Set the options field for the Dat record. 195 */ 196 public void setOptions(short field_1_options) 197 { 198 this.field_1_options = field_1_options; 199 } 200 201 /** 202 * Sets the horizontal border field value. 203 * has a horizontal border 204 */ 205 public void setHorizontalBorder(boolean value) 206 { 207 field_1_options = horizontalBorder.setShortBoolean(field_1_options, value); 208 } 209 210 /** 211 * has a horizontal border 212 * @return the horizontal border field value. 213 */ 214 public boolean isHorizontalBorder() 215 { 216 return horizontalBorder.isSet(field_1_options); 217 } 218 219 /** 220 * Sets the vertical border field value. 221 * has vertical border 222 */ 223 public void setVerticalBorder(boolean value) 224 { 225 field_1_options = verticalBorder.setShortBoolean(field_1_options, value); 226 } 227 228 /** 229 * has vertical border 230 * @return the vertical border field value. 231 */ 232 public boolean isVerticalBorder() 233 { 234 return verticalBorder.isSet(field_1_options); 235 } 236 237 /** 238 * Sets the border field value. 239 * data table has a border 240 */ 241 public void setBorder(boolean value) 242 { 243 field_1_options = border.setShortBoolean(field_1_options, value); 244 } 245 246 /** 247 * data table has a border 248 * @return the border field value. 249 */ 250 public boolean isBorder() 251 { 252 return border.isSet(field_1_options); 253 } 254 255 /** 256 * Sets the show series key field value. 257 * shows the series key 258 */ 259 public void setShowSeriesKey(boolean value) 260 { 261 field_1_options = showSeriesKey.setShortBoolean(field_1_options, value); 262 } 263 264 /** 265 * shows the series key 266 * @return the show series key field value. 267 */ 268 public boolean isShowSeriesKey() 269 { 270 return showSeriesKey.isSet(field_1_options); 271 } 272 273 274 } // END OF CLASS 275 276 277 278 279