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