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

PaneRecord

public class PaneRecord extends Record
Describes the frozen and unfozen panes. NOTE: This source is automatically generated please do not modify this file. Either subclass or remove the record in src/records/definitions.
author
Glen Stampoultzis (glens at apache.org)

Fields Summary
public static final short
sid
private short
field_1_x
private short
field_2_y
private short
field_3_topRow
private short
field_4_leftColumn
private short
field_5_activePane
public static final short
ACTIVE_PANE_LOWER_RIGHT
public static final short
ACTIVE_PANE_UPPER_RIGHT
public static final short
ACTIVE_PANE_LOWER_LEFT
public static final short
ACTIVE_PANE_UPER_LEFT
Constructors Summary
public PaneRecord()



     
    

    
public PaneRecord(RecordInputStream in)
Constructs a Pane record and sets its fields appropriately.

param
id id must be 0x41 or an exception will be throw upon validation
param
size 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
public java.lang.Objectclone()

        PaneRecord rec = new PaneRecord();
    
        rec.field_1_x = field_1_x;
        rec.field_2_y = field_2_y;
        rec.field_3_topRow = field_3_topRow;
        rec.field_4_leftColumn = field_4_leftColumn;
        rec.field_5_activePane = field_5_activePane;
        return rec;
    
protected voidfillFields(org.apache.poi.hssf.record.RecordInputStream in)

        field_1_x                      = in.readShort();
        field_2_y                      = in.readShort();
        field_3_topRow                 = in.readShort();
        field_4_leftColumn             = in.readShort();
        field_5_activePane             = in.readShort();

    
public shortgetActivePane()
Get the active pane field for the Pane record.

return
One of ACTIVE_PANE_LOWER_RIGHT ACTIVE_PANE_UPPER_RIGHT ACTIVE_PANE_LOWER_LEFT ACTIVE_PANE_UPER_LEFT

        return field_5_activePane;
    
public shortgetLeftColumn()
Get the left column field for the Pane record.

        return field_4_leftColumn;
    
public intgetRecordSize()
Size of record (exluding 4 byte header)

        return 4  + 2 + 2 + 2 + 2 + 2;
    
public shortgetSid()

        return sid;
    
public shortgetTopRow()
Get the top row field for the Pane record.

        return field_3_topRow;
    
public shortgetX()
Get the x field for the Pane record.

        return field_1_x;
    
public shortgetY()
Get the y field for the Pane record.

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

        int pos = 0;

        LittleEndian.putShort(data, 0 + offset, sid);
        LittleEndian.putShort(data, 2 + offset, (short)(getRecordSize() - 4));

        LittleEndian.putShort(data, 4 + offset + pos, field_1_x);
        LittleEndian.putShort(data, 6 + offset + pos, field_2_y);
        LittleEndian.putShort(data, 8 + offset + pos, field_3_topRow);
        LittleEndian.putShort(data, 10 + offset + pos, field_4_leftColumn);
        LittleEndian.putShort(data, 12 + offset + pos, field_5_activePane);

        return getRecordSize();
    
public voidsetActivePane(short field_5_activePane)
Set the active pane field for the Pane record.

param
field_5_activePane One of ACTIVE_PANE_LOWER_RIGHT ACTIVE_PANE_UPPER_RIGHT ACTIVE_PANE_LOWER_LEFT ACTIVE_PANE_UPER_LEFT

        this.field_5_activePane = field_5_activePane;
    
public voidsetLeftColumn(short field_4_leftColumn)
Set the left column field for the Pane record.

        this.field_4_leftColumn = field_4_leftColumn;
    
public voidsetTopRow(short field_3_topRow)
Set the top row field for the Pane record.

        this.field_3_topRow = field_3_topRow;
    
public voidsetX(short field_1_x)
Set the x field for the Pane record.

        this.field_1_x = field_1_x;
    
public voidsetY(short field_2_y)
Set the y field for the Pane record.

        this.field_2_y = field_2_y;
    
public java.lang.StringtoString()

        StringBuffer buffer = new StringBuffer();

        buffer.append("[PANE]\n");
        buffer.append("    .x                    = ")
            .append("0x").append(HexDump.toHex(  getX ()))
            .append(" (").append( getX() ).append(" )");
        buffer.append(System.getProperty("line.separator")); 
        buffer.append("    .y                    = ")
            .append("0x").append(HexDump.toHex(  getY ()))
            .append(" (").append( getY() ).append(" )");
        buffer.append(System.getProperty("line.separator")); 
        buffer.append("    .topRow               = ")
            .append("0x").append(HexDump.toHex(  getTopRow ()))
            .append(" (").append( getTopRow() ).append(" )");
        buffer.append(System.getProperty("line.separator")); 
        buffer.append("    .leftColumn           = ")
            .append("0x").append(HexDump.toHex(  getLeftColumn ()))
            .append(" (").append( getLeftColumn() ).append(" )");
        buffer.append(System.getProperty("line.separator")); 
        buffer.append("    .activePane           = ")
            .append("0x").append(HexDump.toHex(  getActivePane ()))
            .append(" (").append( getActivePane() ).append(" )");
        buffer.append(System.getProperty("line.separator")); 

        buffer.append("[/PANE]\n");
        return buffer.toString();
    
protected voidvalidateSid(short id)
Checks the sid matches the expected side for this record

param
id the expected sid.

        if (id != sid)
        {
            throw new RecordFormatException("Not a Pane record");
        }