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 * This record refers to a category or series axis and is used to specify label/tickmark frequency. 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 CategorySeriesAxisRecord 71 extends Record 72 { 73 public final static short sid = 0x1020; 74 private short field_1_crossingPoint; 75 private short field_2_labelFrequency; 76 private short field_3_tickMarkFrequency; 77 private short field_4_options; 78 private BitField valueAxisCrossing = new BitField(0x1); 79 private BitField crossesFarRight = new BitField(0x2); 80 private BitField reversed = new BitField(0x4); 81 82 83 public CategorySeriesAxisRecord() 84 { 85 86 } 87 88 /** 89 * Constructs a CategorySeriesAxis record and sets its fields appropriately. 90 * 91 * @param id id must be 0x1020 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 CategorySeriesAxisRecord(short id, short size, byte [] data) 98 { 99 super(id, size, data); 100 } 101 102 /** 103 * Constructs a CategorySeriesAxis record and sets its fields appropriately. 104 * 105 * @param id id must be 0x1020 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 CategorySeriesAxisRecord(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 CategorySeriesAxis record"); 127 } 128 } 129 130 protected void fillFields(byte [] data, short size, int offset) 131 { 132 field_1_crossingPoint = LittleEndian.getShort(data, 0x0 + offset); 133 field_2_labelFrequency = LittleEndian.getShort(data, 0x2 + offset); 134 field_3_tickMarkFrequency = LittleEndian.getShort(data, 0x4 + offset); 135 field_4_options = LittleEndian.getShort(data, 0x6 + offset); 136 137 } 138 139 public String toString() 140 { 141 StringBuffer buffer = new StringBuffer(); 142 143 buffer.append("[CategorySeriesAxis]\n"); 144 145 buffer.append(" .crossingPoint = ") 146 .append("0x") 147 .append(HexDump.toHex((short)getCrossingPoint())) 148 .append(" (").append(getCrossingPoint()).append(" )\n"); 149 150 buffer.append(" .labelFrequency = ") 151 .append("0x") 152 .append(HexDump.toHex((short)getLabelFrequency())) 153 .append(" (").append(getLabelFrequency()).append(" )\n"); 154 155 buffer.append(" .tickMarkFrequency = ") 156 .append("0x") 157 .append(HexDump.toHex((short)getTickMarkFrequency())) 158 .append(" (").append(getTickMarkFrequency()).append(" )\n"); 159 160 buffer.append(" .options = ") 161 .append("0x") 162 .append(HexDump.toHex((short)getOptions())) 163 .append(" (").append(getOptions()).append(" )\n"); 164 buffer.append(" .valueAxisCrossing = ").append(isValueAxisCrossing ()).append('\n'); 165 buffer.append(" .crossesFarRight = ").append(isCrossesFarRight ()).append('\n'); 166 buffer.append(" .reversed = ").append(isReversed ()).append('\n'); 167 168 buffer.append("[/CategorySeriesAxis]\n"); 169 return buffer.toString(); 170 } 171 172 public int serialize(int offset, byte[] data) 173 { 174 LittleEndian.putShort(data, 0 + offset, sid); 175 LittleEndian.putShort(data, 2 + offset, (short)(getRecordSize() - 4)); 176 177 LittleEndian.putShort(data, 4 + offset, field_1_crossingPoint); 178 LittleEndian.putShort(data, 6 + offset, field_2_labelFrequency); 179 LittleEndian.putShort(data, 8 + offset, field_3_tickMarkFrequency); 180 LittleEndian.putShort(data, 10 + offset, field_4_options); 181 182 return getRecordSize(); 183 } 184 185 /** 186 * Size of record (exluding 4 byte header) 187 */ 188 public int getRecordSize() 189 { 190 return 4 + 2 + 2 + 2 + 2; 191 } 192 193 public short getSid() 194 { 195 return this.sid; 196 } 197 198 199 /** 200 * Get the crossing point field for the CategorySeriesAxis record. 201 */ 202 public short getCrossingPoint() 203 { 204 return field_1_crossingPoint; 205 } 206 207 /** 208 * Set the crossing point field for the CategorySeriesAxis record. 209 */ 210 public void setCrossingPoint(short field_1_crossingPoint) 211 { 212 this.field_1_crossingPoint = field_1_crossingPoint; 213 } 214 215 /** 216 * Get the label frequency field for the CategorySeriesAxis record. 217 */ 218 public short getLabelFrequency() 219 { 220 return field_2_labelFrequency; 221 } 222 223 /** 224 * Set the label frequency field for the CategorySeriesAxis record. 225 */ 226 public void setLabelFrequency(short field_2_labelFrequency) 227 { 228 this.field_2_labelFrequency = field_2_labelFrequency; 229 } 230 231 /** 232 * Get the tick mark frequency field for the CategorySeriesAxis record. 233 */ 234 public short getTickMarkFrequency() 235 { 236 return field_3_tickMarkFrequency; 237 } 238 239 /** 240 * Set the tick mark frequency field for the CategorySeriesAxis record. 241 */ 242 public void setTickMarkFrequency(short field_3_tickMarkFrequency) 243 { 244 this.field_3_tickMarkFrequency = field_3_tickMarkFrequency; 245 } 246 247 /** 248 * Get the options field for the CategorySeriesAxis record. 249 */ 250 public short getOptions() 251 { 252 return field_4_options; 253 } 254 255 /** 256 * Set the options field for the CategorySeriesAxis record. 257 */ 258 public void setOptions(short field_4_options) 259 { 260 this.field_4_options = field_4_options; 261 } 262 263 /** 264 * Sets the value axis crossing field value. 265 * set true to indicate axis crosses between categories and false to cross axis midway 266 */ 267 public void setValueAxisCrossing(boolean value) 268 { 269 field_4_options = valueAxisCrossing.setShortBoolean(field_4_options, value); 270 } 271 272 /** 273 * set true to indicate axis crosses between categories and false to cross axis midway 274 * @return the value axis crossing field value. 275 */ 276 public boolean isValueAxisCrossing() 277 { 278 return valueAxisCrossing.isSet(field_4_options); 279 } 280 281 /** 282 * Sets the crosses far right field value. 283 * axis crosses at the far right 284 */ 285 public void setCrossesFarRight(boolean value) 286 { 287 field_4_options = crossesFarRight.setShortBoolean(field_4_options, value); 288 } 289 290 /** 291 * axis crosses at the far right 292 * @return the crosses far right field value. 293 */ 294 public boolean isCrossesFarRight() 295 { 296 return crossesFarRight.isSet(field_4_options); 297 } 298 299 /** 300 * Sets the reversed field value. 301 * categories are displayed in reverse order 302 */ 303 public void setReversed(boolean value) 304 { 305 field_4_options = reversed.setShortBoolean(field_4_options, value); 306 } 307 308 /** 309 * categories are displayed in reverse order 310 * @return the reversed field value. 311 */ 312 public boolean isReversed() 313 { 314 return reversed.isSet(field_4_options); 315 } 316 317 318 } // END OF CLASS 319 320 321 322 323