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: Print Gridlines Record<P> 62 * Description: whether to print the gridlines when you enjoy you spreadsheet on paper.<P> 63 * REFERENCE: PG 373 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)<P> 64 * @author Andrew C. Oliver (acoliver at apache dot org) 65 * @version 2.0-pre 66 */ 67 68 public class PrintGridlinesRecord 69 extends Record 70 { 71 public final static short sid = 0x2b; 72 private short field_1_print_gridlines; 73 74 public PrintGridlinesRecord() 75 { 76 } 77 78 /** 79 * Constructs a PrintGridlines record and sets its fields appropriately. 80 * 81 * @param id id must be 0x2b or an exception will be throw upon validation 82 * @param size the size of the data area of the record 83 * @param data data of the record (should not contain sid/len) 84 */ 85 86 public PrintGridlinesRecord(short id, short size, byte [] data) 87 { 88 super(id, size, data); 89 } 90 91 /** 92 * Constructs a PrintGridlines record and sets its fields appropriately. 93 * 94 * @param id id must be 0x2b or an exception will be throw upon validation 95 * @param size the size of the data area of the record 96 * @param data data of the record (should not contain sid/len) 97 * @param offset of the record data 98 */ 99 100 public PrintGridlinesRecord(short id, short size, byte [] data, 101 int offset) 102 { 103 super(id, size, data, offset); 104 } 105 106 protected void validateSid(short id) 107 { 108 if (id != sid) 109 { 110 throw new RecordFormatException("NOT A PrintGridlines RECORD"); 111 } 112 } 113 114 protected void fillFields(byte [] data, short size, int offset) 115 { 116 field_1_print_gridlines = LittleEndian.getShort(data, 0 + offset); 117 } 118 119 /** 120 * set whether or not to print the gridlines (and make your spreadsheet ugly) 121 * 122 * @param pg make spreadsheet ugly - Y/N 123 */ 124 125 public void setPrintGridlines(boolean pg) 126 { 127 if (pg == true) 128 { 129 field_1_print_gridlines = 1; 130 } 131 else 132 { 133 field_1_print_gridlines = 0; 134 } 135 } 136 137 /** 138 * get whether or not to print the gridlines (and make your spreadsheet ugly) 139 * 140 * @return make spreadsheet ugly - Y/N 141 */ 142 143 public boolean getPrintGridlines() 144 { 145 return (field_1_print_gridlines == 1); 146 } 147 148 public String toString() 149 { 150 StringBuffer buffer = new StringBuffer(); 151 152 buffer.append("[PRINTGRIDLINES]\n"); 153 buffer.append(" .printgridlines = ").append(getPrintGridlines()) 154 .append("\n"); 155 buffer.append("[/PRINTGRIDLINES]\n"); 156 return buffer.toString(); 157 } 158 159 public int serialize(int offset, byte [] data) 160 { 161 LittleEndian.putShort(data, 0 + offset, sid); 162 LittleEndian.putShort(data, 2 + offset, ( short ) 0x2); 163 LittleEndian.putShort(data, 4 + offset, field_1_print_gridlines); 164 return getRecordSize(); 165 } 166 167 public int getRecordSize() 168 { 169 return 6; 170 } 171 172 public short getSid() 173 { 174 return this.sid; 175 } 176 } 177