Class HeadersFootersContainer


public final class HeadersFootersContainer extends RecordContainer
A container record that specifies information about the footers on a presentation slide.

It contains:

  • 1. HeadersFootersAtom
  • 2. CString, Instance UserDate (0), optional: Stores the user's date. This is the date that the user wants in the footers, instead of today's date.
  • 3. CString, Instance Header (1), optional: Stores the Header's contents.
  • 4. CString, Instance Footer (2), optional: Stores the Footer's contents.

  • Author:
    Yegor Kozlov
    • Field Details

      • SlideHeadersFootersContainer

        public static final short SlideHeadersFootersContainer
        "instance" field in the record header indicating that this HeadersFootersContaine is applied for slides
        See Also:
      • NotesHeadersFootersContainer

        public static final short NotesHeadersFootersContainer
        "instance" field in the record header indicating that this HeadersFootersContaine is applied for notes and handouts
        See Also:
      • USERDATEATOM

        public static final int USERDATEATOM
        See Also:
      • HEADERATOM

        public static final int HEADERATOM
        See Also:
      • FOOTERATOM

        public static final int FOOTERATOM
        See Also:
    • Constructor Details

      • HeadersFootersContainer

        protected HeadersFootersContainer(byte[] source, int start, int len)
      • HeadersFootersContainer

        public HeadersFootersContainer(short options)
    • Method Details

      • getRecordType

        public long getRecordType()
        Return the type, which is RecordTypes.HeadersFooters
        Specified by:
        getRecordType in class Record
      • getOptions

        public int getOptions()
        Returns:
        "instance" field in the record header
      • 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
      • getHeadersFootersAtom

        public HeadersFootersAtom getHeadersFootersAtom()
        HeadersFootersAtom stores the basic information of the header and footer structure.
        Returns:
        HeadersFootersAtom
      • getUserDateAtom

        public CString getUserDateAtom()
        A CString record that stores the user's date.

        This is the date that the user wants in the footers, instead of today's date.

        Returns:
        A CString record that stores the user's date or null
      • getHeaderAtom

        public CString getHeaderAtom()
        A CString record that stores the Header's contents.
        Returns:
        A CString record that stores the Header's contents or null
      • getFooterAtom

        public CString getFooterAtom()
        A CString record that stores the Footers's contents.
        Returns:
        A CString record that stores the Footers's contents or null
      • addUserDateAtom

        public CString addUserDateAtom()
        Insert a CString record that stores the user's date.
        Returns:
        the created CString record that stores the user's date.
      • addHeaderAtom

        public CString addHeaderAtom()
        Insert a CString record that stores the user's date.
        Returns:
        the created CString record that stores the user's date.
      • addFooterAtom

        public CString addFooterAtom()
        Insert a CString record that stores the user's date.
        Returns:
        the created CString record that stores the user's date.