org.apache.poi.hssf.record
Class HideObjRecord

java.lang.Object
  extended by org.apache.poi.hssf.record.RecordBase
      extended by org.apache.poi.hssf.record.Record
          extended by org.apache.poi.hssf.record.HideObjRecord

public class HideObjRecord
extends Record

Title: Hide Object Record

Description: flag defines whether to hide placeholders and object

REFERENCE: PG 321 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)

Version:
2.0-pre
Author:
Andrew C. Oliver (acoliver at apache dot org)

Field Summary
static short HIDE_ALL
           
static short SHOW_ALL
           
static short SHOW_PLACEHOLDERS
           
static short sid
           
 
Constructor Summary
HideObjRecord()
           
HideObjRecord(RecordInputStream in)
           
 
Method Summary
 short getHideObj()
          get hide object options
 int getRecordSize()
          gives the current serialized size of the record.
 short getSid()
          return the non static version of the id for this record.
 int serialize(int offset, byte[] data)
          called by the class that is responsible for writing this sucker.
 void setHideObj(short hide)
          set hide object options
 java.lang.String toString()
          get a string representation of the record (for biffview/debugging)
 
Methods inherited from class org.apache.poi.hssf.record.Record
clone, cloneViaReserialise, serialize
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

sid

public static final short sid
See Also:
Constant Field Values

HIDE_ALL

public static final short HIDE_ALL
See Also:
Constant Field Values

SHOW_PLACEHOLDERS

public static final short SHOW_PLACEHOLDERS
See Also:
Constant Field Values

SHOW_ALL

public static final short SHOW_ALL
See Also:
Constant Field Values
Constructor Detail

HideObjRecord

public HideObjRecord()

HideObjRecord

public HideObjRecord(RecordInputStream in)
Method Detail

setHideObj

public void setHideObj(short hide)
set hide object options

Parameters:
hide - options
See Also:
HIDE_ALL, SHOW_PLACEHOLDERS, SHOW_ALL

getHideObj

public short getHideObj()
get hide object options

Returns:
hide options
See Also:
HIDE_ALL, SHOW_PLACEHOLDERS, SHOW_ALL

toString

public java.lang.String toString()
Description copied from class: Record
get a string representation of the record (for biffview/debugging)

Overrides:
toString in class Record

serialize

public int serialize(int offset,
                     byte[] data)
Description copied from class: RecordBase
called by the class that is responsible for writing this sucker. Subclasses should implement this so that their data is passed back in a byte array.

Specified by:
serialize in class RecordBase
Parameters:
offset - to begin writing at
data - byte array containing instance data
Returns:
number of bytes written

getRecordSize

public int getRecordSize()
Description copied from class: Record
gives the current serialized size of the record. Should include the sid and reclength (4 bytes).

Overrides:
getRecordSize in class Record

getSid

public short getSid()
Description copied from class: Record
return the non static version of the id for this record.

Specified by:
getSid in class Record


Copyright 2008 The Apache Software Foundation or its licensors, as applicable.