Top Description Fields Constructors Methods
org.apache.poi.hssf.record

public final Class FtCfSubRecord

extends SubRecord
Class Inheritance
Static Imports
org.apache.poi.util.GenericRecordUtil.getEnumBitsAsString
The FtCf structure specifies the clipboard format of the picture-type Obj record containing this FtCf.

Field Summary

Modifier and TypeField and Description
public static final short
BITMAP_BIT

Specifies the format of the picture is a bitmap.

private short
flags

public static final short
length

public static final short
METAFILE_BIT

Specifies the format of the picture is an enhanced metafile.

public static final short
sid

public static final short
UNSPECIFIED_BIT

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

Constructor Summary

AccessConstructor and Description
public
FtCfSubRecord()

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

public
FtCfSubRecord(FtCfSubRecord other)

public
FtCfSubRecord(LittleEndianInput in, int size)

pack-priv
FtCfSubRecord(LittleEndianInput in, int size, int cmoOt)

Method Summary

Modifier and TypeMethod and Description
public FtCfSubRecord
copy()

Implements abstract org.apache.poi.hssf.record.SubRecord.copy.

Implements org.apache.poi.common.Duplicatable.copy.

protected int
getDataSize()

Implements abstract org.apache.poi.hssf.record.SubRecord.getDataSize.

public short
getFlags()

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

Implements org.apache.poi.common.usermodel.GenericRecord.getGenericProperties.

public SubRecord.SubRecordTypes
getGenericRecordType()

Overrides default org.apache.poi.common.usermodel.GenericRecord.getGenericRecordType.

Implements abstract org.apache.poi.hssf.record.SubRecord.getGenericRecordType.

public short

Returns:

id of this record.
getSid()

public void
serialize(LittleEndianOutput
the stream to serialize into
out)

Implements abstract org.apache.poi.hssf.record.SubRecord.serialize.

Serialize the record data into the supplied array of bytes

public void
setFlags(short flags)

Inherited from org.apache.poi.hssf.record.SubRecord:
createSubRecordgetMaxRecordLengthisTerminatingserializesetMaxRecordLengthtoString

Field Detail

BITMAP_BITback to summary
public static final short BITMAP_BIT

Specifies the format of the picture is a bitmap.

flagsback to summary
private short flags
lengthback to summary
public static final short length
METAFILE_BITback to summary
public static final short METAFILE_BIT

Specifies the format of the picture is an enhanced metafile.

sidback to summary
public static final short sid
UNSPECIFIED_BITback to summary
public static final short UNSPECIFIED_BIT

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

Constructor Detail

FtCfSubRecordback to summary
public FtCfSubRecord()

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

FtCfSubRecordback to summary
public FtCfSubRecord(FtCfSubRecord other)
FtCfSubRecordback to summary
public FtCfSubRecord(LittleEndianInput in, int size)
FtCfSubRecordback to summary
pack-priv FtCfSubRecord(LittleEndianInput in, int size, int cmoOt)

Method Detail

copyback to summary
public FtCfSubRecord copy()

Implements abstract org.apache.poi.hssf.record.SubRecord.copy.

Implements org.apache.poi.common.Duplicatable.copy.

Returns:FtCfSubRecord

Doc from org.apache.poi.common.Duplicatable.copy.

a deep copy of the implementing class / instance

Annotations
@Override
getDataSizeback to summary
protected int getDataSize()

Implements abstract org.apache.poi.hssf.record.SubRecord.getDataSize.

Returns:int

Doc from org.apache.poi.hssf.record.SubRecord.getDataSize.

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.

getFlagsback to summary
public short getFlags()
getGenericPropertiesback to summary
public Map<String, Supplier<?>> getGenericProperties()

Implements org.apache.poi.common.usermodel.GenericRecord.getGenericProperties.

Annotations
@Override
getGenericRecordTypeback to summary
public SubRecord.SubRecordTypes getGenericRecordType()

Overrides default org.apache.poi.common.usermodel.GenericRecord.getGenericRecordType.

Implements abstract org.apache.poi.hssf.record.SubRecord.getGenericRecordType.

Annotations
@Override
getSidback to summary
public short getSid()
Returns:short

id of this record.

serializeback to summary
public void serialize(LittleEndianOutput out)

Implements abstract org.apache.poi.hssf.record.SubRecord.serialize.

Serialize the record data into the supplied array of bytes

Parameters
out:LittleEndianOutput

the stream to serialize into

setFlagsback to summary
public void setFlags(short flags)