2002-01-30 21:22:28 -05:00
|
|
|
/* ====================================================================
|
2006-12-22 14:18:16 -05:00
|
|
|
Licensed to the Apache Software Foundation (ASF) under one or more
|
|
|
|
contributor license agreements. See the NOTICE file distributed with
|
|
|
|
this work for additional information regarding copyright ownership.
|
|
|
|
The ASF licenses this file to You under the Apache License, Version 2.0
|
|
|
|
(the "License"); you may not use this file except in compliance with
|
|
|
|
the License. You may obtain a copy of the License at
|
2004-04-09 09:05:39 -04:00
|
|
|
|
|
|
|
http://www.apache.org/licenses/LICENSE-2.0
|
|
|
|
|
|
|
|
Unless required by applicable law or agreed to in writing, software
|
|
|
|
distributed under the License is distributed on an "AS IS" BASIS,
|
|
|
|
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
|
|
See the License for the specific language governing permissions and
|
|
|
|
limitations under the License.
|
|
|
|
==================================================================== */
|
2002-01-30 21:22:28 -05:00
|
|
|
|
|
|
|
package org.apache.poi.hssf.record;
|
|
|
|
|
2008-11-19 14:09:05 -05:00
|
|
|
import org.apache.poi.util.BitField;
|
|
|
|
import org.apache.poi.util.BitFieldFactory;
|
|
|
|
import org.apache.poi.util.HexDump;
|
2008-11-18 13:49:19 -05:00
|
|
|
import org.apache.poi.util.LittleEndianOutput;
|
2002-01-30 21:22:28 -05:00
|
|
|
|
|
|
|
/**
|
2016-06-13 19:08:13 -04:00
|
|
|
* Title: Protect Record (0x0012)<p>
|
|
|
|
* Description: defines whether a sheet or workbook is protected (HSSF DOES NOT SUPPORT ENCRYPTION)<p>
|
2007-07-02 04:10:28 -04:00
|
|
|
* HSSF now supports the simple "protected" sheets (where they are not encrypted and open office et al
|
|
|
|
* ignore the password record entirely).
|
2016-06-13 19:08:13 -04:00
|
|
|
* REFERENCE: PG 373 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
|
2002-01-30 21:22:28 -05:00
|
|
|
*/
|
2008-11-19 14:09:05 -05:00
|
|
|
public final class ProtectRecord extends StandardRecord {
|
|
|
|
public final static short sid = 0x0012;
|
|
|
|
|
|
|
|
private static final BitField protectFlag = BitFieldFactory.getInstance(0x0001);
|
|
|
|
|
|
|
|
private int _options;
|
2002-01-30 21:22:28 -05:00
|
|
|
|
2008-11-19 14:09:05 -05:00
|
|
|
private ProtectRecord(int options) {
|
|
|
|
_options = options;
|
|
|
|
}
|
2002-01-30 21:22:28 -05:00
|
|
|
|
2008-11-19 14:09:05 -05:00
|
|
|
public ProtectRecord(boolean isProtected) {
|
|
|
|
this(0);
|
|
|
|
setProtect(isProtected);
|
2002-01-30 21:22:28 -05:00
|
|
|
}
|
|
|
|
|
2008-11-19 14:09:05 -05:00
|
|
|
public ProtectRecord(RecordInputStream in) {
|
|
|
|
this(in.readShort());
|
2002-01-30 21:22:28 -05:00
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* set whether the sheet is protected or not
|
2002-02-09 23:32:07 -05:00
|
|
|
* @param protect whether to protect the sheet or not
|
2002-01-30 21:22:28 -05:00
|
|
|
*/
|
2008-11-19 14:09:05 -05:00
|
|
|
public void setProtect(boolean protect) {
|
|
|
|
_options = protectFlag.setBoolean(_options, protect);
|
2002-01-30 21:22:28 -05:00
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* get whether the sheet is protected or not
|
|
|
|
* @return whether to protect the sheet or not
|
|
|
|
*/
|
2008-11-19 14:09:05 -05:00
|
|
|
public boolean getProtect() {
|
|
|
|
return protectFlag.isSet(_options);
|
2002-01-30 21:22:28 -05:00
|
|
|
}
|
|
|
|
|
2008-11-19 14:09:05 -05:00
|
|
|
public String toString() {
|
2002-01-30 21:22:28 -05:00
|
|
|
StringBuffer buffer = new StringBuffer();
|
|
|
|
|
|
|
|
buffer.append("[PROTECT]\n");
|
2008-11-19 14:09:05 -05:00
|
|
|
buffer.append(" .options = ").append(HexDump.shortToHex(_options)).append("\n");
|
2002-01-30 21:22:28 -05:00
|
|
|
buffer.append("[/PROTECT]\n");
|
|
|
|
return buffer.toString();
|
|
|
|
}
|
|
|
|
|
2008-11-18 13:49:19 -05:00
|
|
|
public void serialize(LittleEndianOutput out) {
|
2008-11-19 14:09:05 -05:00
|
|
|
out.writeShort(_options);
|
2002-01-30 21:22:28 -05:00
|
|
|
}
|
|
|
|
|
2008-10-30 21:02:55 -04:00
|
|
|
protected int getDataSize() {
|
|
|
|
return 2;
|
2002-01-30 21:22:28 -05:00
|
|
|
}
|
|
|
|
|
2008-11-19 14:09:05 -05:00
|
|
|
public short getSid() {
|
2006-01-03 02:24:01 -05:00
|
|
|
return sid;
|
2002-01-30 21:22:28 -05:00
|
|
|
}
|
2003-03-01 09:27:43 -05:00
|
|
|
|
|
|
|
public Object clone() {
|
2008-11-19 14:09:05 -05:00
|
|
|
return new ProtectRecord(_options);
|
2003-03-01 09:27:43 -05:00
|
|
|
}
|
2002-01-30 21:22:28 -05:00
|
|
|
}
|