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 axis line format record defines the axis type details. 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 AxisLineFormatRecord 71 extends Record 72 { 73 public final static short sid = 0x1021; 74 private short field_1_axisType; 75 public final static short AXIS_TYPE_AXIS_LINE = 0; 76 public final static short AXIS_TYPE_MAJOR_GRID_LINE = 1; 77 public final static short AXIS_TYPE_MINOR_GRID_LINE = 2; 78 public final static short AXIS_TYPE_WALLS_OR_FLOOR = 3; 79 80 81 public AxisLineFormatRecord() 82 { 83 84 } 85 86 /** 87 * Constructs a AxisLineFormat record and sets its fields appropriately. 88 * 89 * @param id id must be 0x1021 or an exception 90 * will be throw upon validation 91 * @param size size the size of the data area of the record 92 * @param data data of the record (should not contain sid/len) 93 */ 94 95 public AxisLineFormatRecord(short id, short size, byte [] data) 96 { 97 super(id, size, data); 98 99 } 100 101 /** 102 * Constructs a AxisLineFormat record and sets its fields appropriately. 103 * 104 * @param id id must be 0x1021 or an exception 105 * will be throw upon validation 106 * @param size size the size of the data area of the record 107 * @param data data of the record (should not contain sid/len) 108 * @param offset of the record's data 109 */ 110 111 public AxisLineFormatRecord(short id, short size, byte [] data, int offset) 112 { 113 super(id, size, data, offset); 114 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 AxisLineFormat record"); 127 } 128 } 129 130 protected void fillFields(byte [] data, short size, int offset) 131 { 132 133 int pos = 0; 134 field_1_axisType = LittleEndian.getShort(data, pos + 0x0 + offset); 135 136 } 137 138 public String toString() 139 { 140 StringBuffer buffer = new StringBuffer(); 141 142 buffer.append("[AXISLINEFORMAT]\n"); 143 buffer.append(" .axisType = ") 144 .append("0x").append(HexDump.toHex( getAxisType ())) 145 .append(" (").append( getAxisType() ).append(" )"); 146 buffer.append(System.getProperty("line.separator")); 147 148 buffer.append("[/AXISLINEFORMAT]\n"); 149 return buffer.toString(); 150 } 151 152 public int serialize(int offset, byte[] data) 153 { 154 int pos = 0; 155 156 LittleEndian.putShort(data, 0 + offset, sid); 157 LittleEndian.putShort(data, 2 + offset, (short)(getRecordSize() - 4)); 158 159 LittleEndian.putShort(data, 4 + offset + pos, field_1_axisType); 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 public Object clone() { 178 AxisLineFormatRecord rec = new AxisLineFormatRecord(); 179 180 rec.field_1_axisType = field_1_axisType; 181 return rec; 182 } 183 184 185 186 187 /** 188 * Get the axis type field for the AxisLineFormat record. 189 * 190 * @return One of 191 * AXIS_TYPE_AXIS_LINE 192 * AXIS_TYPE_MAJOR_GRID_LINE 193 * AXIS_TYPE_MINOR_GRID_LINE 194 * AXIS_TYPE_WALLS_OR_FLOOR 195 */ 196 public short getAxisType() 197 { 198 return field_1_axisType; 199 } 200 201 /** 202 * Set the axis type field for the AxisLineFormat record. 203 * 204 * @param field_1_axisType 205 * One of 206 * AXIS_TYPE_AXIS_LINE 207 * AXIS_TYPE_MAJOR_GRID_LINE 208 * AXIS_TYPE_MINOR_GRID_LINE 209 * AXIS_TYPE_WALLS_OR_FLOOR 210 */ 211 public void setAxisType(short field_1_axisType) 212 { 213 this.field_1_axisType = field_1_axisType; 214 } 215 216 217 } // END OF CLASS 218 219 220 221 222