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 default data label text properties record identifies the text characteristics of the preceeding text 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 DefaultDataLabelTextPropertiesRecord 74 extends Record 75 { 76 public final static short sid = 0x1024; 77 private short field_1_categoryDataType; 78 public final static short CATEGORY_DATA_TYPE_SHOW_LABELS_CHARACTERISTIC = 0; 79 public final static short CATEGORY_DATA_TYPE_VALUE_AND_PERCENTAGE_CHARACTERISTIC = 1; 80 public final static short CATEGORY_DATA_TYPE_ALL_TEXT_CHARACTERISTIC = 2; 81 82 83 public DefaultDataLabelTextPropertiesRecord() 84 { 85 86 } 87 88 /** 89 * Constructs a DefaultDataLabelTextProperties record and sets its fields appropriately. 90 * 91 * @param id id must be 0x1024 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 DefaultDataLabelTextPropertiesRecord(short id, short size, byte [] data) 98 { 99 super(id, size, data); 100 } 101 102 /** 103 * Constructs a DefaultDataLabelTextProperties record and sets its fields appropriately. 104 * 105 * @param id id must be 0x1024 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 DefaultDataLabelTextPropertiesRecord(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 DefaultDataLabelTextProperties record"); 127 } 128 } 129 130 protected void fillFields(byte [] data, short size, int offset) 131 { 132 field_1_categoryDataType = LittleEndian.getShort(data, 0x0 + offset); 133 134 } 135 136 public String toString() 137 { 138 StringBuffer buffer = new StringBuffer(); 139 140 buffer.append("[DefaultDataLabelTextProperties]\n"); 141 142 buffer.append(" .categoryDataType = ") 143 .append("0x") 144 .append(HexDump.toHex((short)getCategoryDataType())) 145 .append(" (").append(getCategoryDataType()).append(" )\n"); 146 147 buffer.append("[/DefaultDataLabelTextProperties]\n"); 148 return buffer.toString(); 149 } 150 151 public int serialize(int offset, byte[] data) 152 { 153 LittleEndian.putShort(data, 0 + offset, sid); 154 LittleEndian.putShort(data, 2 + offset, (short)(getRecordSize() - 4)); 155 156 LittleEndian.putShort(data, 4 + offset, field_1_categoryDataType); 157 158 return getRecordSize(); 159 } 160 161 /** 162 * Size of record (exluding 4 byte header) 163 */ 164 public int getRecordSize() 165 { 166 return 4 + 2; 167 } 168 169 public short getSid() 170 { 171 return this.sid; 172 } 173 174 175 /** 176 * Get the category data type field for the DefaultDataLabelTextProperties record. 177 * 178 * @return One of 179 * CATEGORY_DATA_TYPE_SHOW_LABELS_CHARACTERISTIC 180 * CATEGORY_DATA_TYPE_VALUE_AND_PERCENTAGE_CHARACTERISTIC 181 * CATEGORY_DATA_TYPE_ALL_TEXT_CHARACTERISTIC 182 */ 183 public short getCategoryDataType() 184 { 185 return field_1_categoryDataType; 186 } 187 188 /** 189 * Set the category data type field for the DefaultDataLabelTextProperties record. 190 * 191 * @param field_1_categoryDataType 192 * One of 193 * CATEGORY_DATA_TYPE_SHOW_LABELS_CHARACTERISTIC 194 * CATEGORY_DATA_TYPE_VALUE_AND_PERCENTAGE_CHARACTERISTIC 195 * CATEGORY_DATA_TYPE_ALL_TEXT_CHARACTERISTIC 196 */ 197 public void setCategoryDataType(short field_1_categoryDataType) 198 { 199 this.field_1_categoryDataType = field_1_categoryDataType; 200 } 201 202 203 } // END OF CLASS 204 205 206 207 208