Package org.apache.poi.hslf.record
Class HeadersFootersContainer
java.lang.Object
org.apache.poi.hslf.record.Record
org.apache.poi.hslf.record.RecordContainer
org.apache.poi.hslf.record.HeadersFootersContainer
A container record that specifies information about the footers on a presentation slide.
1. 2. 3. 4.
It contains:
HeadersFootersAtom
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.
CString, Instance Header (1), optional: Stores the Header's contents.
CString, Instance Footer (2), optional: Stores the Footer's contents.
- Author:
- Yegor Kozlov
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final intstatic final intstatic final short"instance" field in the record header indicating that this HeadersFootersContaine is applied for notes and handoutsstatic final short"instance" field in the record header indicating that this HeadersFootersContaine is applied for slidesstatic final intFields inherited from class org.apache.poi.hslf.record.RecordContainer
_children -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotectedHeadersFootersContainer(byte[] source, int start, int len) HeadersFootersContainer(short options) -
Method Summary
Modifier and TypeMethodDescriptionInsert aCStringrecord that stores the user's date.Insert aCStringrecord that stores the user's date.Insert aCStringrecord that stores the user's date.ACStringrecord that stores the Footers's contents.ACStringrecord that stores the Header's contents.HeadersFootersAtom stores the basic information of the header and footer structure.intMust be eitherSlideHeadersFootersContainerorNotesHeadersFootersContainerlongReturn the type, which isRecordTypes.HeadersFootersACStringrecord that stores the user's date.voidwriteOut(OutputStream out) Write the contents of the record back, so it can be written to diskMethods inherited from class org.apache.poi.hslf.record.RecordContainer
addChildAfter, addChildBefore, appendChildRecord, findFirstOfType, getChildRecords, handleParentAwareRecords, isAnAtom, moveChildBefore, moveChildrenAfter, moveChildrenBefore, removeChild, setChildRecord, writeOutMethods inherited from class org.apache.poi.hslf.record.Record
buildRecordAtOffset, createRecordForType, findChildRecords, writeLittleEndian, writeLittleEndian
-
Field Details
-
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 isRecordTypes.HeadersFooters- Specified by:
getRecordTypein classRecord
-
getOptions
public int getOptions()Must be eitherSlideHeadersFootersContainerorNotesHeadersFootersContainer- Returns:
- "instance" field in the record header
-
writeOut
Write the contents of the record back, so it can be written to disk- Specified by:
writeOutin classRecord- Throws:
IOException
-
getUserDateAtom
ACStringrecord that stores the user's date.This is the date that the user wants in the footers, instead of today's date.
- Returns:
- A
CStringrecord that stores the user's date ornull
-
getHeaderAtom
ACStringrecord that stores the Header's contents.- Returns:
- A
CStringrecord that stores the Header's contents ornull
-
addUserDateAtom
Insert aCStringrecord that stores the user's date.- Returns:
- the created
CStringrecord that stores the user's date.
-
addHeaderAtom
Insert aCStringrecord that stores the user's date.- Returns:
- the created
CStringrecord that stores the user's date.
-