|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.apache.poi.hslf.record.Record org.apache.poi.hslf.record.RecordContainer org.apache.poi.hslf.record.HeadersFootersContainer
public final class HeadersFootersContainer
A container record that specifies information about the footers on a presentation slide.
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.
Field Summary | |
---|---|
static int |
FOOTERATOM
|
static int |
HEADERATOM
|
static short |
NotesHeadersFootersContainer
"instance" field in the record header indicating that this HeadersFootersContaine is applied for notes and handouts |
static short |
SlideHeadersFootersContainer
"instance" field in the record header indicating that this HeadersFootersContaine is applied for slides |
static int |
USERDATEATOM
|
Fields inherited from class org.apache.poi.hslf.record.RecordContainer |
---|
_children |
Fields inherited from class org.apache.poi.hslf.record.Record |
---|
logger |
Constructor Summary | |
---|---|
protected |
HeadersFootersContainer(byte[] source,
int start,
int len)
|
|
HeadersFootersContainer(short options)
|
Method Summary | |
---|---|
CString |
addFooterAtom()
Insert a CString record that stores the user's date. |
CString |
addHeaderAtom()
Insert a CString record that stores the user's date. |
CString |
addUserDateAtom()
Insert a CString record that stores the user's date. |
CString |
getFooterAtom()
A CString record that stores the Footers's contents. |
CString |
getHeaderAtom()
A CString record that stores the Header's contents. |
HeadersFootersAtom |
getHeadersFootersAtom()
HeadersFootersAtom stores the basic information of the header and footer structure. |
int |
getOptions()
Must be either SlideHeadersFootersContainer or NotesHeadersFootersContainer |
long |
getRecordType()
Return the type, which is
|
CString |
getUserDateAtom()
A CString record that stores the user's date. |
void |
writeOut(java.io.OutputStream out)
Write the contents of the record back, so it can be written to disk |
Methods inherited from class org.apache.poi.hslf.record.RecordContainer |
---|
addChildAfter, addChildBefore, appendChildRecord, findFirstOfType, getChildRecords, handleParentAwareRecords, isAnAtom, moveChildBefore, moveChildrenAfter, moveChildrenBefore, removeChild, setChildRecord, writeOut |
Methods inherited from class org.apache.poi.hslf.record.Record |
---|
buildRecordAtOffset, createRecordForType, findChildRecords, writeLittleEndian, writeLittleEndian |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final short SlideHeadersFootersContainer
public static final short NotesHeadersFootersContainer
public static final int USERDATEATOM
public static final int HEADERATOM
public static final int FOOTERATOM
Constructor Detail |
---|
protected HeadersFootersContainer(byte[] source, int start, int len)
public HeadersFootersContainer(short options)
Method Detail |
---|
public long getRecordType()
RecordTypes.HeadersFooters
getRecordType
in class Record
public int getOptions()
SlideHeadersFootersContainer
or NotesHeadersFootersContainer
public void writeOut(java.io.OutputStream out) throws java.io.IOException
java.io.IOException
public HeadersFootersAtom getHeadersFootersAtom()
HeadersFootersAtom
public CString getUserDateAtom()
CString
record that stores the user's date.
This is the date that the user wants in the footers, instead of today's date.
CString
record that stores the user's date or null
public CString getHeaderAtom()
CString
record that stores the Header's contents.
CString
record that stores the Header's contents or null
public CString getFooterAtom()
CString
record that stores the Footers's contents.
CString
record that stores the Footers's contents or null
public CString addUserDateAtom()
CString
record that stores the user's date.
CString
record that stores the user's date.public CString addHeaderAtom()
CString
record that stores the user's date.
CString
record that stores the user's date.public CString addFooterAtom()
CString
record that stores the user's date.
CString
record that stores the user's date.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |