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:
org.apache.poi.common.Duplicatable, GenericRecord
public final class FtPioGrbitSubRecord extends SubRecord
This structure appears as part of an Obj record that represents image display properties.

  • 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_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).
      See Also:

    • DDE_BIT

      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.
      See Also:

    • ICON_BIT

      public static final int ICON_BIT
      A bit that specifies whether the picture is displayed as an icon.
      See Also:

    • CTL_BIT

      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.
      See Also:

    • PRSTM_BIT

      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).
      See Also:

    • CAMERA_BIT

      public static final int CAMERA_BIT
      A bit that specifies whether this is a camera picture.
      See Also:

    • DEFAULT_SIZE_BIT

      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
      See Also:

    • AUTO_LOAD_BIT

      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.
      See Also:

  • Constructor Details

    • FtPioGrbitSubRecord

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

    • FtPioGrbitSubRecord

      public FtPioGrbitSubRecord(FtPioGrbitSubRecord other)

    • FtPioGrbitSubRecord

      public FtPioGrbitSubRecord(LittleEndianInput in, int size)

  • 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 apply
      enabled - 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)

    • 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

    • getSid

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

    • copy

      public FtPioGrbitSubRecord copy()
      Specified by:
      copy in interface org.apache.poi.common.Duplicatable
      Specified by:
      copy in class SubRecord

    • 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()