Package org.apache.poi.hslf.record

Class HeadersFootersAtom

java.lang.Object
org.apache.poi.hslf.record.Record
org.apache.poi.hslf.record.RecordAtom
org.apache.poi.hslf.record.HeadersFootersAtom
All Implemented Interfaces:
GenericRecord
public final class HeadersFootersAtom extends RecordAtom
An atom record that specifies options for displaying headers and footers on a presentation slide or notes slide.

  • Field Details

  • Constructor Details

    • HeadersFootersAtom

      public HeadersFootersAtom()
      Create a new instance of HeadersFootersAtom

  • Method Details

    • getRecordType

      public long getRecordType()
      Description copied from class: Record
      Returns the type (held as a little endian in bytes 3 and 4) that this class handles
      Specified by:
      getRecordType in class Record

    • writeOut

      public void writeOut(OutputStream out) throws IOException
      Write the contents of the record back, so it can be written to disk
      Specified by:
      writeOut in class Record
      Throws:
      IOException

    • getFormatId

      public int getFormatId()
      A signed integer that specifies the format ID to be used to style the datetime.

      It MUST be in the range [0, 12].

      This value is converted into a string as specified by the index field of the DateTimeMCAtom record. It MUST be ignored unless fHasTodayDate is TRUE.

      Returns:
      A signed integer that specifies the format ID to be used to style the datetime.

    • setFormatId

      public void setFormatId(int formatId)
      A signed integer that specifies the format ID to be used to style the datetime.
      Parameters:
      formatId - A signed integer that specifies the format ID to be used to style the datetime.

    • getMask

      public int getMask()
      A bit mask specifying options for displaying headers and footers
      • A - fHasDate (1 bit): A bit that specifies whether the date is displayed in the footer.
      • B - fHasTodayDate (1 bit): A bit that specifies whether the current datetime is used for displaying the datetime.
      • C - fHasUserDate (1 bit): A bit that specifies whether the date specified in UserDateAtom record is used for displaying the datetime.
      • D - fHasSlideNumber (1 bit): A bit that specifies whether the slide number is displayed in the footer.
      • E - fHasHeader (1 bit): A bit that specifies whether the header text specified by HeaderAtom record is displayed.
      • F - fHasFooter (1 bit): A bit that specifies whether the footer text specified by FooterAtom record is displayed.
      • reserved (10 bits): MUST be zero and MUST be ignored.
      Returns:
      A bit mask specifying options for displaying headers and footers

    • setMask

      public void setMask(int mask)
      A bit mask specifying options for displaying headers and footers
      Parameters:
      mask - A bit mask specifying options for displaying headers and footers

    • getFlag

      public boolean getFlag(int bit)
      Parameters:
      bit - the bit to check
      Returns:
      whether the specified flag is set

    • setFlag

      public void setFlag(int bit, boolean value)
      Parameters:
      bit - the bit to set
      value - whether the specified bit is set

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • getGenericProperties

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