|
||||||||||
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.RecordAtom org.apache.poi.hslf.record.HeadersFootersAtom
public final class HeadersFootersAtom
An atom record that specifies options for displaying headers and footers on a presentation slide or notes slide.
Field Summary | |
---|---|
static int |
fHasDate
A bit that specifies whether the date is displayed in the footer. |
static int |
fHasFooter
bit that specifies whether the footer text is displayed. |
static int |
fHasHeader
bit that specifies whether the header text is displayed. |
static int |
fHasSlideNumber
A bit that specifies whether the slide number is displayed in the footer. |
static int |
fHasTodayDate
A bit that specifies whether the current datetime is used for displaying the datetime. |
static int |
fHasUserDate
A bit that specifies whether the date specified in UserDateAtom record is used for displaying the datetime. |
Fields inherited from class org.apache.poi.hslf.record.Record |
---|
logger |
Constructor Summary | |
---|---|
|
HeadersFootersAtom()
Create a new instance of HeadersFootersAtom |
protected |
HeadersFootersAtom(byte[] source,
int start,
int len)
Build an instance of HeadersFootersAtom from on-disk data |
Method Summary | |
---|---|
boolean |
getFlag(int bit)
|
int |
getFormatId()
A signed integer that specifies the format ID to be used to style the datetime. |
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. |
long |
getRecordType()
Returns the type (held as a little endian in bytes 3 and 4) that this class handles |
void |
setFlag(int bit,
boolean value)
|
void |
setFormatId(int formatId)
A signed integer that specifies the format ID to be used to style the datetime. |
void |
setMask(int mask)
A bit mask specifying options for displaying headers and footers |
java.lang.String |
toString()
|
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.RecordAtom |
---|
getChildRecords, isAnAtom |
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, wait, wait, wait |
Field Detail |
---|
public static final int fHasDate
getMask()
,
setMask(int)
,
Constant Field Valuespublic static final int fHasTodayDate
getMask()
,
setMask(int)
,
Constant Field Valuespublic static final int fHasUserDate
getMask()
,
setMask(int)
,
Constant Field Valuespublic static final int fHasSlideNumber
getMask()
,
setMask(int)
,
Constant Field Valuespublic static final int fHasHeader
getMask()
,
setMask(int)
,
Constant Field Valuespublic static final int fHasFooter
getMask()
,
setMask(int)
,
Constant Field ValuesConstructor Detail |
---|
protected HeadersFootersAtom(byte[] source, int start, int len)
HeadersFootersAtom
from on-disk data
public HeadersFootersAtom()
HeadersFootersAtom
Method Detail |
---|
public long getRecordType()
Record
getRecordType
in class Record
public void writeOut(java.io.OutputStream out) throws java.io.IOException
writeOut
in class Record
java.io.IOException
public int getFormatId()
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.
public void setFormatId(int formatId)
formatId
- A signed integer that specifies the format ID to be used to style the datetime.public int getMask()
fHasDate
(1 bit): A bit that specifies whether the date is displayed in the footer.
fHasTodayDate
(1 bit): A bit that specifies whether the current datetime is used for
displaying the datetime.
fHasUserDate
(1 bit): A bit that specifies whether the date specified in UserDateAtom record
is used for displaying the datetime.
fHasSlideNumber
(1 bit): A bit that specifies whether the slide number is displayed in the footer.
fHasHeader
(1 bit): A bit that specifies whether the header text specified by HeaderAtom
record is displayed.
fHasFooter
(1 bit): A bit that specifies whether the footer text specified by FooterAtom
record is displayed.
public void setMask(int mask)
mask
- A bit mask specifying options for displaying headers and footerspublic boolean getFlag(int bit)
bit
- the bit to check
public void setFlag(int bit, boolean value)
bit
- the bit to setvalue
- whether the specified bit is setpublic java.lang.String toString()
toString
in class java.lang.Object
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |