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 area record is used to define a area chart. 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 AreaRecord 74 extends Record 75 { 76 public final static short sid = 0x101A; 77 private short field_1_formatFlags; 78 private BitField stacked = new BitField(0x1); 79 private BitField displayAsPercentage = new BitField(0x2); 80 private BitField shadow = new BitField(0x4); 81 82 83 public AreaRecord() 84 { 85 86 } 87 88 /** 89 * Constructs a Area record and sets its fields appropriately. 90 * 91 * @param id id must be 0x101A or an exception 92 * will be throw upon validation 93 * @param size size the size of the data area of the record 94 * @param data data of the record (should not contain sid/len) 95 */ 96 97 public AreaRecord(short id, short size, byte [] data) 98 { 99 super(id, size, data); 100 } 101 102 /** 103 * Constructs a Area record and sets its fields appropriately. 104 * 105 * @param id id must be 0x101A or an exception 106 * will be throw upon validation 107 * @param size size the size of the data area of the record 108 * @param data data of the record (should not contain sid/len) 109 * @param offset of the record's data 110 */ 111 112 public AreaRecord(short id, short size, byte [] data, int offset) 113 { 114 super(id, size, data, offset); 115 } 116 117 /** 118 * Checks the sid matches the expected side for this record 119 * 120 * @param id the expected sid. 121 */ 122 protected void validateSid(short id) 123 { 124 if (id != sid) 125 { 126 throw new RecordFormatException("Not a Area record"); 127 } 128 } 129 130 protected void fillFields(byte [] data, short size, int offset) 131 { 132 field_1_formatFlags = LittleEndian.getShort(data, 0x0 + offset); 133 134 } 135 136 public String toString() 137 { 138 StringBuffer buffer = new StringBuffer(); 139 140 buffer.append("[Area]\n"); 141 142 buffer.append(" .formatFlags = ") 143 .append("0x") 144 .append(HexDump.toHex((short)getFormatFlags())) 145 .append(" (").append(getFormatFlags()).append(" )\n"); 146 buffer.append(" .stacked = ").append(isStacked ()).append('\n'); 147 buffer.append(" .displayAsPercentage = ").append(isDisplayAsPercentage ()).append('\n'); 148 buffer.append(" .shadow = ").append(isShadow ()).append('\n'); 149 150 buffer.append("[/Area]\n"); 151 return buffer.toString(); 152 } 153 154 public int serialize(int offset, byte[] data) 155 { 156 LittleEndian.putShort(data, 0 + offset, sid); 157 LittleEndian.putShort(data, 2 + offset, (short)(getRecordSize() - 4)); 158 159 LittleEndian.putShort(data, 4 + offset, field_1_formatFlags); 160 161 return getRecordSize(); 162 } 163 164 /** 165 * Size of record (exluding 4 byte header) 166 */ 167 public int getRecordSize() 168 { 169 return 4 + 2; 170 } 171 172 public short getSid() 173 { 174 return this.sid; 175 } 176 177 178 /** 179 * Get the format flags field for the Area record. 180 */ 181 public short getFormatFlags() 182 { 183 return field_1_formatFlags; 184 } 185 186 /** 187 * Set the format flags field for the Area record. 188 */ 189 public void setFormatFlags(short field_1_formatFlags) 190 { 191 this.field_1_formatFlags = field_1_formatFlags; 192 } 193 194 /** 195 * Sets the stacked field value. 196 * series is stacked 197 */ 198 public void setStacked(boolean value) 199 { 200 field_1_formatFlags = stacked.setShortBoolean(field_1_formatFlags, value); 201 } 202 203 /** 204 * series is stacked 205 * @return the stacked field value. 206 */ 207 public boolean isStacked() 208 { 209 return stacked.isSet(field_1_formatFlags); 210 } 211 212 /** 213 * Sets the display as percentage field value. 214 * results displayed as percentages 215 */ 216 public void setDisplayAsPercentage(boolean value) 217 { 218 field_1_formatFlags = displayAsPercentage.setShortBoolean(field_1_formatFlags, value); 219 } 220 221 /** 222 * results displayed as percentages 223 * @return the display as percentage field value. 224 */ 225 public boolean isDisplayAsPercentage() 226 { 227 return displayAsPercentage.isSet(field_1_formatFlags); 228 } 229 230 /** 231 * Sets the shadow field value. 232 * display a shadow for the chart 233 */ 234 public void setShadow(boolean value) 235 { 236 field_1_formatFlags = shadow.setShortBoolean(field_1_formatFlags, value); 237 } 238 239 /** 240 * display a shadow for the chart 241 * @return the shadow field value. 242 */ 243 public boolean isShadow() 244 { 245 return shadow.isSet(field_1_formatFlags); 246 } 247 248 249 } // END OF CLASS 250 251 252 253 254