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: Refresh All Record <P>
024: * Description: Flag whether to refresh all external data when loading a sheet.
025: * (which hssf doesn't support anyhow so who really cares?)<P>
026: * REFERENCE: PG 376 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 RefreshAllRecord extends Record {
032: public final static short sid = 0x1B7;
033: private short field_1_refreshall;
034:
035: public RefreshAllRecord() {
036: }
037:
038: /**
039: * Constructs a RefreshAll record and sets its fields appropriately.
040: * @param in the RecordInputstream to read the record from
041: */
042:
043: public RefreshAllRecord(RecordInputStream in) {
044: super (in);
045: }
046:
047: protected void validateSid(short id) {
048: if (id != sid) {
049: throw new RecordFormatException("NOT A REFRESHALL RECORD");
050: }
051: }
052:
053: protected void fillFields(RecordInputStream in) {
054: field_1_refreshall = in.readShort();
055: }
056:
057: /**
058: * set whether to refresh all external data when loading a sheet
059: * @param refreshall or not
060: */
061:
062: public void setRefreshAll(boolean refreshall) {
063: if (refreshall) {
064: field_1_refreshall = 1;
065: } else {
066: field_1_refreshall = 0;
067: }
068: }
069:
070: /**
071: * get whether to refresh all external data when loading a sheet
072: * @return refreshall or not
073: */
074:
075: public boolean getRefreshAll() {
076: return (field_1_refreshall == 1);
077: }
078:
079: public String toString() {
080: StringBuffer buffer = new StringBuffer();
081:
082: buffer.append("[REFRESHALL]\n");
083: buffer.append(" .refreshall = ")
084: .append(getRefreshAll()).append("\n");
085: buffer.append("[/REFRESHALL]\n");
086: return buffer.toString();
087: }
088:
089: public int serialize(int offset, byte[] data) {
090: LittleEndian.putShort(data, 0 + offset, sid);
091: LittleEndian.putShort(data, 2 + offset, ((short) 0x02)); // 2 bytes (6 total)
092: LittleEndian.putShort(data, 4 + offset, field_1_refreshall);
093: return getRecordSize();
094: }
095:
096: public int getRecordSize() {
097: return 6;
098: }
099:
100: public short getSid() {
101: return sid;
102: }
103: }
|