Package org.apache.poi.hwpf.model.types
Class LSTFAbstractType
java.lang.Object
org.apache.poi.hwpf.model.types.LSTFAbstractType
The LSTF structure contains formatting properties that apply to an entire list.
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 intprotected intprotected short[]protected byteprotected Grfhic -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionbooleanprotected voidfillFields(byte[] data, int offset) bytegetFlags()Get the flags field for the LSTF record.A grfhic that specifies the HTML incompatibilities of the list..intgetLsid()A signed integer that specifies the list identifier.byteDeprecated.This field should not be used according to specificationshort[]An array of nine 16-bit signed integers.static intgetSize()Size of recordintgetTplc()A Tplc that specifies a unique identifier for this LSTF that MAY be used for user interface purposes.inthashCode()booleanA bit that specifies whether the list that this LSTF represents is used for the AUTONUMOUT, AUTONUMLGL, and AUTONUM fields (see AUTONUMOUT, AUTONUMLGL, and AUTONUM in flt)booleanA bit that specifies whether the list this LSTF defines is a hybrid listbooleanA bit that, when set to 0x1, specifies that this LSTF represents a simple (one-level) list that has one corresponding LVL (see the fcPlfLst field of FibRgFcLcb97).booleanDeprecated.This field should not be used according to specificationbooleanDeprecated.This field should not be used according to specificationbyte[]voidserialize(byte[] data, int offset) voidsetFAutoNum(boolean value) Sets the fAutoNum field value.voidsetFHybrid(boolean value) Sets the fHybrid field value.voidsetFlags(byte field_4_flags) Set the flags field for the LSTF record.voidsetFSimpleList(boolean value) Sets the fSimpleList field value.voidA grfhic that specifies the HTML incompatibilities of the list..voidsetLsid(int field_1_lsid) A signed integer that specifies the list identifier.voidsetReserved1(byte value) Sets the reserved1 field value.voidsetRgistdPara(short[] field_3_rgistdPara) An array of nine 16-bit signed integers.voidsetTplc(int field_2_tplc) A Tplc that specifies a unique identifier for this LSTF that MAY be used for user interface purposes.voidsetUnused1(boolean value) Sets the unused1 field value.voidsetUnused2(boolean value) Sets the unused2 field value.toString()
-
Field Details
-
field_1_lsid
protected int field_1_lsid -
field_2_tplc
protected int field_2_tplc -
field_3_rgistdPara
protected short[] field_3_rgistdPara -
field_4_flags
protected byte field_4_flags -
field_5_grfhic
-
-
Constructor Details
-
LSTFAbstractType
protected LSTFAbstractType()
-
-
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 -
equals
-
hashCode
public int hashCode() -
toString
-
getLsid
A signed integer that specifies the list identifier. This MUST be unique for each LSTF. This value MUST not be 0xFFFFFFFF. -
setLsid
A signed integer that specifies the list identifier. This MUST be unique for each LSTF. This value MUST not be 0xFFFFFFFF. -
getTplc
A Tplc that specifies a unique identifier for this LSTF that MAY be used for user interface purposes. If fHybrid is nonzero, this MUST be ignored. -
setTplc
A Tplc that specifies a unique identifier for this LSTF that MAY be used for user interface purposes. If fHybrid is nonzero, this MUST be ignored. -
getRgistdPara
An array of nine 16-bit signed integers. Each element of rgistdPara specifies the ISTD of the style that is linked to the corresponding level in the list. If no style is linked to a given level, the value of the corresponding element of rgistdPara MUST be 0x0FFF. -
setRgistdPara
An array of nine 16-bit signed integers. Each element of rgistdPara specifies the ISTD of the style that is linked to the corresponding level in the list. If no style is linked to a given level, the value of the corresponding element of rgistdPara MUST be 0x0FFF. -
getFlags
Get the flags field for the LSTF record. -
setFlags
Set the flags field for the LSTF record. -
getGrfhic
A grfhic that specifies the HTML incompatibilities of the list.. -
setGrfhic
A grfhic that specifies the HTML incompatibilities of the list.. -
setFSimpleList
Sets the fSimpleList field value. A bit that, when set to 0x1, specifies that this LSTF represents a simple (one-level) list that has one corresponding LVL (see the fcPlfLst field of FibRgFcLcb97). Otherwise, this LSTF represents a multi-level list that has nine corresponding LVLs -
isFSimpleList
A bit that, when set to 0x1, specifies that this LSTF represents a simple (one-level) list that has one corresponding LVL (see the fcPlfLst field of FibRgFcLcb97). Otherwise, this LSTF represents a multi-level list that has nine corresponding LVLs- Returns:
- the fSimpleList field value.
-
setUnused1
Sets the unused1 field value. This bit MUST be ignored -
isUnused1
Deprecated.This field should not be used according to specificationThis bit MUST be ignored- Returns:
- the unused1 field value.
-
setFAutoNum
Sets the fAutoNum field value. A bit that specifies whether the list that this LSTF represents is used for the AUTONUMOUT, AUTONUMLGL, and AUTONUM fields (see AUTONUMOUT, AUTONUMLGL, and AUTONUM in flt) -
isFAutoNum
A bit that specifies whether the list that this LSTF represents is used for the AUTONUMOUT, AUTONUMLGL, and AUTONUM fields (see AUTONUMOUT, AUTONUMLGL, and AUTONUM in flt)- Returns:
- the fAutoNum field value.
-
setUnused2
Sets the unused2 field value. This bit MUST be ignored -
isUnused2
Deprecated.This field should not be used according to specificationThis bit MUST be ignored- Returns:
- the unused2 field value.
-
setFHybrid
Sets the fHybrid field value. A bit that specifies whether the list this LSTF defines is a hybrid list -
isFHybrid
A bit that specifies whether the list this LSTF defines is a hybrid list- Returns:
- the fHybrid field value.
-
setReserved1
Sets the reserved1 field value. This MUST be zero, and MUST be ignored. -
getReserved1
Deprecated.This field should not be used according to specificationThis MUST be zero, and MUST be ignored.- Returns:
- the reserved1 field value.
-