poi/src/java/org/apache/poi/hssf/record/ProtectRecord.java

112 lines
3.3 KiB
Java

/* ====================================================================
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
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.
==================================================================== */
package org.apache.poi.hssf.record;
import org.apache.poi.util.LittleEndian;
/**
* Title: Protect Record<P>
* Description: defines whether a sheet or workbook is protected (HSSF DOES NOT SUPPORT ENCRYPTION)<P>
* (kindly ask the US government to stop having arcane stupid encryption laws and we'll support it) <P>
* (after all terrorists will all use US-legal encrypton right??)<P>
* HSSF now supports the simple "protected" sheets (where they are not encrypted and open office et al
* ignore the password record entirely).
* REFERENCE: PG 373 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)<P>
* @author Andrew C. Oliver (acoliver at apache dot org)
*/
public class ProtectRecord
extends Record
{
public final static short sid = 0x12;
private short field_1_protect;
public ProtectRecord()
{
}
public ProtectRecord(RecordInputStream in)
{
field_1_protect = in.readShort();
}
/**
* set whether the sheet is protected or not
* @param protect whether to protect the sheet or not
*/
public void setProtect(boolean protect)
{
if (protect)
{
field_1_protect = 1;
}
else
{
field_1_protect = 0;
}
}
/**
* get whether the sheet is protected or not
* @return whether to protect the sheet or not
*/
public boolean getProtect()
{
return (field_1_protect == 1);
}
public String toString()
{
StringBuffer buffer = new StringBuffer();
buffer.append("[PROTECT]\n");
buffer.append(" .protect = ").append(getProtect())
.append("\n");
buffer.append("[/PROTECT]\n");
return buffer.toString();
}
public int serialize(int offset, byte [] data)
{
LittleEndian.putShort(data, 0 + offset, sid);
LittleEndian.putShort(data, 2 + offset,
(( short ) 0x02)); // 2 bytes (6 total)
LittleEndian.putShort(data, 4 + offset, field_1_protect);
return getRecordSize();
}
protected int getDataSize() {
return 2;
}
public short getSid()
{
return sid;
}
public Object clone() {
ProtectRecord rec = new ProtectRecord();
rec.field_1_protect = field_1_protect;
return rec;
}
}