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 60 /** 61 * Title: Default Column Width Record<P> 62 * Description: Specifies the default width for columns that have no specific 63 * width set.<P> 64 * REFERENCE: PG 302 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)<P> 65 * @author Andrew C. Oliver (acoliver at apache dot org) 66 * @author Jason Height (jheight at chariot dot net dot au) 67 * @version 2.0-pre 68 */ 69 70 public class DefaultColWidthRecord 71 extends Record 72 { 73 public final static short sid = 0x55; 74 private short field_1_col_width; 75 76 public DefaultColWidthRecord() 77 { 78 } 79 80 /** 81 * Constructs a DefaultColumnWidth record and sets its fields appropriately. 82 * 83 * @param id id must be 0x55 or an exception will be throw upon validation 84 * @param size the size of the data area of the record 85 * @param data data of the record (should not contain sid/len) 86 */ 87 88 public DefaultColWidthRecord(short id, short size, byte [] data) 89 { 90 super(id, size, data); 91 } 92 93 /** 94 * Constructs a DefaultColumnWidth record and sets its fields appropriately. 95 * 96 * @param id id must be 0x55 or an exception will be throw upon validation 97 * @param size the size of the data area of the record 98 * @param data data of the record (should not contain sid/len) 99 * @param offset of the record's data 100 */ 101 102 public DefaultColWidthRecord(short id, short size, byte [] data, 103 int offset) 104 { 105 super(id, size, data, offset); 106 } 107 108 protected void validateSid(short id) 109 { 110 if (id != sid) 111 { 112 throw new RecordFormatException("NOT A DefaultColWidth RECORD"); 113 } 114 } 115 116 protected void fillFields(byte [] data, short size, int offset) 117 { 118 field_1_col_width = LittleEndian.getShort(data, 0 + offset); 119 } 120 121 /** 122 * set the default column width 123 * @param height defaultwidth for columns 124 */ 125 126 public void setColWidth(short height) 127 { 128 field_1_col_width = height; 129 } 130 131 /** 132 * get the default column width 133 * @return defaultwidth for columns 134 */ 135 136 public short getColWidth() 137 { 138 return field_1_col_width; 139 } 140 141 public String toString() 142 { 143 StringBuffer buffer = new StringBuffer(); 144 145 buffer.append("[DEFAULTCOLWIDTH]\n"); 146 buffer.append(" .colwidth = ") 147 .append(Integer.toHexString(getColWidth())).append("\n"); 148 buffer.append("[/DEFAULTCOLWIDTH]\n"); 149 return buffer.toString(); 150 } 151 152 public int serialize(int offset, byte [] data) 153 { 154 LittleEndian.putShort(data, 0 + offset, sid); 155 LittleEndian.putShort(data, 2 + offset, ( short ) 0x2); 156 LittleEndian.putShort(data, 4 + offset, getColWidth()); 157 return getRecordSize(); 158 } 159 160 public int getRecordSize() 161 { 162 return 6; 163 } 164 165 public short getSid() 166 { 167 return this.sid; 168 } 169 170 public Object clone() { 171 DefaultColWidthRecord rec = new DefaultColWidthRecord(); 172 rec.field_1_col_width = field_1_col_width; 173 return rec; 174 } 175 } 176