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: Window Protect Record<P> 62 * Description: flags whether workbook windows are protected<P> 63 * REFERENCE: PG 424 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 WindowProtectRecord 69 extends Record 70 { 71 public final static short sid = 0x19; 72 private short field_1_protect; 73 74 public WindowProtectRecord() 75 { 76 } 77 78 /** 79 * Constructs a WindowProtect record and sets its fields appropriately. 80 * 81 * @param id id must be 0x19 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 WindowProtectRecord(short id, short size, byte [] data) 87 { 88 super(id, size, data); 89 } 90 91 /** 92 * Constructs a WindowProtect record and sets its fields appropriately. 93 * 94 * @param id id must be 0x19 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's data 98 */ 99 100 public WindowProtectRecord(short id, short size, byte [] data, int offset) 101 { 102 super(id, size, data, offset); 103 } 104 105 protected void validateSid(short id) 106 { 107 if (id != sid) 108 { 109 throw new RecordFormatException("NOT A WINDOWPROTECT RECORD"); 110 } 111 } 112 113 protected void fillFields(byte [] data, short size, int offset) 114 { 115 field_1_protect = LittleEndian.getShort(data, 0 + offset); 116 } 117 118 /** 119 * set whether this window should be protected or not 120 * @param protect or not 121 */ 122 123 public void setProtect(boolean protect) 124 { 125 if (protect == true) 126 { 127 field_1_protect = 1; 128 } 129 else 130 { 131 field_1_protect = 0; 132 } 133 } 134 135 /** 136 * is this window protected or not 137 * 138 * @return protected or not 139 */ 140 141 public boolean getProtect() 142 { 143 return (field_1_protect == 1); 144 } 145 146 public String toString() 147 { 148 StringBuffer buffer = new StringBuffer(); 149 150 buffer.append("[WINDOWPROTECT]\n"); 151 buffer.append(" .protect = ").append(getProtect()) 152 .append("\n"); 153 buffer.append("[/WINDOWPROTECT]\n"); 154 return buffer.toString(); 155 } 156 157 public int serialize(int offset, byte [] data) 158 { 159 LittleEndian.putShort(data, 0 + offset, sid); 160 LittleEndian.putShort(data, 2 + offset, 161 (( short ) 0x02)); // 2 bytes (6 total) 162 LittleEndian.putShort(data, 4 + offset, field_1_protect); 163 return getRecordSize(); 164 } 165 166 public int getRecordSize() 167 { 168 return 6; 169 } 170 171 public short getSid() 172 { 173 return this.sid; 174 } 175 } 176