001: /* ====================================================================
002: Licensed to the Apache Software Foundation (ASF) under one or more
003: contributor license agreements. See the NOTICE file distributed with
004: this work for additional information regarding copyright ownership.
005: The ASF licenses this file to You under the Apache License, Version 2.0
006: (the "License"); you may not use this file except in compliance with
007: the License. You may obtain a copy of the License at
008:
009: http://www.apache.org/licenses/LICENSE-2.0
010:
011: Unless required by applicable law or agreed to in writing, software
012: distributed under the License is distributed on an "AS IS" BASIS,
013: WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014: See the License for the specific language governing permissions and
015: limitations under the License.
016: ==================================================================== */
017:
018: package org.apache.poi.hssf.record;
019:
020: import org.apache.poi.util.LittleEndian;
021:
022: /**
023: * Title: Protection Revision 4 Record<P>
024: * Description: describes whether this is a protected shared/tracked workbook<P>
025: * ( HSSF does not support encryption because we don't feel like going to jail ) <P>
026: * REFERENCE: PG 373 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)<P>
027: * @author Andrew C. Oliver (acoliver at apache dot org)
028: * @version 2.0-pre
029: */
030:
031: public class ProtectionRev4Record extends Record {
032: public final static short sid = 0x1af;
033: private short field_1_protect;
034:
035: public ProtectionRev4Record() {
036: }
037:
038: /**
039: * Constructs a ProtectionRev4 record and sets its fields appropriately.
040: * @param in the RecordInputstream to read the record from
041: */
042:
043: public ProtectionRev4Record(RecordInputStream in) {
044: super (in);
045: }
046:
047: protected void validateSid(short id) {
048: if (id != sid) {
049: throw new RecordFormatException(
050: "NOT A PROTECTION REV 4 RECORD");
051: }
052: }
053:
054: protected void fillFields(RecordInputStream in) {
055: field_1_protect = in.readShort();
056: }
057:
058: /**
059: * set whether the this is protected shared/tracked workbook or not
060: * @param protect whether to protect the workbook or not
061: */
062:
063: public void setProtect(boolean protect) {
064: if (protect) {
065: field_1_protect = 1;
066: } else {
067: field_1_protect = 0;
068: }
069: }
070:
071: /**
072: * get whether the this is protected shared/tracked workbook or not
073: * @return whether to protect the workbook or not
074: */
075:
076: public boolean getProtect() {
077: return (field_1_protect == 1);
078: }
079:
080: public String toString() {
081: StringBuffer buffer = new StringBuffer();
082:
083: buffer.append("[PROT4REV]\n");
084: buffer.append(" .protect = ").append(getProtect())
085: .append("\n");
086: buffer.append("[/PROT4REV]\n");
087: return buffer.toString();
088: }
089:
090: public int serialize(int offset, byte[] data) {
091: LittleEndian.putShort(data, 0 + offset, sid);
092: LittleEndian.putShort(data, 2 + offset, ((short) 0x02)); // 2 bytes (6 total)
093: LittleEndian.putShort(data, 4 + offset, field_1_protect);
094: return getRecordSize();
095: }
096:
097: public int getRecordSize() {
098: return 6;
099: }
100:
101: public short getSid() {
102: return sid;
103: }
104: }
|