Package org.apache.poi.hwpf.model.types
Class StdfBaseAbstractType
java.lang.Object
org.apache.poi.hwpf.model.types.StdfBaseAbstractType
The StdfBase structure specifies general information about a style.
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:
- 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 shortprotected shortprotected shortprotected intprotected short -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionprotected voidfillFields(byte[] data, int offset) intAn unsigned integer that specifies the size, in bytes, of std in LPStd.bytegetCupx()number of UPXs (and UPEs)byteThis value MUST be 0 and MUST be ignoredshortA GRFSTD that specifies miscellaneous style properties.shortgetInfo1()Get the info1 field for the StdfBase record.shortgetInfo2()Get the info2 field for the StdfBase record.shortgetInfo3()Get the info3 field for the StdfBase record.shortbase styleshortnext stylestatic intgetSize()Size of recordshortgetSti()An unsigned integer that specifies the invariant style identifier for application-defined styles, or 0x0FFE for user-defined stylesbytegetStk()style kindbooleanSpecifies whether sprmCRgLid0_80 and sprmCRgLid1_80 were applied, as appropriate, to this paragraph or character style for compatibility with applications that do not support sprmCRgLid0, sprmCRgLid1, and sprmCFNoProofbooleannumber of UPXs (and UPEs)booleanIf f97LidsSet is 1, this value specifies whether the applied compatibility sprmCRgLid0_80 or sprmCRgLid1_80 specified an actual language or a special LID value (0x0400) signifying that no proofing is needed for the text.booleanThis bit is undefined and MUST be ignoredbooleanSpecifies whether this style is not shown in the application UIbooleanThis bit is undefined and MUST be ignoredbooleanSpecifies whether the paragraph height information in the fcPlcfPhe field of FibRgFcLcb97, for any paragraphs having this paragraph style, MUST be ignored.booleanSpecifies whether this style is prevented from being applied by using the application UIbooleanThis bit is undefined and MUST be ignoredbooleanThis value MUST be 0 and MUST be ignoredbooleanSpecifies whether this character style was applied to format all message text from one or more users in an e-mailbooleanSpecifies whether this character style can be used to automatically format the new message text in a new e-mailbooleanSpecifies whether this character style can be used to automatically format the new message text when replying to an e-mailbooleanSpecifies whether this style is shown in the Ribbon Style gallerybooleanspare field for any temporary use, always reset back to zero!booleanSpecifies whether this style is not shown in the simplified main styles UI of the applicationbooleanSpecifies whether the fSemiHidden property is to be set to 0 when this style is usedvoidserialize(byte[] data, int offset) voidsetBchUpe(int field_4_bchUpe) An unsigned integer that specifies the size, in bytes, of std in LPStd.voidsetCupx(byte value) Sets the cupx field value.voidsetF97LidsSet(boolean value) Sets the f97LidsSet field value.voidsetFAutoRedef(boolean value) Sets the fAutoRedef field value.voidsetFCopyLang(boolean value) Sets the fCopyLang field value.voidsetFHasUpe(boolean value) Sets the fHasUpe field value.voidsetFHidden(boolean value) Sets the fHidden field value.voidsetFInternalUse(boolean value) Sets the fInternalUse field value.voidsetFInvalHeight(boolean value) Sets the fInvalHeight field value.voidsetFLocked(boolean value) Sets the fLocked field value.voidsetFMassCopy(boolean value) Sets the fMassCopy field value.voidsetFNoHtmlExport(boolean value) Sets the fNoHtmlExport field value.voidsetFPersonal(boolean value) Sets the fPersonal field value.voidsetFPersonalCompose(boolean value) Sets the fPersonalCompose field value.voidsetFPersonalReply(boolean value) Sets the fPersonalReply field value.voidsetFQFormat(boolean value) Sets the fQFormat field value.voidsetFReserved(byte value) Sets the fReserved field value.voidsetFScratch(boolean value) Sets the fScratch field value.voidsetFSemiHidden(boolean value) Sets the fSemiHidden field value.voidsetFUnhideWhenUsed(boolean value) Sets the fUnhideWhenUsed field value.voidsetGrfstd(short field_5_grfstd) A GRFSTD that specifies miscellaneous style properties.voidsetInfo1(short field_1_info1) Set the info1 field for the StdfBase record.voidsetInfo2(short field_2_info2) Set the info2 field for the StdfBase record.voidsetInfo3(short field_3_info3) Set the info3 field for the StdfBase record.voidsetIstdBase(short value) Sets the istdBase field value.voidsetIstdNext(short value) Sets the istdNext field value.voidsetSti(short value) Sets the sti field value.voidsetStk(byte value) Sets the stk field value.toString()
-
Field Details
-
field_1_info1
protected short field_1_info1 -
field_2_info2
protected short field_2_info2 -
field_3_info3
protected short field_3_info3 -
field_4_bchUpe
protected int field_4_bchUpe -
field_5_grfstd
protected short field_5_grfstd
-
-
Constructor Details
-
StdfBaseAbstractType
protected StdfBaseAbstractType()
-
-
Method Details
-
fillFields
protected void fillFields(byte[] data, int offset) -
serialize
public void serialize(byte[] data, int offset) -
getSize
public static int getSize()Size of record -
toString
-
getInfo1
Get the info1 field for the StdfBase record. -
setInfo1
Set the info1 field for the StdfBase record. -
getInfo2
Get the info2 field for the StdfBase record. -
setInfo2
Set the info2 field for the StdfBase record. -
getInfo3
Get the info3 field for the StdfBase record. -
setInfo3
Set the info3 field for the StdfBase record. -
getBchUpe
An unsigned integer that specifies the size, in bytes, of std in LPStd. This value MUST be equal to cbStd in LPStd. -
setBchUpe
An unsigned integer that specifies the size, in bytes, of std in LPStd. This value MUST be equal to cbStd in LPStd. -
getGrfstd
A GRFSTD that specifies miscellaneous style properties. -
setGrfstd
A GRFSTD that specifies miscellaneous style properties. -
setSti
Sets the sti field value. An unsigned integer that specifies the invariant style identifier for application-defined styles, or 0x0FFE for user-defined styles -
getSti
An unsigned integer that specifies the invariant style identifier for application-defined styles, or 0x0FFE for user-defined styles- Returns:
- the sti field value.
-
setFScratch
Sets the fScratch field value. spare field for any temporary use, always reset back to zero! -
isFScratch
spare field for any temporary use, always reset back to zero!- Returns:
- the fScratch field value.
-
setFInvalHeight
Sets the fInvalHeight field value. Specifies whether the paragraph height information in the fcPlcfPhe field of FibRgFcLcb97, for any paragraphs having this paragraph style, MUST be ignored. SHOULD be 0 -
isFInvalHeight
Specifies whether the paragraph height information in the fcPlcfPhe field of FibRgFcLcb97, for any paragraphs having this paragraph style, MUST be ignored. SHOULD be 0- Returns:
- the fInvalHeight field value.
-
setFHasUpe
Sets the fHasUpe field value. This bit is undefined and MUST be ignored -
isFHasUpe
This bit is undefined and MUST be ignored- Returns:
- the fHasUpe field value.
-
setFMassCopy
Sets the fMassCopy field value. This bit is undefined and MUST be ignored -
isFMassCopy
This bit is undefined and MUST be ignored- Returns:
- the fMassCopy field value.
-
setStk
Sets the stk field value. style kind -
getStk
style kind- Returns:
- the stk field value.
-
setIstdBase
Sets the istdBase field value. base style -
getIstdBase
base style- Returns:
- the istdBase field value.
-
setCupx
Sets the cupx field value. number of UPXs (and UPEs) -
getCupx
number of UPXs (and UPEs)- Returns:
- the cupx field value.
-
setIstdNext
Sets the istdNext field value. next style -
getIstdNext
next style- Returns:
- the istdNext field value.
-
setFAutoRedef
Sets the fAutoRedef field value. number of UPXs (and UPEs) -
isFAutoRedef
number of UPXs (and UPEs)- Returns:
- the fAutoRedef field value.
-
setFHidden
Sets the fHidden field value. Specifies whether this style is not shown in the application UI -
isFHidden
Specifies whether this style is not shown in the application UI- Returns:
- the fHidden field value.
-
setF97LidsSet
Sets the f97LidsSet field value. Specifies whether sprmCRgLid0_80 and sprmCRgLid1_80 were applied, as appropriate, to this paragraph or character style for compatibility with applications that do not support sprmCRgLid0, sprmCRgLid1, and sprmCFNoProof -
isF97LidsSet
Specifies whether sprmCRgLid0_80 and sprmCRgLid1_80 were applied, as appropriate, to this paragraph or character style for compatibility with applications that do not support sprmCRgLid0, sprmCRgLid1, and sprmCFNoProof- Returns:
- the f97LidsSet field value.
-
setFCopyLang
Sets the fCopyLang field value. If f97LidsSet is 1, this value specifies whether the applied compatibility sprmCRgLid0_80 or sprmCRgLid1_80 specified an actual language or a special LID value (0x0400) signifying that no proofing is needed for the text. This MUST be ignored if f97LidsSet is 0 -
isFCopyLang
If f97LidsSet is 1, this value specifies whether the applied compatibility sprmCRgLid0_80 or sprmCRgLid1_80 specified an actual language or a special LID value (0x0400) signifying that no proofing is needed for the text. This MUST be ignored if f97LidsSet is 0- Returns:
- the fCopyLang field value.
-
setFPersonalCompose
Sets the fPersonalCompose field value. Specifies whether this character style can be used to automatically format the new message text in a new e-mail -
isFPersonalCompose
Specifies whether this character style can be used to automatically format the new message text in a new e-mail- Returns:
- the fPersonalCompose field value.
-
setFPersonalReply
Sets the fPersonalReply field value. Specifies whether this character style can be used to automatically format the new message text when replying to an e-mail -
isFPersonalReply
Specifies whether this character style can be used to automatically format the new message text when replying to an e-mail- Returns:
- the fPersonalReply field value.
-
setFPersonal
Sets the fPersonal field value. Specifies whether this character style was applied to format all message text from one or more users in an e-mail -
isFPersonal
Specifies whether this character style was applied to format all message text from one or more users in an e-mail- Returns:
- the fPersonal field value.
-
setFNoHtmlExport
Sets the fNoHtmlExport field value. This value MUST be 0 and MUST be ignored -
isFNoHtmlExport
This value MUST be 0 and MUST be ignored- Returns:
- the fNoHtmlExport field value.
-
setFSemiHidden
Sets the fSemiHidden field value. Specifies whether this style is not shown in the simplified main styles UI of the application -
isFSemiHidden
Specifies whether this style is not shown in the simplified main styles UI of the application- Returns:
- the fSemiHidden field value.
-
setFLocked
Sets the fLocked field value. Specifies whether this style is prevented from being applied by using the application UI -
isFLocked
Specifies whether this style is prevented from being applied by using the application UI- Returns:
- the fLocked field value.
-
setFInternalUse
Sets the fInternalUse field value. This bit is undefined and MUST be ignored -
isFInternalUse
This bit is undefined and MUST be ignored- Returns:
- the fInternalUse field value.
-
setFUnhideWhenUsed
Sets the fUnhideWhenUsed field value. Specifies whether the fSemiHidden property is to be set to 0 when this style is used -
isFUnhideWhenUsed
Specifies whether the fSemiHidden property is to be set to 0 when this style is used- Returns:
- the fUnhideWhenUsed field value.
-
setFQFormat
Sets the fQFormat field value. Specifies whether this style is shown in the Ribbon Style gallery -
isFQFormat
Specifies whether this style is shown in the Ribbon Style gallery- Returns:
- the fQFormat field value.
-
setFReserved
Sets the fReserved field value. This value MUST be 0 and MUST be ignored -
getFReserved
This value MUST be 0 and MUST be ignored- Returns:
- the fReserved field value.
-