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

CommonObjectDataSubRecord

public class CommonObjectDataSubRecord extends SubRecord
The common object data record is used to store all common preferences for an excel object. 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_objectType
public static final short
OBJECT_TYPE_GROUP
public static final short
OBJECT_TYPE_LINE
public static final short
OBJECT_TYPE_RECTANGLE
public static final short
OBJECT_TYPE_OVAL
public static final short
OBJECT_TYPE_ARC
public static final short
OBJECT_TYPE_CHART
public static final short
OBJECT_TYPE_TEXT
public static final short
OBJECT_TYPE_BUTTON
public static final short
OBJECT_TYPE_PICTURE
public static final short
OBJECT_TYPE_POLYGON
public static final short
OBJECT_TYPE_RESERVED1
public static final short
OBJECT_TYPE_CHECKBOX
public static final short
OBJECT_TYPE_OPTION_BUTTON
public static final short
OBJECT_TYPE_EDIT_BOX
public static final short
OBJECT_TYPE_LABEL
public static final short
OBJECT_TYPE_DIALOG_BOX
public static final short
OBJECT_TYPE_SPINNER
public static final short
OBJECT_TYPE_SCROLL_BAR
public static final short
OBJECT_TYPE_LIST_BOX
public static final short
OBJECT_TYPE_GROUP_BOX
public static final short
OBJECT_TYPE_COMBO_BOX
public static final short
OBJECT_TYPE_RESERVED2
public static final short
OBJECT_TYPE_RESERVED3
public static final short
OBJECT_TYPE_RESERVED4
public static final short
OBJECT_TYPE_RESERVED5
public static final short
OBJECT_TYPE_COMMENT
public static final short
OBJECT_TYPE_RESERVED6
public static final short
OBJECT_TYPE_RESERVED7
public static final short
OBJECT_TYPE_RESERVED8
public static final short
OBJECT_TYPE_RESERVED9
public static final short
OBJECT_TYPE_MICROSOFT_OFFICE_DRAWING
private short
field_2_objectId
private short
field_3_option
private BitField
locked
private BitField
printable
private BitField
autofill
private BitField
autoline
private int
field_4_reserved1
private int
field_5_reserved2
private int
field_6_reserved3
Constructors Summary
public CommonObjectDataSubRecord()



     
    

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

param
id id must be 0x15 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()

        CommonObjectDataSubRecord rec = new CommonObjectDataSubRecord();
    
        rec.field_1_objectType = field_1_objectType;
        rec.field_2_objectId = field_2_objectId;
        rec.field_3_option = field_3_option;
        rec.field_4_reserved1 = field_4_reserved1;
        rec.field_5_reserved2 = field_5_reserved2;
        rec.field_6_reserved3 = field_6_reserved3;
        return rec;
    
protected voidfillFields(org.apache.poi.hssf.record.RecordInputStream in)

        field_1_objectType             = in.readShort();
        field_2_objectId               = in.readShort();
        field_3_option                 = in.readShort();
        field_4_reserved1              = in.readInt();
        field_5_reserved2              = in.readInt();
        field_6_reserved3              = in.readInt();
    
public shortgetObjectId()
Get the object id field for the CommonObjectData record.

        return field_2_objectId;
    
public shortgetObjectType()
Get the object type field for the CommonObjectData record.

return
One of OBJECT_TYPE_GROUP OBJECT_TYPE_LINE OBJECT_TYPE_RECTANGLE OBJECT_TYPE_OVAL OBJECT_TYPE_ARC OBJECT_TYPE_CHART OBJECT_TYPE_TEXT OBJECT_TYPE_BUTTON OBJECT_TYPE_PICTURE OBJECT_TYPE_POLYGON OBJECT_TYPE_RESERVED1 OBJECT_TYPE_CHECKBOX OBJECT_TYPE_OPTION_BUTTON OBJECT_TYPE_EDIT_BOX OBJECT_TYPE_LABEL OBJECT_TYPE_DIALOG_BOX OBJECT_TYPE_SPINNER OBJECT_TYPE_SCROLL_BAR OBJECT_TYPE_LIST_BOX OBJECT_TYPE_GROUP_BOX OBJECT_TYPE_COMBO_BOX OBJECT_TYPE_RESERVED2 OBJECT_TYPE_RESERVED3 OBJECT_TYPE_RESERVED4 OBJECT_TYPE_RESERVED5 OBJECT_TYPE_COMMENT OBJECT_TYPE_RESERVED6 OBJECT_TYPE_RESERVED7 OBJECT_TYPE_RESERVED8 OBJECT_TYPE_RESERVED9 OBJECT_TYPE_MICROSOFT_OFFICE_DRAWING

        return field_1_objectType;
    
public shortgetOption()
Get the option field for the CommonObjectData record.

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

        return 4  + 2 + 2 + 2 + 4 + 4 + 4;
    
public intgetReserved1()
Get the reserved1 field for the CommonObjectData record.

        return field_4_reserved1;
    
public intgetReserved2()
Get the reserved2 field for the CommonObjectData record.

        return field_5_reserved2;
    
public intgetReserved3()
Get the reserved3 field for the CommonObjectData record.

        return field_6_reserved3;
    
public shortgetSid()

        return sid;
    
public booleanisAutofill()
whether object uses an automatic fill style

return
the autofill field value.

        return autofill.isSet(field_3_option);
    
public booleanisAutoline()
whether object uses an automatic line style

return
the autoline field value.

        return autoline.isSet(field_3_option);
    
public booleanisLocked()
true if object is locked when sheet has been protected

return
the locked field value.

        return locked.isSet(field_3_option);
    
public booleanisPrintable()
object appears when printed

return
the printable field value.

        return printable.isSet(field_3_option);
    
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_objectType);
        LittleEndian.putShort(data, 6 + offset + pos, field_2_objectId);
        LittleEndian.putShort(data, 8 + offset + pos, field_3_option);
        LittleEndian.putInt(data, 10 + offset + pos, field_4_reserved1);
        LittleEndian.putInt(data, 14 + offset + pos, field_5_reserved2);
        LittleEndian.putInt(data, 18 + offset + pos, field_6_reserved3);

        return getRecordSize();
    
public voidsetAutofill(boolean value)
Sets the autofill field value. whether object uses an automatic fill style

        field_3_option = autofill.setShortBoolean(field_3_option, value);
    
public voidsetAutoline(boolean value)
Sets the autoline field value. whether object uses an automatic line style

        field_3_option = autoline.setShortBoolean(field_3_option, value);
    
public voidsetLocked(boolean value)
Sets the locked field value. true if object is locked when sheet has been protected

        field_3_option = locked.setShortBoolean(field_3_option, value);
    
public voidsetObjectId(short field_2_objectId)
Set the object id field for the CommonObjectData record.

        this.field_2_objectId = field_2_objectId;
    
public voidsetObjectType(short field_1_objectType)
Set the object type field for the CommonObjectData record.

param
field_1_objectType One of OBJECT_TYPE_GROUP OBJECT_TYPE_LINE OBJECT_TYPE_RECTANGLE OBJECT_TYPE_OVAL OBJECT_TYPE_ARC OBJECT_TYPE_CHART OBJECT_TYPE_TEXT OBJECT_TYPE_BUTTON OBJECT_TYPE_PICTURE OBJECT_TYPE_POLYGON OBJECT_TYPE_RESERVED1 OBJECT_TYPE_CHECKBOX OBJECT_TYPE_OPTION_BUTTON OBJECT_TYPE_EDIT_BOX OBJECT_TYPE_LABEL OBJECT_TYPE_DIALOG_BOX OBJECT_TYPE_SPINNER OBJECT_TYPE_SCROLL_BAR OBJECT_TYPE_LIST_BOX OBJECT_TYPE_GROUP_BOX OBJECT_TYPE_COMBO_BOX OBJECT_TYPE_RESERVED2 OBJECT_TYPE_RESERVED3 OBJECT_TYPE_RESERVED4 OBJECT_TYPE_RESERVED5 OBJECT_TYPE_COMMENT OBJECT_TYPE_RESERVED6 OBJECT_TYPE_RESERVED7 OBJECT_TYPE_RESERVED8 OBJECT_TYPE_RESERVED9 OBJECT_TYPE_MICROSOFT_OFFICE_DRAWING

        this.field_1_objectType = field_1_objectType;
    
public voidsetOption(short field_3_option)
Set the option field for the CommonObjectData record.

        this.field_3_option = field_3_option;
    
public voidsetPrintable(boolean value)
Sets the printable field value. object appears when printed

        field_3_option = printable.setShortBoolean(field_3_option, value);
    
public voidsetReserved1(int field_4_reserved1)
Set the reserved1 field for the CommonObjectData record.

        this.field_4_reserved1 = field_4_reserved1;
    
public voidsetReserved2(int field_5_reserved2)
Set the reserved2 field for the CommonObjectData record.

        this.field_5_reserved2 = field_5_reserved2;
    
public voidsetReserved3(int field_6_reserved3)
Set the reserved3 field for the CommonObjectData record.

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

        StringBuffer buffer = new StringBuffer();

        buffer.append("[ftCmo]\n");
        buffer.append("    .objectType           = ")
            .append("0x").append(HexDump.toHex(  getObjectType ()))
            .append(" (").append( getObjectType() ).append(" )");
        buffer.append(System.getProperty("line.separator")); 
        buffer.append("    .objectId             = ")
            .append("0x").append(HexDump.toHex(  getObjectId ()))
            .append(" (").append( getObjectId() ).append(" )");
        buffer.append(System.getProperty("line.separator")); 
        buffer.append("    .option               = ")
            .append("0x").append(HexDump.toHex(  getOption ()))
            .append(" (").append( getOption() ).append(" )");
        buffer.append(System.getProperty("line.separator")); 
        buffer.append("         .locked                   = ").append(isLocked()).append('\n"); 
        buffer.append("         .printable                = ").append(isPrintable()).append('\n"); 
        buffer.append("         .autofill                 = ").append(isAutofill()).append('\n"); 
        buffer.append("         .autoline                 = ").append(isAutoline()).append('\n"); 
        buffer.append("    .reserved1            = ")
            .append("0x").append(HexDump.toHex(  getReserved1 ()))
            .append(" (").append( getReserved1() ).append(" )");
        buffer.append(System.getProperty("line.separator")); 
        buffer.append("    .reserved2            = ")
            .append("0x").append(HexDump.toHex(  getReserved2 ()))
            .append(" (").append( getReserved2() ).append(" )");
        buffer.append(System.getProperty("line.separator")); 
        buffer.append("    .reserved3            = ")
            .append("0x").append(HexDump.toHex(  getReserved3 ()))
            .append(" (").append( getReserved3() ).append(" )");
        buffer.append(System.getProperty("line.separator")); 

        buffer.append("[/ftCmo]\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 CommonObjectData record");
        }