FileDocCategorySizeDatePackage
HideObjRecord.javaAPI DocApache Poi 3.0.13569Mon Jan 01 12:39:40 GMT 2007org.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)

author
Andrew C. Oliver (acoliver at apache dot org)
version
2.0-pre

Fields Summary
public static final short
sid
public static final short
HIDE_ALL
public static final short
SHOW_PLACEHOLDERS
public static final short
SHOW_ALL
private short
field_1_hide_obj
Constructors Summary
public HideObjRecord()


     
    
    
public HideObjRecord(RecordInputStream in)
Constructs an HideObj record and sets its fields appropriately.

param
id id must be 0x8d or an exception will be throw upon validation
param
size the size of the data area of the record
param
data data of the record (should not contain sid/len)

        super(in);
    
Methods Summary
protected voidfillFields(org.apache.poi.hssf.record.RecordInputStream in)

        field_1_hide_obj = in.readShort();
    
public shortgetHideObj()
get hide object options

return
hide options
see
#HIDE_ALL
see
#SHOW_PLACEHOLDERS
see
#SHOW_ALL

        return field_1_hide_obj;
    
public intgetRecordSize()

        return 6;
    
public shortgetSid()

        return sid;
    
public intserialize(int offset, byte[] data)

        LittleEndian.putShort(data, 0 + offset, sid);
        LittleEndian.putShort(data, 2 + offset,
                              (( short ) 0x02));   // 2 bytes (6 total)
        LittleEndian.putShort(data, 4 + offset, getHideObj());
        return getRecordSize();
    
public voidsetHideObj(short hide)
set hide object options

param
hide options
see
#HIDE_ALL
see
#SHOW_PLACEHOLDERS
see
#SHOW_ALL

        field_1_hide_obj = hide;
    
public java.lang.StringtoString()

        StringBuffer buffer = new StringBuffer();

        buffer.append("[HIDEOBJ]\n");
        buffer.append("    .hideobj         = ")
            .append(Integer.toHexString(getHideObj())).append("\n");
        buffer.append("[/HIDEOBJ]\n");
        return buffer.toString();
    
protected voidvalidateSid(short id)

        if (id != sid)
        {
            throw new RecordFormatException("NOT A HIDEOBJ RECORD");
        }