Apache POI - Common 5.3.0 · org.apache.poi.hssf.record.FtPioGrbitSubRecord

Field Summary

Modifier and Type	Field and Description
public static final int	AUTO_LOAD_BIT A bit that specifies whether the OLE server for the object is called to load the object's data automatically when the parent workbook is opened.
public static final int	AUTO_PICT_BIT A bit that specifies whether the picture's aspect ratio is preserved when rendered in different views (Normal view, Page Break Preview view, Page Layout view and printing).
public static final int	CAMERA_BIT A bit that specifies whether this is a camera picture.
public static final int	CTL_BIT A bit that specifies whether this object is an ActiveX control.
public static final int	DDE_BIT A bit that specifies whether the pictFmla field of the Obj record that contains this FtPioGrbit specifies a DDE reference.
public static final int	DEFAULT_SIZE_BIT A bit that specifies whether this picture's size has been explicitly set.
private short	flags
public static final int	ICON_BIT A bit that specifies whether the picture is displayed as an icon.
public static final short	length
public static final int	PRINT_CALC_BIT A bit that specifies whether this object is expected to be updated on print to reflect the values in the cell associated with the object.
public static final int	PRSTM_BIT A bit that specifies whether the object data are stored in an embedding storage (= 0) or in the controls stream (ctls) (= 1).
public static final short	sid

Constructor Summary

Access	Constructor and Description
public	FtPioGrbitSubRecord() Construct a new `FtPioGrbitSubRecord` and fill its data with the default values
public	FtPioGrbitSubRecord(FtPioGrbitSubRecord other)
public	FtPioGrbitSubRecord(LittleEndianInput in, int size)
pack-priv	FtPioGrbitSubRecord(LittleEndianInput in, int size, int cmoOt)

Method Summary

Modifier and Type	Method and Description
public FtPioGrbitSubRecord	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 boolean	getFlagByBit(int bitmask)
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	setFlagByBit(int the bitmask to apply bitmask, boolean if true, the bitmask will be or-ed, otherwise the bits set in the mask will be removed from the flags enabled) Use one of the bitmasks MANUAL_ADVANCE_BIT ...
public void	setFlags(short flags)

Inherited from org.apache.poi.hssf.record.SubRecord:: createSubRecord getMaxRecordLength isTerminating serialize setMaxRecordLength toString

Field Detail

AUTO_LOAD_BIT	back to summary
public static final int AUTO_LOAD_BIT A bit that specifies whether the OLE server for the object is called to load the object's data automatically when the parent workbook is opened.

AUTO_PICT_BIT	back to summary
public static final int AUTO_PICT_BIT A bit that specifies whether the picture's aspect ratio is preserved when rendered in different views (Normal view, Page Break Preview view, Page Layout view and printing).

CAMERA_BIT	back to summary
public static final int CAMERA_BIT A bit that specifies whether this is a camera picture.

CTL_BIT	back to summary
public static final int CTL_BIT A bit that specifies whether this object is an ActiveX control. It MUST NOT be the case that both fCtl and fDde are equal to 1.

DDE_BIT	back to summary
public static final int DDE_BIT A bit that specifies whether the pictFmla field of the Obj record that contains this FtPioGrbit specifies a DDE reference.

DEFAULT_SIZE_BIT	back to summary
public static final int DEFAULT_SIZE_BIT A bit that specifies whether this picture's size has been explicitly set. 0 = picture size has been explicitly set, 1 = has not been set

flags	back to summary
private short flags

ICON_BIT	back to summary
public static final int ICON_BIT A bit that specifies whether the picture is displayed as an icon.

length	back to summary
public static final short length

PRINT_CALC_BIT	back to summary
public static final int PRINT_CALC_BIT A bit that specifies whether this object is expected to be updated on print to reflect the values in the cell associated with the object.

PRSTM_BIT	back to summary
public static final int PRSTM_BIT A bit that specifies whether the object data are stored in an embedding storage (= 0) or in the controls stream (ctls) (= 1).

sid	back to summary
public static final short sid

Constructor Detail

FtPioGrbitSubRecord	back to summary
public FtPioGrbitSubRecord() Construct a new `FtPioGrbitSubRecord` and fill its data with the default values

FtPioGrbitSubRecord	back to summary
public FtPioGrbitSubRecord(FtPioGrbitSubRecord other)

FtPioGrbitSubRecord	back to summary
public FtPioGrbitSubRecord(LittleEndianInput in, int size)

FtPioGrbitSubRecord	back to summary
pack-priv FtPioGrbitSubRecord(LittleEndianInput in, int size, int cmoOt)

Method Detail

copy	back to summary
public FtPioGrbitSubRecord copy() Implements abstract org.apache.poi.hssf.record.SubRecord.copy. Implements org.apache.poi.common.Duplicatable.copy. Returns:FtPioGrbitSubRecord Doc from org.apache.poi.common.Duplicatable.copy. a deep copy of the implementing class / instance Annotations @Override

copy

back to summary

public FtPioGrbitSubRecord copy()

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

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

Returns:FtPioGrbitSubRecord

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

a deep copy of the implementing class / instance

Annotations

@Override

getDataSize	back 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.

getDataSize

back 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.

getFlagByBit	back to summary
public boolean getFlagByBit(int bitmask)

getFlags	back to summary
public short getFlags()

getGenericProperties	back to summary
public Map<String, Supplier<?>> getGenericProperties() Implements org.apache.poi.common.usermodel.GenericRecord.getGenericProperties. Annotations @Override

getGenericProperties

back to summary

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

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

Annotations

@Override

getGenericRecordType	back 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

getGenericRecordType

back 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

getSid	back to summary
public short getSid() Returns:short id of this record.

serialize	back 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

serialize

back 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

setFlagByBit	back to summary
public void setFlagByBit(int bitmask, boolean enabled) Use one of the bitmasks MANUAL_ADVANCE_BIT ... CURSOR_VISIBLE_BIT Parameters bitmask:int the bitmask to apply enabled:boolean if true, the bitmask will be or-ed, otherwise the bits set in the mask will be removed from the flags

setFlagByBit

back to summary

public void setFlagByBit(int bitmask, boolean enabled)

Use one of the bitmasks MANUAL_ADVANCE_BIT ... CURSOR_VISIBLE_BIT

Parameters

bitmask:int: the bitmask to apply
enabled:boolean: if true, the bitmask will be or-ed, otherwise the bits set in the mask will be removed from the flags

setFlags	back to summary
public void setFlags(short flags)

public final Class FtPioGrbitSubRecord

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail