KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > poi > hssf > record > WindowProtectRecord


1
2 /* ====================================================================
3    Copyright 2002-2004 Apache Software Foundation
4
5    Licensed under the Apache License, Version 2.0 (the "License");
6    you may not use this file except in compliance with the License.
7    You may obtain a copy of the License at
8
9        http://www.apache.org/licenses/LICENSE-2.0
10
11    Unless required by applicable law or agreed to in writing, software
12    distributed under the License is distributed on an "AS IS" BASIS,
13    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14    See the License for the specific language governing permissions and
15    limitations under the License.
16 ==================================================================== */
17         
18
19 package org.apache.poi.hssf.record;
20
21 import org.apache.poi.util.LittleEndian;
22
23 /**
24  * Title: Window Protect Record<P>
25  * Description: flags whether workbook windows are protected<P>
26  * REFERENCE: PG 424 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)<P>
27  * @author Andrew C. Oliver (acoliver at apache dot org)
28  * @version 2.0-pre
29  */
30
31 public class WindowProtectRecord
32     extends Record
33 {
34     public final static short sid = 0x19;
35     private short field_1_protect;
36
37     public WindowProtectRecord()
38     {
39     }
40
41     /**
42      * Constructs a WindowProtect record and sets its fields appropriately.
43      *
44      * @param id id must be 0x19 or an exception will be throw upon validation
45      * @param size the size of the data area of the record
46      * @param data data of the record (should not contain sid/len)
47      */
48
49     public WindowProtectRecord(short id, short size, byte [] data)
50     {
51         super(id, size, data);
52     }
53
54     /**
55      * Constructs a WindowProtect record and sets its fields appropriately.
56      *
57      * @param id id must be 0x19 or an exception will be throw upon validation
58      * @param size the size of the data area of the record
59      * @param data data of the record (should not contain sid/len)
60      * @param offset of the record's data
61      */
62
63     public WindowProtectRecord(short id, short size, byte [] data, int offset)
64     {
65         super(id, size, data, offset);
66     }
67
68     protected void validateSid(short id)
69     {
70         if (id != sid)
71         {
72             throw new RecordFormatException("NOT A WINDOWPROTECT RECORD");
73         }
74     }
75
76     protected void fillFields(byte [] data, short size, int offset)
77     {
78         field_1_protect = LittleEndian.getShort(data, 0 + offset);
79     }
80
81     /**
82      * set whether this window should be protected or not
83      * @param protect or not
84      */
85
86     public void setProtect(boolean protect)
87     {
88         if (protect == true)
89         {
90             field_1_protect = 1;
91         }
92         else
93         {
94             field_1_protect = 0;
95         }
96     }
97
98     /**
99      * is this window protected or not
100      *
101      * @return protected or not
102      */
103
104     public boolean getProtect()
105     {
106         return (field_1_protect == 1);
107     }
108
109     public String JavaDoc toString()
110     {
111         StringBuffer JavaDoc buffer = new StringBuffer JavaDoc();
112
113         buffer.append("[WINDOWPROTECT]\n");
114         buffer.append(" .protect = ").append(getProtect())
115             .append("\n");
116         buffer.append("[/WINDOWPROTECT]\n");
117         return buffer.toString();
118     }
119
120     public int serialize(int offset, byte [] data)
121     {
122         LittleEndian.putShort(data, 0 + offset, sid);
123         LittleEndian.putShort(data, 2 + offset,
124                               (( short ) 0x02)); // 2 bytes (6 total)
125 LittleEndian.putShort(data, 4 + offset, field_1_protect);
126         return getRecordSize();
127     }
128
129     public int getRecordSize()
130     {
131         return 6;
132     }
133
134     public short getSid()
135     {
136         return this.sid;
137     }
138 }
139
Popular Tags