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 series label record defines the type of label associated with the data format record. 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 SeriesLabelsRecord 74 extends Record 75 { 76 public final static short sid = 0x100c; 77 private short field_1_formatFlags; 78 private BitField showActual = new BitField(0x1); 79 private BitField showPercent = new BitField(0x2); 80 private BitField labelAsPercentage = new BitField(0x4); 81 private BitField smoothedLine = new BitField(0x8); 82 private BitField showLabel = new BitField(0x10); 83 private BitField showBubbleSizes = new BitField(0x20); 84 85 86 public SeriesLabelsRecord() 87 { 88 89 } 90 91 /** 92 * Constructs a SeriesLabels record and sets its fields appropriately. 93 * 94 * @param id id must be 0x100c or an exception 95 * will be throw upon validation 96 * @param size size the size of the data area of the record 97 * @param data data of the record (should not contain sid/len) 98 */ 99 100 public SeriesLabelsRecord(short id, short size, byte [] data) 101 { 102 super(id, size, data); 103 } 104 105 /** 106 * Constructs a SeriesLabels record and sets its fields appropriately. 107 * 108 * @param id id must be 0x100c or an exception 109 * will be throw upon validation 110 * @param size size the size of the data area of the record 111 * @param data data of the record (should not contain sid/len) 112 * @param offset of the record's data 113 */ 114 115 public SeriesLabelsRecord(short id, short size, byte [] data, int offset) 116 { 117 super(id, size, data, offset); 118 } 119 120 /** 121 * Checks the sid matches the expected side for this record 122 * 123 * @param id the expected sid. 124 */ 125 protected void validateSid(short id) 126 { 127 if (id != sid) 128 { 129 throw new RecordFormatException("Not a SeriesLabels record"); 130 } 131 } 132 133 protected void fillFields(byte [] data, short size, int offset) 134 { 135 field_1_formatFlags = LittleEndian.getShort(data, 0x0 + offset); 136 137 } 138 139 public String toString() 140 { 141 StringBuffer buffer = new StringBuffer(); 142 143 buffer.append("[SeriesLabels]\n"); 144 145 buffer.append(" .formatFlags = ") 146 .append("0x") 147 .append(HexDump.toHex((short)getFormatFlags())) 148 .append(" (").append(getFormatFlags()).append(" )\n"); 149 buffer.append(" .showActual = ").append(isShowActual ()).append('\n'); 150 buffer.append(" .showPercent = ").append(isShowPercent ()).append('\n'); 151 buffer.append(" .labelAsPercentage = ").append(isLabelAsPercentage ()).append('\n'); 152 buffer.append(" .smoothedLine = ").append(isSmoothedLine ()).append('\n'); 153 buffer.append(" .showLabel = ").append(isShowLabel ()).append('\n'); 154 buffer.append(" .showBubbleSizes = ").append(isShowBubbleSizes ()).append('\n'); 155 156 buffer.append("[/SeriesLabels]\n"); 157 return buffer.toString(); 158 } 159 160 public int serialize(int offset, byte[] data) 161 { 162 LittleEndian.putShort(data, 0 + offset, sid); 163 LittleEndian.putShort(data, 2 + offset, (short)(getRecordSize() - 4)); 164 165 LittleEndian.putShort(data, 4 + offset, field_1_formatFlags); 166 167 return getRecordSize(); 168 } 169 170 /** 171 * Size of record (exluding 4 byte header) 172 */ 173 public int getRecordSize() 174 { 175 return 4 + 2; 176 } 177 178 public short getSid() 179 { 180 return this.sid; 181 } 182 183 184 /** 185 * Get the format flags field for the SeriesLabels record. 186 */ 187 public short getFormatFlags() 188 { 189 return field_1_formatFlags; 190 } 191 192 /** 193 * Set the format flags field for the SeriesLabels record. 194 */ 195 public void setFormatFlags(short field_1_formatFlags) 196 { 197 this.field_1_formatFlags = field_1_formatFlags; 198 } 199 200 /** 201 * Sets the show actual field value. 202 * show actual value of the data point 203 */ 204 public void setShowActual(boolean value) 205 { 206 field_1_formatFlags = showActual.setShortBoolean(field_1_formatFlags, value); 207 } 208 209 /** 210 * show actual value of the data point 211 * @return the show actual field value. 212 */ 213 public boolean isShowActual() 214 { 215 return showActual.isSet(field_1_formatFlags); 216 } 217 218 /** 219 * Sets the show percent field value. 220 * show value as percentage of total (pie charts only) 221 */ 222 public void setShowPercent(boolean value) 223 { 224 field_1_formatFlags = showPercent.setShortBoolean(field_1_formatFlags, value); 225 } 226 227 /** 228 * show value as percentage of total (pie charts only) 229 * @return the show percent field value. 230 */ 231 public boolean isShowPercent() 232 { 233 return showPercent.isSet(field_1_formatFlags); 234 } 235 236 /** 237 * Sets the label as percentage field value. 238 * show category label/value as percentage (pie charts only) 239 */ 240 public void setLabelAsPercentage(boolean value) 241 { 242 field_1_formatFlags = labelAsPercentage.setShortBoolean(field_1_formatFlags, value); 243 } 244 245 /** 246 * show category label/value as percentage (pie charts only) 247 * @return the label as percentage field value. 248 */ 249 public boolean isLabelAsPercentage() 250 { 251 return labelAsPercentage.isSet(field_1_formatFlags); 252 } 253 254 /** 255 * Sets the smoothed line field value. 256 * show smooth line 257 */ 258 public void setSmoothedLine(boolean value) 259 { 260 field_1_formatFlags = smoothedLine.setShortBoolean(field_1_formatFlags, value); 261 } 262 263 /** 264 * show smooth line 265 * @return the smoothed line field value. 266 */ 267 public boolean isSmoothedLine() 268 { 269 return smoothedLine.isSet(field_1_formatFlags); 270 } 271 272 /** 273 * Sets the show label field value. 274 * display category label 275 */ 276 public void setShowLabel(boolean value) 277 { 278 field_1_formatFlags = showLabel.setShortBoolean(field_1_formatFlags, value); 279 } 280 281 /** 282 * display category label 283 * @return the show label field value. 284 */ 285 public boolean isShowLabel() 286 { 287 return showLabel.isSet(field_1_formatFlags); 288 } 289 290 /** 291 * Sets the show bubble sizes field value. 292 * ?? 293 */ 294 public void setShowBubbleSizes(boolean value) 295 { 296 field_1_formatFlags = showBubbleSizes.setShortBoolean(field_1_formatFlags, value); 297 } 298 299 /** 300 * ?? 301 * @return the show bubble sizes field value. 302 */ 303 public boolean isShowBubbleSizes() 304 { 305 return showBubbleSizes.isSet(field_1_formatFlags); 306 } 307 308 309 } // END OF CLASS 310 311 312 313 314