Package org.apache.poi.hssf.record

Class FtCfSubRecord

java.lang.Object

org.apache.poi.hssf.record.SubRecord

org.apache.poi.hssf.record.FtCfSubRecord

All Implemented Interfaces:

Duplicatable, GenericRecord

public final class FtCfSubRecord
extends SubRecord

The FtCf structure specifies the clipboard format of the picture-type Obj record containing this FtCf.

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.poi.hssf.record.SubRecord

SubRecord.SubRecordTypes

Field Summary

Fields

Modifier and Type	Field	Description
static short	BITMAP_BIT	Specifies the format of the picture is a bitmap.
static short	length
static short	METAFILE_BIT	Specifies the format of the picture is an enhanced metafile.
static short	sid
static short	UNSPECIFIED_BIT	Specifies the picture is in an unspecified format that is neither and enhanced metafile nor a bitmap.

Constructor Summary

Constructors

Constructor	Description
FtCfSubRecord()	Construct a new FtPioGrbitSubRecord and fill its data with the default values
FtCfSubRecord(FtCfSubRecord other)
FtCfSubRecord(LittleEndianInput in, int size)

Method Summary

Modifier and Type	Method	Description
FtCfSubRecord	copy()
protected int	getDataSize()
short	getFlags()
Map<String,Supplier<?>>	getGenericProperties()
SubRecord.SubRecordTypes	getGenericRecordType()
short	getSid()
void	serialize(LittleEndianOutput out)	Serialize the record data into the supplied array of bytes
void	setFlags(short flags)

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

createSubRecord, getMaxRecordLength, isTerminating, serialize, setMaxRecordLength, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.poi.common.usermodel.GenericRecord

getGenericChildren

Field Detail

sid

public static final short sid

See Also:

Constant Field Values

length

public static final short length

See Also:

Constant Field Values

METAFILE_BIT

public static final short METAFILE_BIT

Specifies the format of the picture is an enhanced metafile.

See Also:

Constant Field Values

BITMAP_BIT

public static final short BITMAP_BIT

Specifies the format of the picture is a bitmap.

See Also:

Constant Field Values

UNSPECIFIED_BIT

public static final short UNSPECIFIED_BIT

Specifies the picture is in an unspecified format that is neither and enhanced metafile nor a bitmap.

See Also:

Constant Field Values

Constructor Detail

FtCfSubRecord

public FtCfSubRecord()

Construct a new FtPioGrbitSubRecord and fill its data with the default values

FtCfSubRecord

public FtCfSubRecord(FtCfSubRecord other)

FtCfSubRecord

public FtCfSubRecord(LittleEndianInput in,
                     int size)

Method Detail

serialize

public void serialize(LittleEndianOutput out)

Serialize the record data into the supplied array of bytes

Specified by:

serialize in class SubRecord

Parameters:

out - the stream to serialize into

getDataSize

protected int getDataSize()

Specified by:

getDataSize in class SubRecord

Returns:

the size of the data for this record (which is always 4 bytes less than the total record size). Note however, that ushort encoded after the record sid is usually but not always the data size.

getSid

public short getSid()

Returns:

id of this record.

copy

public FtCfSubRecord copy()

Specified by:

copy in interface Duplicatable

Specified by:

copy in class SubRecord

Returns:

a deep copy of the implementing class / instance

getFlags

public short getFlags()

setFlags

public void setFlags(short flags)

getGenericRecordType

public SubRecord.SubRecordTypes getGenericRecordType()

Specified by:

getGenericRecordType in interface GenericRecord

Specified by:

getGenericRecordType in class SubRecord

getGenericProperties

public Map<String,Supplier<?>> getGenericProperties()