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

ChartFormatRecord

public class ChartFormatRecord extends Record
Class ChartFormatRecord
author
Glen Stampoultzis (glens at apache.org)
version
%I%, %G%

Fields Summary
public static final short
sid
private int
field1_x_position
private int
field2_y_position
private int
field3_width
private int
field4_height
private short
field5_grbit
private BitField
varyDisplayPattern
Constructors Summary
public ChartFormatRecord()


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

param
id id must equal the sid 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)

        field1_x_position = in.readInt();
        field2_y_position = in.readInt();
        field3_width      = in.readInt();
        field4_height     = in.readInt();
        field5_grbit      = in.readShort();
    
public intgetHeight()

        return field4_height;
    
public intgetRecordSize()

        return 22;
    
public shortgetSid()

        return sid;
    
public booleangetVaryDisplayPattern()

        return varyDisplayPattern.isSet(field5_grbit);
    
public intgetWidth()

        return field3_width;
    
public intgetXPosition()

        return field1_x_position;
    
public intgetYPosition()

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

        LittleEndian.putShort(data, 0 + offset, sid);
        LittleEndian.putShort(data, 2 + offset,
                              (( short ) 22));   // 22 byte length
        LittleEndian.putInt(data, 4 + offset, getXPosition());
        LittleEndian.putInt(data, 8 + offset, getYPosition());
        LittleEndian.putInt(data, 12 + offset, getWidth());
        LittleEndian.putInt(data, 16 + offset, getHeight());
        LittleEndian.putShort(data, 20 + offset, field5_grbit);
        return getRecordSize();
    
public voidsetHeight(int height)

        this.field4_height = height;
    
public voidsetVaryDisplayPattern(boolean value)

        field5_grbit = varyDisplayPattern.setShortBoolean(field5_grbit,
                value);
    
public voidsetWidth(int width)

        this.field3_width = width;
    
public voidsetXPosition(int xPosition)

        this.field1_x_position = xPosition;
    
public voidsetYPosition(int yPosition)

        this.field2_y_position = yPosition;
    
public java.lang.StringtoString()

        StringBuffer buffer = new StringBuffer();

        buffer.append("[CHARTFORMAT]\n");
        buffer.append("    .xPosition       = ").append(getXPosition())
            .append("\n");
        buffer.append("    .yPosition       = ").append(getYPosition())
            .append("\n");
        buffer.append("    .width           = ").append(getWidth())
            .append("\n");
        buffer.append("    .height          = ").append(getHeight())
            .append("\n");
        buffer.append("    .grBit           = ")
            .append(Integer.toHexString(field5_grbit)).append("\n");
        buffer.append("[/CHARTFORMAT]\n");
        return buffer.toString();
    
protected voidvalidateSid(short id)

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