Package org.apache.poi.hwpf.model.types
Class FibBaseAbstractType
java.lang.Object
org.apache.poi.hwpf.model.types.FibBaseAbstractType
- Direct Known Subclasses:
FibBase
Base part of the File information Block (FibBase). Holds the core part of the FIB,
from the first 32 bytes.
Class and fields descriptions are quoted from Microsoft Office Word 97-2007 Binary File Format and [MS-DOC] - v20110608 Word (.doc) Binary File Format
NOTE: This source is automatically generated please do not modify this file. Either subclass or remove the record in src/types/definitions.
This class is internal. It content or properties may change without notice due to changes in our knowledge of internal Microsoft Word binary structures.
- Author:
- Andrew C. Oliver; Sergey Vladimirov; according to Microsoft Office Word 97-2007 Binary File Format Specification [*.doc] and [MS-DOC] - v20110608 Word (.doc) Binary File Format
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected intprotected byteprotected shortDeprecated.protected shortDeprecated.protected intDeprecated.protected intDeprecated.protected intprotected intprotected intprotected intprotected shortprotected intprotected intprotected byteDeprecated. -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionprotected voidfillFields(byte[] data, int offset) shortgetChs()This value MUST be 0 and MUST be ignored.shortThis value MUST be 0 and MUST be ignored.byteAn unsigned integer.bytegetEnvr()This value MUST be 0, and MUST be ignored.intgetFcMac()This value is undefined and MUST be ignored.intgetFcMin()This value is undefined and MUST be ignored.shortGet the flags1 field for the FibBase record.byteGet the flags2 field for the FibBase record.byteDeprecated.This field should not be used according to specificationintgetLid()A LID that specifies the install language of the application that is producing the document.intgetLKey()If fEncryption is 1 and fObfuscation is 1, this value specifies the XOR obfuscation password verifier.intgetNFib()An unsigned integer that specifies the version number of the file format used.intThis value SHOULD be 0x00BF.intAn unsigned integer that specifies the offset in the WordDocument stream of the FIB for the document which contains all the AutoText items.static intgetSize()Size of recordintThis value is undefined and MUST be ignored.intAn unsigned integer that specifies that this is a Word Binary File.booleanSpecifies that the last save operation that was performed on this document was an incremental save operationbooleanisFDot()Specifies whether this is a document templatebooleanDeprecated.This field should not be used according to specificationbooleanSpecifies whether the document is encrypted or obfuscated as specified in Encryption and ObfuscationbooleanThis value MUST be 1booleanSpecifies whether the installation language of the application that created the document was an East Asian languagebooleanisFGlsy()Specifies whether this is a document that contains only AutoText itemsbooleanWhen set to 0, there SHOULD be no pictures in the documentbooleanSpecifies whether to override the language information and font that are specified in the paragraph style at istd 0 (the normal style) with the defaults that are appropriate for the installation language of the applicationbooleanSpecifies whether to override the section properties for page size, orientation, and margins with the defaults that are appropriate for the installation language of the applicationbooleanisFMac()Deprecated.This field should not be used according to specificationbooleanIf fEncrypted is 1, this bit specifies whether the document is obfuscated by using XOR obfuscation; otherwise, this bit MUST be ignoredbooleanSpecifies whether the document author recommended that the document be opened in read-only modebooleanSpecifies the Table stream to which the FIB refers.booleanSpecifies whether the document has a write-reservation passwordbooleanDeprecated.This field should not be used according to specificationbooleanDeprecated.This field should not be used according to specificationbyte[]voidserialize(byte[] data, int offset) voidsetChs(short field_11_Chs) This value MUST be 0 and MUST be ignored.voidsetChsTables(short field_12_chsTables) This value MUST be 0 and MUST be ignored.voidsetCQuickSaves(byte value) Sets the cQuickSaves field value.voidsetEnvr(byte field_9_envr) This value MUST be 0, and MUST be ignored.voidsetFcMac(int field_14_fcMac) This value is undefined and MUST be ignored.voidsetFcMin(int field_13_fcMin) This value is undefined and MUST be ignored.voidsetFComplex(boolean value) Sets the fComplex field value.voidsetFDot(boolean value) Sets the fDot field value.voidsetFEmptySpecial(boolean value) Sets the fEmptySpecial field value.voidsetFEncrypted(boolean value) Sets the fEncrypted field value.voidsetFExtChar(boolean value) Sets the fExtChar field value.voidsetFFarEast(boolean value) Sets the fFarEast field value.voidsetFGlsy(boolean value) Sets the fGlsy field value.voidsetFHasPic(boolean value) Sets the fHasPic field value.voidsetFlags1(short field_6_flags1) Set the flags1 field for the FibBase record.voidsetFlags2(byte field_10_flags2) Set the flags2 field for the FibBase record.voidsetFLoadOverride(boolean value) Sets the fLoadOverride field value.voidsetFLoadOverridePage(boolean value) Sets the fLoadOverridePage field value.voidsetFMac(boolean value) Sets the fMac field value.voidsetFObfuscated(boolean value) Sets the fObfuscated field value.voidsetFReadOnlyRecommended(boolean value) Sets the fReadOnlyRecommended field value.voidsetFSpare0(byte value) Sets the fSpare0 field value.voidsetFWhichTblStm(boolean value) Sets the fWhichTblStm field value.voidsetFWriteReservation(boolean value) Sets the fWriteReservation field value.voidsetLid(int field_4_lid) A LID that specifies the install language of the application that is producing the document.voidsetLKey(int field_8_lKey) If fEncryption is 1 and fObfuscation is 1, this value specifies the XOR obfuscation password verifier.voidsetNFib(int field_2_nFib) An unsigned integer that specifies the version number of the file format used.voidsetNFibBack(int field_7_nFibBack) This value SHOULD be 0x00BF.voidsetPnNext(int field_5_pnNext) An unsigned integer that specifies the offset in the WordDocument stream of the FIB for the document which contains all the AutoText items.voidsetReserved1(boolean value) Sets the reserved1 field value.voidsetReserved2(boolean value) Sets the reserved2 field value.voidsetUnused(int field_3_unused) This value is undefined and MUST be ignored.voidsetWIdent(int field_1_wIdent) An unsigned integer that specifies that this is a Word Binary File.toString()
-
Field Details
-
field_1_wIdent
protected int field_1_wIdent -
field_2_nFib
protected int field_2_nFib -
field_3_unused
protected int field_3_unused -
field_4_lid
protected int field_4_lid -
field_5_pnNext
protected int field_5_pnNext -
field_6_flags1
protected short field_6_flags1 -
field_7_nFibBack
protected int field_7_nFibBack -
field_8_lKey
protected int field_8_lKey -
field_9_envr
Deprecated. -
field_10_flags2
protected byte field_10_flags2 -
field_11_Chs
Deprecated. -
field_12_chsTables
Deprecated. -
field_13_fcMin
Deprecated. -
field_14_fcMac
Deprecated.
-
-
Constructor Details
-
FibBaseAbstractType
protected FibBaseAbstractType()
-
-
Method Details
-
fillFields
protected void fillFields(byte[] data, int offset) -
serialize
public void serialize(byte[] data, int offset) -
serialize
public byte[] serialize() -
getSize
public static int getSize()Size of record -
toString
-
getWIdent
An unsigned integer that specifies that this is a Word Binary File. This value MUST be 0xA5EC. -
setWIdent
An unsigned integer that specifies that this is a Word Binary File. This value MUST be 0xA5EC. -
getNFib
An unsigned integer that specifies the version number of the file format used. Superseded by FibRgCswNew.nFibNew if it is present. This value SHOULD be 0x00C1. -
setNFib
An unsigned integer that specifies the version number of the file format used. Superseded by FibRgCswNew.nFibNew if it is present. This value SHOULD be 0x00C1. -
getUnused
This value is undefined and MUST be ignored. -
setUnused
This value is undefined and MUST be ignored. -
getLid
A LID that specifies the install language of the application that is producing the document. If nFib is 0x00D9 or greater, then any East Asian install lid or any install lid with a base language of Spanish, German or French MUST be recorded as lidAmerican. If the nFib is 0x0101 or greater, then any install lid with a base language of Vietnamese, Thai, or Hindi MUST be recorded as lidAmerican.. -
setLid
A LID that specifies the install language of the application that is producing the document. If nFib is 0x00D9 or greater, then any East Asian install lid or any install lid with a base language of Spanish, German or French MUST be recorded as lidAmerican. If the nFib is 0x0101 or greater, then any install lid with a base language of Vietnamese, Thai, or Hindi MUST be recorded as lidAmerican.. -
getPnNext
An unsigned integer that specifies the offset in the WordDocument stream of the FIB for the document which contains all the AutoText items. -
setPnNext
An unsigned integer that specifies the offset in the WordDocument stream of the FIB for the document which contains all the AutoText items. -
getFlags1
Get the flags1 field for the FibBase record. -
setFlags1
Set the flags1 field for the FibBase record. -
getNFibBack
This value SHOULD be 0x00BF. This value MUST be 0x00BF or 0x00C1. -
setNFibBack
This value SHOULD be 0x00BF. This value MUST be 0x00BF or 0x00C1. -
getLKey
If fEncryption is 1 and fObfuscation is 1, this value specifies the XOR obfuscation password verifier. If fEncryption is 1 and fObfuscation is 0, this value specifies the size of the EncryptionHeader that is stored at the beginning of the Table stream as described in Encryption and Obfuscation. Otherwise, this value MUST be 0. -
setLKey
If fEncryption is 1 and fObfuscation is 1, this value specifies the XOR obfuscation password verifier. If fEncryption is 1 and fObfuscation is 0, this value specifies the size of the EncryptionHeader that is stored at the beginning of the Table stream as described in Encryption and Obfuscation. Otherwise, this value MUST be 0. -
getEnvr
This value MUST be 0, and MUST be ignored. -
setEnvr
This value MUST be 0, and MUST be ignored. -
getFlags2
Get the flags2 field for the FibBase record. -
setFlags2
Set the flags2 field for the FibBase record. -
getChs
This value MUST be 0 and MUST be ignored. -
setChs
This value MUST be 0 and MUST be ignored. -
getChsTables
This value MUST be 0 and MUST be ignored. -
setChsTables
This value MUST be 0 and MUST be ignored. -
getFcMin
This value is undefined and MUST be ignored. -
setFcMin
This value is undefined and MUST be ignored. -
getFcMac
This value is undefined and MUST be ignored. -
setFcMac
This value is undefined and MUST be ignored. -
setFDot
Sets the fDot field value. Specifies whether this is a document template -
isFDot
Specifies whether this is a document template- Returns:
- the fDot field value.
-
setFGlsy
Sets the fGlsy field value. Specifies whether this is a document that contains only AutoText items -
isFGlsy
Specifies whether this is a document that contains only AutoText items- Returns:
- the fGlsy field value.
-
setFComplex
Sets the fComplex field value. Specifies that the last save operation that was performed on this document was an incremental save operation -
isFComplex
Specifies that the last save operation that was performed on this document was an incremental save operation- Returns:
- the fComplex field value.
-
setFHasPic
Sets the fHasPic field value. When set to 0, there SHOULD be no pictures in the document -
isFHasPic
When set to 0, there SHOULD be no pictures in the document- Returns:
- the fHasPic field value.
-
setCQuickSaves
Sets the cQuickSaves field value. An unsigned integer. If nFib is less than 0x00D9, then cQuickSaves specifies the number of consecutive times this document was incrementally saved. If nFib is 0x00D9 or greater, then cQuickSaves MUST be 0xF -
getCQuickSaves
An unsigned integer. If nFib is less than 0x00D9, then cQuickSaves specifies the number of consecutive times this document was incrementally saved. If nFib is 0x00D9 or greater, then cQuickSaves MUST be 0xF- Returns:
- the cQuickSaves field value.
-
setFEncrypted
Sets the fEncrypted field value. Specifies whether the document is encrypted or obfuscated as specified in Encryption and Obfuscation -
isFEncrypted
Specifies whether the document is encrypted or obfuscated as specified in Encryption and Obfuscation- Returns:
- the fEncrypted field value.
-
setFWhichTblStm
Sets the fWhichTblStm field value. Specifies the Table stream to which the FIB refers. When this value is set to 1, use 1Table; when this value is set to 0, use 0Table. -
isFWhichTblStm
Specifies the Table stream to which the FIB refers. When this value is set to 1, use 1Table; when this value is set to 0, use 0Table.- Returns:
- the fWhichTblStm field value.
-
setFReadOnlyRecommended
Sets the fReadOnlyRecommended field value. Specifies whether the document author recommended that the document be opened in read-only mode -
isFReadOnlyRecommended
Specifies whether the document author recommended that the document be opened in read-only mode- Returns:
- the fReadOnlyRecommended field value.
-
setFWriteReservation
Sets the fWriteReservation field value. Specifies whether the document has a write-reservation password -
isFWriteReservation
Specifies whether the document has a write-reservation password- Returns:
- the fWriteReservation field value.
-
setFExtChar
Sets the fExtChar field value. This value MUST be 1 -
isFExtChar
This value MUST be 1- Returns:
- the fExtChar field value.
-
setFLoadOverride
Sets the fLoadOverride field value. Specifies whether to override the language information and font that are specified in the paragraph style at istd 0 (the normal style) with the defaults that are appropriate for the installation language of the application -
isFLoadOverride
Specifies whether to override the language information and font that are specified in the paragraph style at istd 0 (the normal style) with the defaults that are appropriate for the installation language of the application- Returns:
- the fLoadOverride field value.
-
setFFarEast
Sets the fFarEast field value. Specifies whether the installation language of the application that created the document was an East Asian language -
isFFarEast
Specifies whether the installation language of the application that created the document was an East Asian language- Returns:
- the fFarEast field value.
-
setFObfuscated
Sets the fObfuscated field value. If fEncrypted is 1, this bit specifies whether the document is obfuscated by using XOR obfuscation; otherwise, this bit MUST be ignored -
isFObfuscated
If fEncrypted is 1, this bit specifies whether the document is obfuscated by using XOR obfuscation; otherwise, this bit MUST be ignored- Returns:
- the fObfuscated field value.
-
setFMac
Sets the fMac field value. This value MUST be 0, and MUST be ignored -
isFMac
Deprecated.This field should not be used according to specificationThis value MUST be 0, and MUST be ignored- Returns:
- the fMac field value.
-
setFEmptySpecial
Sets the fEmptySpecial field value. This value SHOULD be 0 and SHOULD be ignored -
isFEmptySpecial
Deprecated.This field should not be used according to specificationThis value SHOULD be 0 and SHOULD be ignored- Returns:
- the fEmptySpecial field value.
-
setFLoadOverridePage
Sets the fLoadOverridePage field value. Specifies whether to override the section properties for page size, orientation, and margins with the defaults that are appropriate for the installation language of the application -
isFLoadOverridePage
Specifies whether to override the section properties for page size, orientation, and margins with the defaults that are appropriate for the installation language of the application- Returns:
- the fLoadOverridePage field value.
-
setReserved1
Sets the reserved1 field value. This value is undefined and MUST be ignored -
isReserved1
Deprecated.This field should not be used according to specificationThis value is undefined and MUST be ignored- Returns:
- the reserved1 field value.
-
setReserved2
Sets the reserved2 field value. This value is undefined and MUST be ignored -
isReserved2
Deprecated.This field should not be used according to specificationThis value is undefined and MUST be ignored- Returns:
- the reserved2 field value.
-
setFSpare0
Sets the fSpare0 field value. This value is undefined and MUST be ignored -
getFSpare0
Deprecated.This field should not be used according to specificationThis value is undefined and MUST be ignored- Returns:
- the fSpare0 field value.
-