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

   1
   2 /* ====================================================================
   3    Licensed to the Apache Software Foundation (ASF) under one or more
   4    contributor license agreements.  See the NOTICE file distributed with
   5    this work for additional information regarding copyright ownership.
   6    The ASF licenses this file to You under the Apache License, Version 2.0
   7    (the "License"); you may not use this file except in compliance with
   8    the License.  You may obtain a copy of the License at
   9
  10        http://www.apache.org/licenses/LICENSE-2.0
  11
  12    Unless required by applicable law or agreed to in writing, software
  13    distributed under the License is distributed on an "AS IS" BASIS,
  14    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  15    See the License for the specific language governing permissions and
  16    limitations under the License.
  17 ==================================================================== */
  18
  19
  20 package org.apache.poi.hssf.record;
  21
  22 import org.apache.poi.util.LittleEndian;
  23
  24 /**
  25  * Title:        Save External Links record (BookBool)<P>
  26  * Description:  Contains a flag specifying whether the Gui should save externally
  27  *               linked values from other workbooks. <P>
  28  * REFERENCE:  PG 289 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)<P>
  29  * @author Andrew C. Oliver (acoliver at apache dot org)
  30  * @version 2.0-pre
  31  */
  32
  33 public class BookBoolRecord
  34     extends Record
  35 {
  36     public final static short sid = 0xDA;
  37     private short             field_1_save_link_values;
  38
  39     public BookBoolRecord()
  40     {
  41     }
  42
  43     /**
  44      * Constructs a BookBoolRecord and sets its fields appropriately
  45      * @param in the RecordInputstream to read the record from
  46      */
  47
  48     public BookBoolRecord(RecordInputStream in)
  49     {
  50         super(in);
  51     }
  52
  53     protected void validateSid(short id)
  54     {
  55         if (id != sid)
  56         {
  57             throw new RecordFormatException("NOT A BOOKBOOL RECORD");
  58         }
  59     }
  60
  61     protected void fillFields(RecordInputStream in)
  62     {
  63         field_1_save_link_values = in.readShort();
  64     }
  65
  66     /**
  67      * set the save ext links flag
  68      *
  69      * @param flag flag (0/1 -off/on)
  70      */
  71
  72     public void setSaveLinkValues(short flag)
  73     {
  74         field_1_save_link_values = flag;
  75     }
  76
  77     /**
  78      * get the save ext links flag
  79      *
  80      * @return short 0/1 (off/on)
  81      */
  82
  83     public short getSaveLinkValues()
  84     {
  85         return field_1_save_link_values;
  86     }
  87
  88     public String toString()
  89     {
  90         StringBuffer buffer = new StringBuffer();
  91
  92         buffer.append("[BOOKBOOL]\n");
  93         buffer.append("    .savelinkvalues  = ")
  94             .append(Integer.toHexString(getSaveLinkValues())).append("\n");
  95         buffer.append("[/BOOKBOOL]\n");
  96         return buffer.toString();
  97     }
  98
  99     public int serialize(int offset, byte [] data)
 100     {
 101         LittleEndian.putShort(data, 0 + offset, sid);
 102         LittleEndian.putShort(data, 2 + offset,
 103                               (( short ) 0x02));   // 2 bytes (6 total)
 104         LittleEndian.putShort(data, 4 + offset, field_1_save_link_values);
 105         return getRecordSize();
 106     }
 107
 108     public int getRecordSize()
 109     {
 110         return 6;
 111     }
 112
 113     public short getSid()
 114     {
 115         return sid;
 116     }
 117 }