KickJava   Java API By Example, From Geeks To Geeks.

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


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: Refresh All Record <P>
25  * Description: Flag whether to refresh all external data when loading a sheet.
26  * (which hssf doesn't support anyhow so who really cares?)<P>
27  * REFERENCE: PG 376 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)<P>
28  * @author Andrew C. Oliver (acoliver at apache dot org)
29  * @version 2.0-pre
30  */
31
32 public class RefreshAllRecord
33     extends Record
34 {
35     public final static short sid = 0x1B7;
36     private short field_1_refreshall;
37
38     public RefreshAllRecord()
39     {
40     }
41
42     /**
43      * Constructs a RefreshAll record and sets its fields appropriately.
44      *
45      * @param id id must be 0x187 or an exception will be throw upon validation
46      * @param size the size of the data area of the record
47      * @param data data of the record (should not contain sid/len)
48      */
49
50     public RefreshAllRecord(short id, short size, byte [] data)
51     {
52         super(id, size, data);
53     }
54
55     /**
56      * Constructs a RefreshAll record and sets its fields appropriately.
57      *
58      * @param id id must be 0x187 or an exception will be throw upon validation
59      * @param size the size of the data area of the record
60      * @param data data of the record (should not contain sid/len)
61      * @param offset of the record data
62      */
63
64     public RefreshAllRecord(short id, short size, byte [] data, int offset)
65     {
66         super(id, size, data, offset);
67     }
68
69     protected void validateSid(short id)
70     {
71         if (id != sid)
72         {
73             throw new RecordFormatException("NOT A REFRESHALL RECORD");
74         }
75     }
76
77     protected void fillFields(byte [] data, short size, int offset)
78     {
79         field_1_refreshall = LittleEndian.getShort(data, 0 + offset);
80     }
81
82     /**
83      * set whether to refresh all external data when loading a sheet
84      * @param refreshall or not
85      */
86
87     public void setRefreshAll(boolean refreshall)
88     {
89         if (refreshall)
90         {
91             field_1_refreshall = 1;
92         }
93         else
94         {
95             field_1_refreshall = 0;
96         }
97     }
98
99     /**
100      * get whether to refresh all external data when loading a sheet
101      * @return refreshall or not
102      */
103
104     public boolean getRefreshAll()
105     {
106         return (field_1_refreshall == 1);
107     }
108
109     public String JavaDoc toString()
110     {
111         StringBuffer JavaDoc buffer = new StringBuffer JavaDoc();
112
113         buffer.append("[REFRESHALL]\n");
114         buffer.append(" .refreshall = ").append(getRefreshAll())
115             .append("\n");
116         buffer.append("[/REFRESHALL]\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_refreshall);
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