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 default data label text properties record identifies the text characteristics of the preceeding text record. 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 DefaultDataLabelTextPropertiesRecord 71 extends Record 72 { 73 public final static short sid = 0x1024; 74 private short field_1_categoryDataType; 75 public final static short CATEGORY_DATA_TYPE_SHOW_LABELS_CHARACTERISTIC = 0; 76 public final static short CATEGORY_DATA_TYPE_VALUE_AND_PERCENTAGE_CHARACTERISTIC = 1; 77 public final static short CATEGORY_DATA_TYPE_ALL_TEXT_CHARACTERISTIC = 2; 78 79 80 public DefaultDataLabelTextPropertiesRecord() 81 { 82 83 } 84 85 /** 86 * Constructs a DefaultDataLabelTextProperties record and sets its fields appropriately. 87 * 88 * @param id id must be 0x1024 or an exception 89 * will be throw upon validation 90 * @param size size the size of the data area of the record 91 * @param data data of the record (should not contain sid/len) 92 */ 93 94 public DefaultDataLabelTextPropertiesRecord(short id, short size, byte [] data) 95 { 96 super(id, size, data); 97 98 } 99 100 /** 101 * Constructs a DefaultDataLabelTextProperties record and sets its fields appropriately. 102 * 103 * @param id id must be 0x1024 or an exception 104 * will be throw upon validation 105 * @param size size the size of the data area of the record 106 * @param data data of the record (should not contain sid/len) 107 * @param offset of the record's data 108 */ 109 110 public DefaultDataLabelTextPropertiesRecord(short id, short size, byte [] data, int offset) 111 { 112 super(id, size, data, offset); 113 114 } 115 116 /** 117 * Checks the sid matches the expected side for this record 118 * 119 * @param id the expected sid. 120 */ 121 protected void validateSid(short id) 122 { 123 if (id != sid) 124 { 125 throw new RecordFormatException("Not a DefaultDataLabelTextProperties record"); 126 } 127 } 128 129 protected void fillFields(byte [] data, short size, int offset) 130 { 131 132 int pos = 0; 133 field_1_categoryDataType = LittleEndian.getShort(data, pos + 0x0 + offset); 134 135 } 136 137 public String toString() 138 { 139 StringBuffer buffer = new StringBuffer(); 140 141 buffer.append("[DEFAULTTEXT]\n"); 142 buffer.append(" .categoryDataType = ") 143 .append("0x").append(HexDump.toHex( getCategoryDataType ())) 144 .append(" (").append( getCategoryDataType() ).append(" )"); 145 buffer.append(System.getProperty("line.separator")); 146 147 buffer.append("[/DEFAULTTEXT]\n"); 148 return buffer.toString(); 149 } 150 151 public int serialize(int offset, byte[] data) 152 { 153 int pos = 0; 154 155 LittleEndian.putShort(data, 0 + offset, sid); 156 LittleEndian.putShort(data, 2 + offset, (short)(getRecordSize() - 4)); 157 158 LittleEndian.putShort(data, 4 + offset + pos, field_1_categoryDataType); 159 160 return getRecordSize(); 161 } 162 163 /** 164 * Size of record (exluding 4 byte header) 165 */ 166 public int getRecordSize() 167 { 168 return 4 + 2; 169 } 170 171 public short getSid() 172 { 173 return this.sid; 174 } 175 176 public Object clone() { 177 DefaultDataLabelTextPropertiesRecord rec = new DefaultDataLabelTextPropertiesRecord(); 178 179 rec.field_1_categoryDataType = field_1_categoryDataType; 180 return rec; 181 } 182 183 184 185 186 /** 187 * Get the category data type field for the DefaultDataLabelTextProperties record. 188 * 189 * @return One of 190 * CATEGORY_DATA_TYPE_SHOW_LABELS_CHARACTERISTIC 191 * CATEGORY_DATA_TYPE_VALUE_AND_PERCENTAGE_CHARACTERISTIC 192 * CATEGORY_DATA_TYPE_ALL_TEXT_CHARACTERISTIC 193 */ 194 public short getCategoryDataType() 195 { 196 return field_1_categoryDataType; 197 } 198 199 /** 200 * Set the category data type field for the DefaultDataLabelTextProperties record. 201 * 202 * @param field_1_categoryDataType 203 * One of 204 * CATEGORY_DATA_TYPE_SHOW_LABELS_CHARACTERISTIC 205 * CATEGORY_DATA_TYPE_VALUE_AND_PERCENTAGE_CHARACTERISTIC 206 * CATEGORY_DATA_TYPE_ALL_TEXT_CHARACTERISTIC 207 */ 208 public void setCategoryDataType(short field_1_categoryDataType) 209 { 210 this.field_1_categoryDataType = field_1_categoryDataType; 211 } 212 213 214 } // END OF CLASS 215 216 217 218 219