src/java/org/apache/poi/hssf/record/WSBoolRecord.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.BitField;
  23 import org.apache.poi.util.BitFieldFactory;
  24 import org.apache.poi.util.LittleEndian;
  25
  26 /**
  27  * Title:        WSBool Record.<p>
  28  * Description:  stores workbook settings  (aka its a big "everything we didn't
  29  *               put somewhere else")<P>
  30  * REFERENCE:  PG 425 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)<P>
  31  * @author Andrew C. Oliver (acoliver at apache dot org)
  32  * @author Glen Stampoultzis (gstamp@iprimus.com.au)
  33  * @author Jason Height (jheight at chariot dot net dot au)
  34  * @version 2.0-pre
  35  */
  36
  37 public class WSBoolRecord
  38     extends Record
  39 {
  40     public final static short     sid = 0x81;
  41     private byte                  field_1_wsbool;         // crappy names are because this is really one big short field (2byte)
  42     private byte                  field_2_wsbool;         // but the docs inconsistantly use it as 2 seperate bytes
  43
  44     // I decided to be consistant in this way.
  45     static final private BitField autobreaks          =
  46         BitFieldFactory.getInstance(0x01);                               // are automatic page breaks visible
  47
  48     // bits 1 to 3 unused
  49     static final private BitField dialog              =
  50         BitFieldFactory.getInstance(0x10);                               // is sheet dialog sheet
  51     static final private BitField applystyles         =
  52         BitFieldFactory.getInstance(0x20);                               // whether to apply automatic styles to outlines
  53     static final private BitField rowsumsbelow        = BitFieldFactory.getInstance(
  54         0x40);                                            // whether summary rows will appear below detail in outlines
  55     static final private BitField rowsumsright        = BitFieldFactory.getInstance(
  56         0x80);                                            // whether summary rows will appear right of the detail in outlines
  57     static final private BitField fittopage           =
  58         BitFieldFactory.getInstance(0x01);                               // whether to fit stuff to the page
  59
  60     // bit 2 reserved
  61     static final private BitField displayguts         = BitFieldFactory.getInstance(
  62         0x06);                                            // whether to display outline symbols (in the gutters)
  63
  64     // bits 4-5 reserved
  65     static final private BitField alternateexpression =   // whether to use alternate expression eval
  66         BitFieldFactory.getInstance(0x40);
  67     static final private BitField alternateformula    =   // whether to use alternate formula entry
  68         BitFieldFactory.getInstance(0x80);
  69
  70     public WSBoolRecord()
  71     {
  72     }
  73
  74     /**
  75      * Constructs a WSBool record and sets its fields appropriately.
  76      * @param in the RecordInputstream to read the record from
  77      */
  78
  79     public WSBoolRecord(RecordInputStream in)
  80     {
  81         super(in);
  82     }
  83
  84     protected void validateSid(short id)
  85     {
  86         if (id != sid)
  87         {
  88             throw new RecordFormatException("NOT A WSBoolRECORD");
  89         }
  90     }
  91
  92     protected void fillFields(RecordInputStream in)
  93     {
  94        byte data[] = in.readRemainder();
  95         field_1_wsbool =
  96             data[ 1 ];   // backwards because theoretically this is one short field
  97         field_2_wsbool =
  98             data[ 0 ];   // but it was easier to implement it this way to avoid confusion
  99     }                             // because the dev kit shows the masks for it as 2 byte fields
 100
 101     // why?  Why ask why?  But don't drink bud dry as its a really
 102     // crappy beer, try the czech "Budvar" beer (which is the real
 103     // budweiser though its ironically good...its sold in the USs
 104     // as czechvar  --- odd that they had the name first but can't
 105     // use it)...
 106
 107     /**
 108      * set first byte (see bit setters)
 109      */
 110
 111     public void setWSBool1(byte bool1)
 112     {
 113         field_1_wsbool = bool1;
 114     }
 115
 116     // bool1 bitfields
 117
 118     /**
 119      * show automatic page breaks or not
 120      * @param ab  whether to show auto page breaks
 121      */
 122
 123     public void setAutobreaks(boolean ab)
 124     {
 125         field_1_wsbool = autobreaks.setByteBoolean(field_1_wsbool, ab);
 126     }
 127
 128     /**
 129      * set whether sheet is a dialog sheet or not
 130      * @param isDialog or not
 131      */
 132
 133     public void setDialog(boolean isDialog)
 134     {
 135         field_1_wsbool = dialog.setByteBoolean(field_1_wsbool, isDialog);
 136     }
 137
 138     /**
 139      * set if row summaries appear below detail in the outline
 140      * @param below or not
 141      */
 142
 143     public void setRowSumsBelow(boolean below)
 144     {
 145         field_1_wsbool = rowsumsbelow.setByteBoolean(field_1_wsbool, below);
 146     }
 147
 148     /**
 149      * set if col summaries appear right of the detail in the outline
 150      * @param right or not
 151      */
 152
 153     public void setRowSumsRight(boolean right)
 154     {
 155         field_1_wsbool = rowsumsright.setByteBoolean(field_1_wsbool, right);
 156     }
 157
 158     // end bitfields
 159
 160     /**
 161      * set the second byte (see bit setters)
 162      */
 163
 164     public void setWSBool2(byte bool2)
 165     {
 166         field_2_wsbool = bool2;
 167     }
 168
 169     // bool2 bitfields
 170
 171     /**
 172      * fit to page option is on
 173      * @param fit2page  fit or not
 174      */
 175
 176     public void setFitToPage(boolean fit2page)
 177     {
 178         field_2_wsbool = fittopage.setByteBoolean(field_2_wsbool, fit2page);
 179     }
 180
 181     /**
 182      * set whether to display the guts or not
 183      *
 184      * @param guts or no guts (or glory)
 185      */
 186
 187     public void setDisplayGuts(boolean guts)
 188     {
 189         field_2_wsbool = displayguts.setByteBoolean(field_2_wsbool, guts);
 190     }
 191
 192     /**
 193      * whether alternate expression evaluation is on
 194      * @param altexp  alternative expression evaluation or not
 195      */
 196
 197     public void setAlternateExpression(boolean altexp)
 198     {
 199         field_2_wsbool = alternateexpression.setByteBoolean(field_2_wsbool,
 200                 altexp);
 201     }
 202
 203     /**
 204      * whether alternative formula entry is on
 205      * @param formula  alternative formulas or not
 206      */
 207
 208     public void setAlternateFormula(boolean formula)
 209     {
 210         field_2_wsbool = alternateformula.setByteBoolean(field_2_wsbool,
 211                 formula);
 212     }
 213
 214     // end bitfields
 215
 216     /**
 217      * get first byte (see bit getters)
 218      */
 219
 220     public byte getWSBool1()
 221     {
 222         return field_1_wsbool;
 223     }
 224
 225     // bool1 bitfields
 226
 227     /**
 228      * show automatic page breaks or not
 229      * @return whether to show auto page breaks
 230      */
 231
 232     public boolean getAutobreaks()
 233     {
 234         return autobreaks.isSet(field_1_wsbool);
 235     }
 236
 237     /**
 238      * get whether sheet is a dialog sheet or not
 239      * @return isDialog or not
 240      */
 241
 242     public boolean getDialog()
 243     {
 244         return dialog.isSet(field_1_wsbool);
 245     }
 246
 247     /**
 248      * get if row summaries appear below detail in the outline
 249      * @return below or not
 250      */
 251
 252     public boolean getRowSumsBelow()
 253     {
 254         return rowsumsbelow.isSet(field_1_wsbool);
 255     }
 256
 257     /**
 258      * get if col summaries appear right of the detail in the outline
 259      * @return right or not
 260      */
 261
 262     public boolean getRowSumsRight()
 263     {
 264         return rowsumsright.isSet(field_1_wsbool);
 265     }
 266
 267     // end bitfields
 268
 269     /**
 270      * get the second byte (see bit getters)
 271      */
 272
 273     public byte getWSBool2()
 274     {
 275         return field_2_wsbool;
 276     }
 277
 278     // bool2 bitfields
 279
 280     /**
 281      * fit to page option is on
 282      * @return fit or not
 283      */
 284
 285     public boolean getFitToPage()
 286     {
 287         return fittopage.isSet(field_2_wsbool);
 288     }
 289
 290     /**
 291      * get whether to display the guts or not
 292      *
 293      * @return guts or no guts (or glory)
 294      */
 295
 296     public boolean getDisplayGuts()
 297     {
 298         return displayguts.isSet(field_2_wsbool);
 299     }
 300
 301     /**
 302      * whether alternate expression evaluation is on
 303      * @return alternative expression evaluation or not
 304      */
 305
 306     public boolean getAlternateExpression()
 307     {
 308         return alternateexpression.isSet(field_2_wsbool);
 309     }
 310
 311     /**
 312      * whether alternative formula entry is on
 313      * @return alternative formulas or not
 314      */
 315
 316     public boolean getAlternateFormula()
 317     {
 318         return alternateformula.isSet(field_2_wsbool);
 319     }
 320
 321     // end bitfields
 322     public String toString()
 323     {
 324         StringBuffer buffer = new StringBuffer();
 325
 326         buffer.append("[WSBOOL]\n");
 327         buffer.append("    .wsbool1        = ")
 328             .append(Integer.toHexString(getWSBool1())).append("\n");
 329         buffer.append("        .autobreaks = ").append(getAutobreaks())
 330             .append("\n");
 331         buffer.append("        .dialog     = ").append(getDialog())
 332             .append("\n");
 333         buffer.append("        .rowsumsbelw= ").append(getRowSumsBelow())
 334             .append("\n");
 335         buffer.append("        .rowsumsrigt= ").append(getRowSumsRight())
 336             .append("\n");
 337         buffer.append("    .wsbool2        = ")
 338             .append(Integer.toHexString(getWSBool2())).append("\n");
 339         buffer.append("        .fittopage  = ").append(getFitToPage())
 340             .append("\n");
 341         buffer.append("        .displayguts= ").append(getDisplayGuts())
 342             .append("\n");
 343         buffer.append("        .alternateex= ")
 344             .append(getAlternateExpression()).append("\n");
 345         buffer.append("        .alternatefo= ").append(getAlternateFormula())
 346             .append("\n");
 347         buffer.append("[/WSBOOL]\n");
 348         return buffer.toString();
 349     }
 350
 351     public int serialize(int offset, byte [] data)
 352     {
 353         LittleEndian.putShort(data, 0 + offset, sid);
 354         LittleEndian.putShort(data, 2 + offset, ( short ) 0x2);
 355         data[ 5 + offset ] = getWSBool1();
 356         data[ 4 + offset ] = getWSBool2();
 357         return getRecordSize();
 358     }
 359
 360     public int getRecordSize()
 361     {
 362         return 6;
 363     }
 364
 365     public short getSid()
 366     {
 367         return sid;
 368     }
 369
 370     public Object clone() {
 371       WSBoolRecord rec = new WSBoolRecord();
 372       rec.field_1_wsbool = field_1_wsbool;
 373       rec.field_2_wsbool = field_2_wsbool;
 374       return rec;
 375     }
 376 }