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 package org.apache.poi.hssf.record; 57 58 import org.apache.poi.util.LittleEndian; 59 import org.apache.poi.util.StringUtil; 60 61 /** 62 * Title: Footer Record <P> 63 * Description: Specifies the footer for a sheet<P> 64 * REFERENCE: PG 317 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)<P> 65 * @author Andrew C. Oliver (acoliver at apache dot org) 66 * @author Shawn Laubach (slaubach at apache dot org) Modified 3/14/02 67 * @author Jason Height (jheight at chariot dot net dot au) 68 * @version 2.0-pre 69 */ 70 71 public class FooterRecord 72 extends Record 73 { 74 public final static short sid = 0x15; 75 private byte field_1_footer_len; 76 private String field_2_footer; 77 78 public FooterRecord() 79 { 80 } 81 82 /** 83 * Constructs a FooterRecord record and sets its fields appropriately. 84 * 85 * @param id id must be 0x15 or an exception will be throw upon validation 86 * @param size the size of the data area of the record 87 * @param data data of the record (should not contain sid/len) 88 */ 89 90 public FooterRecord(short id, short size, byte [] data) 91 { 92 super(id, size, data); 93 } 94 95 /** 96 * Constructs a FooterRecord record and sets its fields appropriately. 97 * 98 * @param id id must be 0x15 or an exception will be throw upon validation 99 * @param size the size of the data area of the record 100 * @param data data of the record (should not contain sid/len) 101 * @param offset of the record's data 102 */ 103 104 public FooterRecord(short id, short size, byte [] data, int offset) 105 { 106 super(id, size, data, offset); 107 } 108 109 protected void validateSid(short id) 110 { 111 if (id != sid) 112 { 113 throw new RecordFormatException("NOT A FooterRECORD"); 114 } 115 } 116 117 protected void fillFields(byte [] data, short size, int offset) 118 { 119 if (size > 0) 120 { 121 field_1_footer_len = data[ 0 + offset ]; 122 field_2_footer = new String(data, 3 + offset, // [Shawn] Changed 1 to 3 for offset of string 123 LittleEndian.ubyteToInt( field_1_footer_len) ); 124 } 125 } 126 127 /** 128 * set the length of the footer string 129 * 130 * @param len length of the footer string 131 * @see #setFooter(String) 132 */ 133 134 public void setFooterLength(byte len) 135 { 136 field_1_footer_len = len; 137 } 138 139 /** 140 * set the footer string 141 * 142 * @param footer string to display 143 * @see #setFooterLength(byte) 144 */ 145 146 public void setFooter(String footer) 147 { 148 field_2_footer = footer; 149 } 150 151 /** 152 * get the length of the footer string 153 * 154 * @return length of the footer string 155 * @see #getFooter() 156 */ 157 158 public short getFooterLength() 159 { 160 return (short)(0xFF & field_1_footer_len); // [Shawn] Fixed needing unsigned byte 161 } 162 163 /** 164 * get the footer string 165 * 166 * @return footer string to display 167 * @see #getFooterLength() 168 */ 169 170 public String getFooter() 171 { 172 return field_2_footer; 173 } 174 175 public String toString() 176 { 177 StringBuffer buffer = new StringBuffer(); 178 179 buffer.append("[FOOTER]\n"); 180 buffer.append(" .footerlen = ") 181 .append(Integer.toHexString(getFooterLength())).append("\n"); 182 buffer.append(" .footer = ").append(getFooter()) 183 .append("\n"); 184 buffer.append("[/FOOTER]\n"); 185 return buffer.toString(); 186 } 187 188 public int serialize(int offset, byte [] data) 189 { 190 int len = 4; 191 192 if (getFooterLength() > 0) 193 { 194 len+=3; // [Shawn] Fixed for two null bytes in the length 195 } 196 LittleEndian.putShort(data, 0 + offset, sid); 197 LittleEndian.putShort(data, 2 + offset, 198 ( short ) ((len - 4) + getFooterLength())); 199 if (getFooterLength() > 0) 200 { 201 data[ 4 + offset ] = (byte)getFooterLength(); 202 StringUtil.putCompressedUnicode(getFooter(), data, 7 + offset); // [Shawn] Place the string in the correct offset 203 } 204 return getRecordSize(); 205 } 206 207 public int getRecordSize() 208 { 209 int retval = 4; 210 211 if (getFooterLength() > 0) 212 { 213 retval+=3; // [Shawn] Fixed for two null bytes in the length 214 } 215 return retval + getFooterLength(); 216 } 217 218 public short getSid() 219 { 220 return this.sid; 221 } 222 223 public Object clone() { 224 FooterRecord rec = new FooterRecord(); 225 rec.field_1_footer_len = field_1_footer_len; 226 rec.field_2_footer = field_2_footer; 227 return rec; 228 } 229 } 230