org.apache.poi.hwpf.model
Class FileInformationBlock
java.lang.Object
org.apache.poi.hwpf.model.FileInformationBlock
- All Implemented Interfaces:
- java.lang.Cloneable
public final class FileInformationBlock
- extends java.lang.Object
- implements java.lang.Cloneable
The File Information Block (FIB). Holds pointers
to various bits of the file, and lots of flags which
specify properties of the document.
The FibBase
class, holds the
first 32 bytes.
The next part, the fibRgW / FibRgW97, is handled
by FibRgW97
.
The next part, the fibRgLw / The FibRgLw97, is
handled by the FibRgLw
.
Finally, the rest of the fields are handled by
the FIBFieldHandler
.
- Author:
- andy
Field Summary |
static org.apache.poi.util.POILogger |
logger
|
Constructor Summary |
FileInformationBlock(byte[] mainDocument)
Creates a new instance of FileInformationBlock |
Method Summary |
void |
clearOffsetsSizes()
|
void |
fillVariableFields(byte[] mainDocument,
byte[] tableStream)
|
int |
getCbMac()
How many bytes of the main stream contain real data. |
int |
getFcClx()
|
int |
getFcDggInfo()
|
int |
getFcDop()
|
int |
getFcPlcfbkf()
|
int |
getFcPlcfbkl()
|
int |
getFcPlcfbteChpx()
|
int |
getFcPlcfbtePapx()
|
int |
getFcPlcffldAtn()
|
int |
getFcPlcffldEdn()
|
int |
getFcPlcffldFtn()
|
int |
getFcPlcffldHdr()
|
int |
getFcPlcffldHdrtxbx()
|
int |
getFcPlcffldMom()
|
int |
getFcPlcffldTxbx()
|
int |
getFcPlcfLst()
|
int |
getFcPlcfsed()
|
int |
getFcPlcspaMom()
|
int |
getFcPlfLfo()
|
int |
getFcStshf()
|
int |
getFcSttbfbkmk()
|
int |
getFcSttbfffn()
|
int |
getFcSttbfRMark()
|
int |
getFcSttbSavedBy()
|
FibBase |
getFibBase()
|
int |
getFieldsPlcfLength(FieldsDocumentPart part)
|
int |
getFieldsPlcfOffset(FieldsDocumentPart part)
|
int |
getFSPAPlcfLength(FSPADocumentPart part)
|
int |
getFSPAPlcfOffset(FSPADocumentPart part)
|
int |
getLcbClx()
|
int |
getLcbDggInfo()
|
int |
getLcbDop()
|
int |
getLcbPlcfbkf()
|
int |
getLcbPlcfbkl()
|
int |
getLcbPlcfbteChpx()
|
int |
getLcbPlcfbtePapx()
|
int |
getLcbPlcffldAtn()
|
int |
getLcbPlcffldEdn()
|
int |
getLcbPlcffldFtn()
|
int |
getLcbPlcffldHdr()
|
int |
getLcbPlcffldHdrtxbx()
|
int |
getLcbPlcffldMom()
|
int |
getLcbPlcffldTxbx()
|
int |
getLcbPlcfLst()
|
int |
getLcbPlcfsed()
|
int |
getLcbPlcspaMom()
|
int |
getLcbPlfLfo()
|
int |
getLcbStshf()
|
int |
getLcbSttbfbkmk()
|
int |
getLcbSttbfffn()
|
int |
getLcbSttbfRMark()
|
int |
getLcbSttbSavedBy()
|
int |
getModifiedHigh()
|
int |
getModifiedLow()
|
int |
getNFib()
|
int |
getNotesDescriptorsOffset(NoteType noteType)
|
int |
getNotesDescriptorsSize(NoteType noteType)
|
int |
getNotesTextPositionsOffset(NoteType noteType)
|
int |
getNotesTextPositionsSize(NoteType noteType)
|
int |
getPlcfHddOffset()
Return the offset to the PlcfHdd, in the table stream,
i.e. |
int |
getPlcfHddSize()
Return the size of the PlcfHdd, in the table stream,
i.e. |
int |
getSize()
|
int |
getSubdocumentTextStreamLength(SubdocumentType type)
|
void |
setCbMac(int cbMac)
Updates the count of the number of bytes in the
main stream which contain real data |
void |
setFcClx(int fcClx)
|
void |
setFcDop(int fcDop)
|
void |
setFcPlcfbkf(int offset)
|
void |
setFcPlcfbkl(int offset)
|
void |
setFcPlcfbteChpx(int fcPlcfBteChpx)
|
void |
setFcPlcfbtePapx(int fcPlcfBtePapx)
|
void |
setFcPlcffldAtn(int offset)
|
void |
setFcPlcffldEdn(int offset)
|
void |
setFcPlcffldFtn(int offset)
|
void |
setFcPlcffldHdr(int offset)
|
void |
setFcPlcffldHdrtxbx(int offset)
|
void |
setFcPlcffldMom(int offset)
|
void |
setFcPlcffldTxbx(int offset)
|
void |
setFcPlcfLst(int fcPlcfLst)
|
void |
setFcPlcfsed(int fcPlcfSed)
|
void |
setFcPlfLfo(int fcPlfLfo)
|
void |
setFcStshf(int fcStshf)
|
void |
setFcSttbfbkmk(int offset)
|
void |
setFcSttbfffn(int fcSttbFffn)
|
void |
setFcSttbfRMark(int fcSttbfRMark)
|
void |
setFcSttbSavedBy(int fcSttbSavedBy)
|
void |
setFieldsPlcfLength(FieldsDocumentPart part,
int length)
|
void |
setFieldsPlcfOffset(FieldsDocumentPart part,
int offset)
|
void |
setFSPAPlcfLength(FSPADocumentPart part,
int length)
|
void |
setFSPAPlcfOffset(FSPADocumentPart part,
int offset)
|
void |
setLcbClx(int lcbClx)
|
void |
setLcbDop(int lcbDop)
|
void |
setLcbPlcfbkf(int length)
|
void |
setLcbPlcfbkl(int length)
|
void |
setLcbPlcfbteChpx(int lcbPlcfBteChpx)
|
void |
setLcbPlcfbtePapx(int lcbPlcfBtePapx)
|
void |
setLcbPlcffldAtn(int size)
|
void |
setLcbPlcffldEdn(int size)
|
void |
setLcbPlcffldFtn(int size)
|
void |
setLcbPlcffldHdr(int size)
|
void |
setLcbPlcffldHdrtxbx(int size)
|
void |
setLcbPlcffldMom(int size)
|
void |
setLcbPlcffldTxbx(int size)
|
void |
setLcbPlcfLst(int lcbPlcfLst)
|
void |
setLcbPlcfsed(int lcbPlcfSed)
|
void |
setLcbPlfLfo(int lcbPlfLfo)
|
void |
setLcbStshf(int lcbStshf)
|
void |
setLcbSttbfbkmk(int length)
|
void |
setLcbSttbfffn(int lcbSttbFffn)
|
void |
setLcbSttbfRMark(int lcbSttbfRMark)
|
void |
setLcbSttbSavedBy(int fcSttbSavedBy)
|
void |
setModifiedHigh(int modifiedHigh)
|
void |
setModifiedLow(int modifiedLow)
|
void |
setNotesDescriptorsOffset(NoteType noteType,
int offset)
|
void |
setNotesDescriptorsSize(NoteType noteType,
int offset)
|
void |
setNotesTextPositionsOffset(NoteType noteType,
int offset)
|
void |
setNotesTextPositionsSize(NoteType noteType,
int offset)
|
void |
setPlcfHddOffset(int fcPlcfHdd)
|
void |
setPlcfHddSize(int lcbPlcfHdd)
|
void |
setSubdocumentTextStreamLength(SubdocumentType type,
int length)
|
java.lang.String |
toString()
|
void |
writeTo(byte[] mainStream,
HWPFOutputStream tableStream)
|
Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait |
logger
public static final org.apache.poi.util.POILogger logger
FileInformationBlock
public FileInformationBlock(byte[] mainDocument)
- Creates a new instance of FileInformationBlock
fillVariableFields
public void fillVariableFields(byte[] mainDocument,
byte[] tableStream)
toString
public java.lang.String toString()
- Overrides:
toString
in class java.lang.Object
getNFib
public int getNFib()
getFcDop
public int getFcDop()
setFcDop
public void setFcDop(int fcDop)
getLcbDop
public int getLcbDop()
setLcbDop
public void setLcbDop(int lcbDop)
getFcStshf
public int getFcStshf()
getLcbStshf
public int getLcbStshf()
setFcStshf
public void setFcStshf(int fcStshf)
setLcbStshf
public void setLcbStshf(int lcbStshf)
getFcClx
public int getFcClx()
getLcbClx
public int getLcbClx()
setFcClx
public void setFcClx(int fcClx)
setLcbClx
public void setLcbClx(int lcbClx)
getFcPlcfbteChpx
public int getFcPlcfbteChpx()
getLcbPlcfbteChpx
public int getLcbPlcfbteChpx()
setFcPlcfbteChpx
public void setFcPlcfbteChpx(int fcPlcfBteChpx)
setLcbPlcfbteChpx
public void setLcbPlcfbteChpx(int lcbPlcfBteChpx)
getFcPlcfbtePapx
public int getFcPlcfbtePapx()
getLcbPlcfbtePapx
public int getLcbPlcfbtePapx()
setFcPlcfbtePapx
public void setFcPlcfbtePapx(int fcPlcfBtePapx)
setLcbPlcfbtePapx
public void setLcbPlcfbtePapx(int lcbPlcfBtePapx)
getFcPlcfsed
public int getFcPlcfsed()
getLcbPlcfsed
public int getLcbPlcfsed()
setFcPlcfsed
public void setFcPlcfsed(int fcPlcfSed)
setLcbPlcfsed
public void setLcbPlcfsed(int lcbPlcfSed)
getFcPlcfLst
public int getFcPlcfLst()
getLcbPlcfLst
public int getLcbPlcfLst()
setFcPlcfLst
public void setFcPlcfLst(int fcPlcfLst)
setLcbPlcfLst
public void setLcbPlcfLst(int lcbPlcfLst)
getFcPlfLfo
public int getFcPlfLfo()
getLcbPlfLfo
public int getLcbPlfLfo()
getFcSttbfbkmk
public int getFcSttbfbkmk()
- Returns:
- Offset in table stream of the STTBF that records bookmark names
in the main document
setFcSttbfbkmk
public void setFcSttbfbkmk(int offset)
getLcbSttbfbkmk
public int getLcbSttbfbkmk()
- Returns:
- Count of bytes in Sttbfbkmk
setLcbSttbfbkmk
public void setLcbSttbfbkmk(int length)
getFcPlcfbkf
public int getFcPlcfbkf()
- Returns:
- Offset in table stream of the PLCF that records the beginning CP
offsets of bookmarks in the main document. See BKF structure
definition.
setFcPlcfbkf
public void setFcPlcfbkf(int offset)
getLcbPlcfbkf
public int getLcbPlcfbkf()
- Returns:
- Count of bytes in Plcfbkf
setLcbPlcfbkf
public void setLcbPlcfbkf(int length)
getFcPlcfbkl
public int getFcPlcfbkl()
- Returns:
- Offset in table stream of the PLCF that records the ending CP
offsets of bookmarks recorded in the main document. No structure
is stored in this PLCF.
setFcPlcfbkl
public void setFcPlcfbkl(int offset)
getLcbPlcfbkl
public int getLcbPlcfbkl()
- Returns:
- Count of bytes in Plcfbkl
setLcbPlcfbkl
public void setLcbPlcfbkl(int length)
setFcPlfLfo
public void setFcPlfLfo(int fcPlfLfo)
setLcbPlfLfo
public void setLcbPlfLfo(int lcbPlfLfo)
getFcSttbfffn
public int getFcSttbfffn()
getLcbSttbfffn
public int getLcbSttbfffn()
setFcSttbfffn
public void setFcSttbfffn(int fcSttbFffn)
setLcbSttbfffn
public void setLcbSttbfffn(int lcbSttbFffn)
getFcSttbfRMark
public int getFcSttbfRMark()
getLcbSttbfRMark
public int getLcbSttbfRMark()
setFcSttbfRMark
public void setFcSttbfRMark(int fcSttbfRMark)
setLcbSttbfRMark
public void setLcbSttbfRMark(int lcbSttbfRMark)
getPlcfHddOffset
public int getPlcfHddOffset()
- Return the offset to the PlcfHdd, in the table stream,
i.e. fcPlcfHdd
getPlcfHddSize
public int getPlcfHddSize()
- Return the size of the PlcfHdd, in the table stream,
i.e. lcbPlcfHdd
setPlcfHddOffset
public void setPlcfHddOffset(int fcPlcfHdd)
setPlcfHddSize
public void setPlcfHddSize(int lcbPlcfHdd)
getFcSttbSavedBy
public int getFcSttbSavedBy()
getLcbSttbSavedBy
public int getLcbSttbSavedBy()
setFcSttbSavedBy
public void setFcSttbSavedBy(int fcSttbSavedBy)
setLcbSttbSavedBy
public void setLcbSttbSavedBy(int fcSttbSavedBy)
getModifiedLow
public int getModifiedLow()
getModifiedHigh
public int getModifiedHigh()
setModifiedLow
public void setModifiedLow(int modifiedLow)
setModifiedHigh
public void setModifiedHigh(int modifiedHigh)
getCbMac
public int getCbMac()
- How many bytes of the main stream contain real data.
setCbMac
public void setCbMac(int cbMac)
- Updates the count of the number of bytes in the
main stream which contain real data
getSubdocumentTextStreamLength
public int getSubdocumentTextStreamLength(SubdocumentType type)
- Returns:
- length of specified subdocument text stream in characters
setSubdocumentTextStreamLength
public void setSubdocumentTextStreamLength(SubdocumentType type,
int length)
clearOffsetsSizes
public void clearOffsetsSizes()
getFieldsPlcfOffset
public int getFieldsPlcfOffset(FieldsDocumentPart part)
getFieldsPlcfLength
public int getFieldsPlcfLength(FieldsDocumentPart part)
setFieldsPlcfOffset
public void setFieldsPlcfOffset(FieldsDocumentPart part,
int offset)
setFieldsPlcfLength
public void setFieldsPlcfLength(FieldsDocumentPart part,
int length)
getFcPlcffldAtn
public int getFcPlcffldAtn()
getLcbPlcffldAtn
public int getLcbPlcffldAtn()
setFcPlcffldAtn
public void setFcPlcffldAtn(int offset)
setLcbPlcffldAtn
public void setLcbPlcffldAtn(int size)
getFcPlcffldEdn
public int getFcPlcffldEdn()
getLcbPlcffldEdn
public int getLcbPlcffldEdn()
setFcPlcffldEdn
public void setFcPlcffldEdn(int offset)
setLcbPlcffldEdn
public void setLcbPlcffldEdn(int size)
getFcPlcffldFtn
public int getFcPlcffldFtn()
getLcbPlcffldFtn
public int getLcbPlcffldFtn()
setFcPlcffldFtn
public void setFcPlcffldFtn(int offset)
setLcbPlcffldFtn
public void setLcbPlcffldFtn(int size)
getFcPlcffldHdr
public int getFcPlcffldHdr()
getLcbPlcffldHdr
public int getLcbPlcffldHdr()
setFcPlcffldHdr
public void setFcPlcffldHdr(int offset)
setLcbPlcffldHdr
public void setLcbPlcffldHdr(int size)
getFcPlcffldHdrtxbx
public int getFcPlcffldHdrtxbx()
getLcbPlcffldHdrtxbx
public int getLcbPlcffldHdrtxbx()
setFcPlcffldHdrtxbx
public void setFcPlcffldHdrtxbx(int offset)
setLcbPlcffldHdrtxbx
public void setLcbPlcffldHdrtxbx(int size)
getFcPlcffldMom
public int getFcPlcffldMom()
getLcbPlcffldMom
public int getLcbPlcffldMom()
setFcPlcffldMom
public void setFcPlcffldMom(int offset)
setLcbPlcffldMom
public void setLcbPlcffldMom(int size)
getFcPlcffldTxbx
public int getFcPlcffldTxbx()
getLcbPlcffldTxbx
public int getLcbPlcffldTxbx()
setFcPlcffldTxbx
public void setFcPlcffldTxbx(int offset)
setLcbPlcffldTxbx
public void setLcbPlcffldTxbx(int size)
getFSPAPlcfOffset
public int getFSPAPlcfOffset(FSPADocumentPart part)
getFSPAPlcfLength
public int getFSPAPlcfLength(FSPADocumentPart part)
setFSPAPlcfOffset
public void setFSPAPlcfOffset(FSPADocumentPart part,
int offset)
setFSPAPlcfLength
public void setFSPAPlcfLength(FSPADocumentPart part,
int length)
getFcPlcspaMom
public int getFcPlcspaMom()
getLcbPlcspaMom
public int getLcbPlcspaMom()
getFcDggInfo
public int getFcDggInfo()
getLcbDggInfo
public int getLcbDggInfo()
getNotesDescriptorsOffset
public int getNotesDescriptorsOffset(NoteType noteType)
setNotesDescriptorsOffset
public void setNotesDescriptorsOffset(NoteType noteType,
int offset)
getNotesDescriptorsSize
public int getNotesDescriptorsSize(NoteType noteType)
setNotesDescriptorsSize
public void setNotesDescriptorsSize(NoteType noteType,
int offset)
getNotesTextPositionsOffset
public int getNotesTextPositionsOffset(NoteType noteType)
setNotesTextPositionsOffset
public void setNotesTextPositionsOffset(NoteType noteType,
int offset)
getNotesTextPositionsSize
public int getNotesTextPositionsSize(NoteType noteType)
setNotesTextPositionsSize
public void setNotesTextPositionsSize(NoteType noteType,
int offset)
writeTo
public void writeTo(byte[] mainStream,
HWPFOutputStream tableStream)
throws java.io.IOException
- Throws:
java.io.IOException
getSize
public int getSize()
getFibBase
public FibBase getFibBase()