src/java/org/apache/poi/hssf/record/HideObjRecord.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:        Hide Object Record<P>
  26  * Description:  flag defines whether to hide placeholders and object<P>
  27  * REFERENCE:  PG 321 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 HideObjRecord
  33     extends Record
  34 {
  35     public final static short sid               = 0x8d;
  36     public final static short HIDE_ALL          = 2;
  37     public final static short SHOW_PLACEHOLDERS = 1;
  38     public final static short SHOW_ALL          = 0;
  39     private short             field_1_hide_obj;
  40
  41     public HideObjRecord()
  42     {
  43     }
  44
  45     /**
  46      * Constructs an HideObj record and sets its fields appropriately.
  47      * @param in the RecordInputstream to read the record from
  48      */
  49
  50     public HideObjRecord(RecordInputStream in)
  51     {
  52         super(in);
  53     }
  54
  55     protected void validateSid(short id)
  56     {
  57         if (id != sid)
  58         {
  59             throw new RecordFormatException("NOT A HIDEOBJ RECORD");
  60         }
  61     }
  62
  63     protected void fillFields(RecordInputStream in)
  64     {
  65         field_1_hide_obj = in.readShort();
  66     }
  67
  68     /**
  69      * set hide object options
  70      *
  71      * @param hide options
  72      * @see #HIDE_ALL
  73      * @see #SHOW_PLACEHOLDERS
  74      * @see #SHOW_ALL
  75      */
  76
  77     public void setHideObj(short hide)
  78     {
  79         field_1_hide_obj = hide;
  80     }
  81
  82     /**
  83      * get hide object options
  84      *
  85      * @return hide options
  86      * @see #HIDE_ALL
  87      * @see #SHOW_PLACEHOLDERS
  88      * @see #SHOW_ALL
  89      */
  90
  91     public short getHideObj()
  92     {
  93         return field_1_hide_obj;
  94     }
  95
  96     public String toString()
  97     {
  98         StringBuffer buffer = new StringBuffer();
  99
 100         buffer.append("[HIDEOBJ]\n");
 101         buffer.append("    .hideobj         = ")
 102             .append(Integer.toHexString(getHideObj())).append("\n");
 103         buffer.append("[/HIDEOBJ]\n");
 104         return buffer.toString();
 105     }
 106
 107     public int serialize(int offset, byte [] data)
 108     {
 109         LittleEndian.putShort(data, 0 + offset, sid);
 110         LittleEndian.putShort(data, 2 + offset,
 111                               (( short ) 0x02));   // 2 bytes (6 total)
 112         LittleEndian.putShort(data, 4 + offset, getHideObj());
 113         return getRecordSize();
 114     }
 115
 116     public int getRecordSize()
 117     {
 118         return 6;
 119     }
 120
 121     public short getSid()
 122     {
 123         return sid;
 124     }
 125 }