FileDocCategorySizeDatePackage
InterfaceHdrRecord.javaAPI DocApache Poi 3.0.13465Mon Jan 01 12:39:40 GMT 2007org.apache.poi.hssf.record

InterfaceHdrRecord

public class InterfaceHdrRecord extends Record
Title: Interface Header Record

Description: Defines the beginning of Interface records (MMS)

REFERENCE: PG 324 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
private short
field_1_codepage
public static final short
CODEPAGE
suggested (and probably correct) default
Constructors Summary
public InterfaceHdrRecord()


     
    
    
public InterfaceHdrRecord(RecordInputStream in)
Constructs an Codepage record and sets its fields appropriately.

param
id id must be 0xe1 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_codepage = in.readShort();
    
public shortgetCodepage()
get the codepage for the file

return
the codepage
see
#CODEPAGE

        return field_1_codepage;
    
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, getCodepage());
        return getRecordSize();
    
public voidsetCodepage(short cp)
set the codepage for the file

param
cp - the codepage
see
#CODEPAGE

        field_1_codepage = cp;
    
public java.lang.StringtoString()

        StringBuffer buffer = new StringBuffer();

        buffer.append("[INTERFACEHDR]\n");
        buffer.append("    .codepage        = ")
            .append(Integer.toHexString(getCodepage())).append("\n");
        buffer.append("[/INTERFACEHDR]\n");
        return buffer.toString();
    
protected voidvalidateSid(short id)

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