Package org.apache.poi.hssf.record
Class FtPioGrbitSubRecord
java.lang.Object
org.apache.poi.hssf.record.SubRecord
org.apache.poi.hssf.record.FtPioGrbitSubRecord
- All Implemented Interfaces:
Cloneable
This structure appears as part of an Obj record that represents image display properties.
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final int
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.static final int
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).static final int
A bit that specifies whether this is a camera picture.static final int
A bit that specifies whether this object is an ActiveX control.static final int
A bit that specifies whether the pictFmla field of the Obj record that contains this FtPioGrbit specifies a DDE reference.static final int
A bit that specifies whether this picture's size has been explicitly set.static final int
A bit that specifies whether the picture is displayed as an icon.static final short
static final int
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.static final int
A bit that specifies whether the object data are stored in an embedding storage (= 0) or in the controls stream (ctls) (= 1).static final short
-
Constructor Summary
ConstructorsConstructorDescriptionConstruct a newFtPioGrbitSubRecord
and fill its data with the default valuesFtPioGrbitSubRecord
(LittleEndianInput in, int size) -
Method Summary
Modifier and TypeMethodDescriptionclone()
protected int
boolean
getFlagByBit
(int bitmask) short
getFlags()
short
getSid()
void
Serialize the record data into the supplied array of bytesvoid
setFlagByBit
(int bitmask, boolean enabled) Use one of the bitmasks MANUAL_ADVANCE_BIT ...void
setFlags
(short flags) toString()
Convert this record to string.Methods inherited from class org.apache.poi.hssf.record.SubRecord
createSubRecord, isTerminating, serialize
-
Field Details
-
sid
public static final short sid- See Also:
-
length
public static final short length- See Also:
-
AUTO_PICT_BIT
public static final int AUTO_PICT_BITA 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).- See Also:
-
DDE_BIT
public static final int DDE_BITA bit that specifies whether the pictFmla field of the Obj record that contains this FtPioGrbit specifies a DDE reference.- See Also:
-
PRINT_CALC_BIT
public static final int PRINT_CALC_BITA bit that specifies whether this object is expected to be updated on print to reflect the values in the cell associated with the object.- See Also:
-
ICON_BIT
public static final int ICON_BITA bit that specifies whether the picture is displayed as an icon.- See Also:
-
CTL_BIT
public static final int CTL_BITA 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.- See Also:
-
PRSTM_BIT
public static final int PRSTM_BITA bit that specifies whether the object data are stored in an embedding storage (= 0) or in the controls stream (ctls) (= 1).- See Also:
-
CAMERA_BIT
public static final int CAMERA_BITA bit that specifies whether this is a camera picture.- See Also:
-
DEFAULT_SIZE_BIT
public static final int DEFAULT_SIZE_BITA bit that specifies whether this picture's size has been explicitly set. 0 = picture size has been explicitly set, 1 = has not been set- See Also:
-
AUTO_LOAD_BIT
public static final int AUTO_LOAD_BITA 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.- See Also:
-
-
Constructor Details
-
FtPioGrbitSubRecord
public FtPioGrbitSubRecord()Construct a newFtPioGrbitSubRecord
and fill its data with the default values -
FtPioGrbitSubRecord
-
-
Method Details
-
setFlagByBit
public void setFlagByBit(int bitmask, boolean enabled) Use one of the bitmasks MANUAL_ADVANCE_BIT ... CURSOR_VISIBLE_BIT- Parameters:
bitmask
- the bitmask to applyenabled
- if true, the bitmask will be or-ed, otherwise the bits set in the mask will be removed from the flags
-
getFlagByBit
public boolean getFlagByBit(int bitmask) -
toString
Convert this record to string. Used by BiffViewer and other utilities. -
serialize
Serialize the record data into the supplied array of bytes -
getDataSize
protected int getDataSize()- Specified by:
getDataSize
in classSubRecord
- 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.
-
clone
-
getFlags
public short getFlags() -
setFlags
public void setFlags(short flags)
-