org.apache.poi.hssf.record

Class ObjRecord

java.lang.Object

org.apache.poi.hssf.record.RecordBase

org.apache.poi.hssf.record.Record

org.apache.poi.hssf.record.ObjRecord

All Implemented Interfaces:

Duplicatable, GenericRecord

public final class ObjRecord
extends Record

OBJRECORD (0x005D)

The obj record is used to hold various graphic objects and controls.

Field Summary

Fields

Modifier and Type	Field and Description
static short	sid

Constructor Summary

Constructors

Constructor and Description
ObjRecord()
ObjRecord(ObjRecord other)
ObjRecord(RecordInputStream in)

Method Summary

Modifier and Type	Method and Description
void	addSubRecord(int index, SubRecord element)
boolean	addSubRecord(SubRecord o)
void	clearSubRecords()
ObjRecord	copy()
java.util.List<SubRecord>	getGenericChildren()
java.util.Map<java.lang.String,java.util.function.Supplier<?>>	getGenericProperties()
HSSFRecordTypes	getGenericRecordType()
int	getRecordSize() gives the current serialized size of the record.
short	getSid() return the non static version of the id for this record.
java.util.List<SubRecord>	getSubRecords()
int	serialize(int offset, byte[] data) called by the class that is responsible for writing this sucker.

Methods inherited from class org.apache.poi.hssf.record.Record

cloneViaReserialise, serialize, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

sid

public static final short sid

See Also:

Constant Field Values

Constructor Detail

ObjRecord

public ObjRecord()

ObjRecord

public ObjRecord(ObjRecord other)

ObjRecord

public ObjRecord(RecordInputStream in)

Method Detail

getRecordSize

public int getRecordSize()

Description copied from class: RecordBase

gives the current serialized size of the record. Should include the sid and reclength (4 bytes).

Specified by:

getRecordSize in class RecordBase

Returns:

the record size

serialize

public int serialize(int offset,
                     byte[] data)

Description copied from class: RecordBase

called by the class that is responsible for writing this sucker. Subclasses should implement this so that their data is passed back in a byte array.

Specified by:

serialize in class RecordBase

Parameters:

offset - to begin writing at

data - byte array containing instance data

Returns:

number of bytes written

getSid

public short getSid()

Description copied from class: Record

return the non static version of the id for this record.

Specified by:

getSid in class Record

Returns:

he id for this record

getSubRecords

public java.util.List<SubRecord> getSubRecords()

clearSubRecords

public void clearSubRecords()

addSubRecord

public void addSubRecord(int index,
                         SubRecord element)

addSubRecord

public boolean addSubRecord(SubRecord o)

copy

public ObjRecord copy()

Specified by:

copy in interface Duplicatable

Specified by:

copy in class Record

Returns:

a deep copy of the implementing class / instance

getGenericRecordType

public HSSFRecordTypes getGenericRecordType()

Specified by:

getGenericRecordType in interface GenericRecord

Specified by:

getGenericRecordType in class Record

getGenericProperties

public java.util.Map<java.lang.String,java.util.function.Supplier<?>> getGenericProperties()

getGenericChildren

public java.util.List<SubRecord> getGenericChildren()