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 bar record is used to define a bar 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 BarRecord 71 extends Record 72 { 73 public final static short sid = 0x1017; 74 private short field_1_barSpace; 75 private short field_2_categorySpace; 76 private short field_3_formatFlags; 77 private BitField horizontal = new BitField(0x1); 78 private BitField stacked = new BitField(0x2); 79 private BitField displayAsPercentage = new BitField(0x4); 80 private BitField shadow = new BitField(0x8); 81 82 83 public BarRecord() 84 { 85 field_2_categorySpace = 50; 86 87 } 88 89 /** 90 * Constructs a Bar record and sets its fields appropriately. 91 * 92 * @param id id must be 0x1017 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 BarRecord(short id, short size, byte [] data) 99 { 100 super(id, size, data); 101 } 102 103 /** 104 * Constructs a Bar record and sets its fields appropriately. 105 * 106 * @param id id must be 0x1017 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 BarRecord(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 Bar record"); 128 } 129 } 130 131 protected void fillFields(byte [] data, short size, int offset) 132 { 133 field_1_barSpace = LittleEndian.getShort(data, 0x0 + offset); 134 field_2_categorySpace = LittleEndian.getShort(data, 0x2 + offset); 135 field_3_formatFlags = LittleEndian.getShort(data, 0x4 + offset); 136 137 } 138 139 public String toString() 140 { 141 StringBuffer buffer = new StringBuffer(); 142 143 buffer.append("[Bar]\n"); 144 145 buffer.append(" .barSpace = ") 146 .append("0x") 147 .append(HexDump.toHex((short)getBarSpace())) 148 .append(" (").append(getBarSpace()).append(" )\n"); 149 150 buffer.append(" .categorySpace = ") 151 .append("0x") 152 .append(HexDump.toHex((short)getCategorySpace())) 153 .append(" (").append(getCategorySpace()).append(" )\n"); 154 155 buffer.append(" .formatFlags = ") 156 .append("0x") 157 .append(HexDump.toHex((short)getFormatFlags())) 158 .append(" (").append(getFormatFlags()).append(" )\n"); 159 buffer.append(" .horizontal = ").append(isHorizontal ()).append('\n'); 160 buffer.append(" .stacked = ").append(isStacked ()).append('\n'); 161 buffer.append(" .displayAsPercentage = ").append(isDisplayAsPercentage ()).append('\n'); 162 buffer.append(" .shadow = ").append(isShadow ()).append('\n'); 163 164 buffer.append("[/Bar]\n"); 165 return buffer.toString(); 166 } 167 168 public int serialize(int offset, byte[] data) 169 { 170 LittleEndian.putShort(data, 0 + offset, sid); 171 LittleEndian.putShort(data, 2 + offset, (short)(getRecordSize() - 4)); 172 173 LittleEndian.putShort(data, 4 + offset, field_1_barSpace); 174 LittleEndian.putShort(data, 6 + offset, field_2_categorySpace); 175 LittleEndian.putShort(data, 8 + offset, field_3_formatFlags); 176 177 return getRecordSize(); 178 } 179 180 /** 181 * Size of record (exluding 4 byte header) 182 */ 183 public int getRecordSize() 184 { 185 return 4 + 2 + 2 + 2; 186 } 187 188 public short getSid() 189 { 190 return this.sid; 191 } 192 193 public Object clone() { 194 BarRecord rec = new BarRecord(); 195 196 rec.field_1_barSpace = field_1_barSpace; 197 rec.field_2_categorySpace = field_2_categorySpace; 198 rec.field_3_formatFlags = field_3_formatFlags; 199 200 return rec; 201 } 202 203 204 /** 205 * Get the bar space field for the Bar record. 206 */ 207 public short getBarSpace() 208 { 209 return field_1_barSpace; 210 } 211 212 /** 213 * Set the bar space field for the Bar record. 214 */ 215 public void setBarSpace(short field_1_barSpace) 216 { 217 this.field_1_barSpace = field_1_barSpace; 218 } 219 220 /** 221 * Get the category space field for the Bar record. 222 */ 223 public short getCategorySpace() 224 { 225 return field_2_categorySpace; 226 } 227 228 /** 229 * Set the category space field for the Bar record. 230 */ 231 public void setCategorySpace(short field_2_categorySpace) 232 { 233 this.field_2_categorySpace = field_2_categorySpace; 234 } 235 236 /** 237 * Get the format flags field for the Bar record. 238 */ 239 public short getFormatFlags() 240 { 241 return field_3_formatFlags; 242 } 243 244 /** 245 * Set the format flags field for the Bar record. 246 */ 247 public void setFormatFlags(short field_3_formatFlags) 248 { 249 this.field_3_formatFlags = field_3_formatFlags; 250 } 251 252 /** 253 * Sets the horizontal field value. 254 * true to display horizontal bar charts, false for vertical 255 */ 256 public void setHorizontal(boolean value) 257 { 258 field_3_formatFlags = horizontal.setShortBoolean(field_3_formatFlags, value); 259 } 260 261 /** 262 * true to display horizontal bar charts, false for vertical 263 * @return the horizontal field value. 264 */ 265 public boolean isHorizontal() 266 { 267 return horizontal.isSet(field_3_formatFlags); 268 } 269 270 /** 271 * Sets the stacked field value. 272 * stack displayed values 273 */ 274 public void setStacked(boolean value) 275 { 276 field_3_formatFlags = stacked.setShortBoolean(field_3_formatFlags, value); 277 } 278 279 /** 280 * stack displayed values 281 * @return the stacked field value. 282 */ 283 public boolean isStacked() 284 { 285 return stacked.isSet(field_3_formatFlags); 286 } 287 288 /** 289 * Sets the display as percentage field value. 290 * display chart values as a percentage 291 */ 292 public void setDisplayAsPercentage(boolean value) 293 { 294 field_3_formatFlags = displayAsPercentage.setShortBoolean(field_3_formatFlags, value); 295 } 296 297 /** 298 * display chart values as a percentage 299 * @return the display as percentage field value. 300 */ 301 public boolean isDisplayAsPercentage() 302 { 303 return displayAsPercentage.isSet(field_3_formatFlags); 304 } 305 306 /** 307 * Sets the shadow field value. 308 * display a shadow for the chart 309 */ 310 public void setShadow(boolean value) 311 { 312 field_3_formatFlags = shadow.setShortBoolean(field_3_formatFlags, value); 313 } 314 315 /** 316 * display a shadow for the chart 317 * @return the shadow field value. 318 */ 319 public boolean isShadow() 320 { 321 return shadow.isSet(field_3_formatFlags); 322 } 323 324 325 } // END OF CLASS 326 327 328 329 330