Package org.apache.poi.hwpf.model.types

Class LVLFAbstractType

  • @Internal
public abstract class LVLFAbstractType
extends Object
    The LVLF structure contains formatting properties for an individual level in a list.

    • Constructor Summary

      Constructors 
      Modifier Constructor Description
      protected LVLFAbstractType()  

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods 
      Modifier and Type Method Description
      boolean equals​(Object obj)  
      protected void fillFields​(byte[] data, int offset)  
      short getCbGrpprlChpx()
      An unsigned integer that specifies the size, in bytes, of the grpprlChpx in the LVL that contains this LVLF.
      short getCbGrpprlPapx()
      An unsigned integer that specifies the size, in bytes, of the grpprlPapx in the LVL that contains this LVLF.
      int getDxaIndentSav()
      If fIndentSav is nonzero, this is a signed integer that specifies the size, in twips, of the indent that needs to be removed when the numbering is removed.
      Grfhic getGrfhic()
      A grfhic that specifies the HTML incompatibilities of the level..
      short getIlvlRestartLim()
      An unsigned integer that specifies the first (most-significant) zero-based level after which the number sequence of this level does not restart.
      byte getInfo()
      Get the info field for the LVLF record.
      int getIStartAt()
      A signed integer that specifies the beginning number for the number sequence belonging to this level.
      byte getIxchFollow()
      An unsigned integer that specifies the character that follows the number text.
      byte getJc()
      An unsigned integer that specifies the justification of this level
      byte getNfc()
      An MSONFC, as specified in [MS-OSHARED] section 2.2.1.3, that specifies the format of the level numbers that replace the placeholders for this level in the xst fields of the LVLs in this list.
      byte[] getRgbxchNums()
      An array of 8-bit integers.
      static int getSize()
      Size of record
      int getUnused2()
      This field MUST be ignored.
      int hashCode()  
      boolean isFConverted()
      A bit that specifies whether the nfc of this LVLF structure was previously a temporary value used for bidirectional compatibility that was converted into a standard MSONFC
      boolean isFIndentSav()
      A bit that specifies whether the level indented the text it was applied to and that the indent needs to be removed when numbering is removed.
      boolean isFLegal()
      A bit that specifies whether this level overrides the nfc of all inherited level numbers.
      boolean isFNoRestart()
      A bit that specifies whether the number sequence of the level does not restart after a level is encountered that is more significant than the level to which this LVLF corresponds
      boolean isFTentative()
      A bit that specifies whether the format of the level is tentative
      boolean isUnused1()
      Deprecated.
      This field should not be used according to specification
      byte[] serialize()  
      void serialize​(byte[] data, int offset)  
      void setCbGrpprlChpx​(short field_8_cbGrpprlChpx)
      An unsigned integer that specifies the size, in bytes, of the grpprlChpx in the LVL that contains this LVLF.
      void setCbGrpprlPapx​(short field_9_cbGrpprlPapx)
      An unsigned integer that specifies the size, in bytes, of the grpprlPapx in the LVL that contains this LVLF.
      void setDxaIndentSav​(int field_6_dxaIndentSav)
      If fIndentSav is nonzero, this is a signed integer that specifies the size, in twips, of the indent that needs to be removed when the numbering is removed.
      void setFConverted​(boolean value)
      Sets the fConverted field value.
      void setFIndentSav​(boolean value)
      Sets the fIndentSav field value.
      void setFLegal​(boolean value)
      Sets the fLegal field value.
      void setFNoRestart​(boolean value)
      Sets the fNoRestart field value.
      void setFTentative​(boolean value)
      Sets the fTentative field value.
      void setGrfhic​(Grfhic field_11_grfhic)
      A grfhic that specifies the HTML incompatibilities of the level..
      void setIlvlRestartLim​(short field_10_ilvlRestartLim)
      An unsigned integer that specifies the first (most-significant) zero-based level after which the number sequence of this level does not restart.
      void setInfo​(byte field_3_info)
      Set the info field for the LVLF record.
      void setIStartAt​(int field_1_iStartAt)
      A signed integer that specifies the beginning number for the number sequence belonging to this level.
      void setIxchFollow​(byte field_5_ixchFollow)
      An unsigned integer that specifies the character that follows the number text.
      void setJc​(byte value)
      Sets the jc field value.
      void setNfc​(byte field_2_nfc)
      An MSONFC, as specified in [MS-OSHARED] section 2.2.1.3, that specifies the format of the level numbers that replace the placeholders for this level in the xst fields of the LVLs in this list.
      void setRgbxchNums​(byte[] field_4_rgbxchNums)
      An array of 8-bit integers.
      void setUnused1​(boolean value)
      Sets the unused1 field value.
      void setUnused2​(int field_7_unused2)
      This field MUST be ignored.
      String toString()  

    • Field Detail

      • field_1_iStartAt

        protected int field_1_iStartAt

      • field_2_nfc

        protected byte field_2_nfc

      • field_3_info

        protected byte field_3_info

      • field_4_rgbxchNums

        protected byte[] field_4_rgbxchNums

      • field_5_ixchFollow

        protected byte field_5_ixchFollow

      • field_6_dxaIndentSav

        protected int field_6_dxaIndentSav

      • field_7_unused2

        protected int field_7_unused2

      • field_8_cbGrpprlChpx

        protected short field_8_cbGrpprlChpx

      • field_9_cbGrpprlPapx

        protected short field_9_cbGrpprlPapx

      • field_10_ilvlRestartLim

        protected short field_10_ilvlRestartLim

      • field_11_grfhic

        protected Grfhic field_11_grfhic

    • Constructor Detail

      • LVLFAbstractType

        protected LVLFAbstractType()

    • Method Detail

      • 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

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object

      • getIStartAt

        @Internal
public int getIStartAt()
        A signed integer that specifies the beginning number for the number sequence belonging to this level. This value MUST be less than or equal to 0x7FFF and MUST be greater than or equal to zero. If this level does not have a number sequence (see nfc), this MUST be ignored.

      • setIStartAt

        @Internal
public void setIStartAt​(int field_1_iStartAt)
        A signed integer that specifies the beginning number for the number sequence belonging to this level. This value MUST be less than or equal to 0x7FFF and MUST be greater than or equal to zero. If this level does not have a number sequence (see nfc), this MUST be ignored.

      • getNfc

        @Internal
public byte getNfc()
        An MSONFC, as specified in [MS-OSHARED] section 2.2.1.3, that specifies the format of the level numbers that replace the placeholders for this level in the xst fields of the LVLs in this list. This value MUST not be equal to 0x08, 0x09, 0x0F, or 0x13. If this is equal to 0xFF or 0x17, this level does not have a number sequence and therefore has no number formatting. If this is equal to 0x17, the level uses bullets.

      • setNfc

        @Internal
public void setNfc​(byte field_2_nfc)
        An MSONFC, as specified in [MS-OSHARED] section 2.2.1.3, that specifies the format of the level numbers that replace the placeholders for this level in the xst fields of the LVLs in this list. This value MUST not be equal to 0x08, 0x09, 0x0F, or 0x13. If this is equal to 0xFF or 0x17, this level does not have a number sequence and therefore has no number formatting. If this is equal to 0x17, the level uses bullets.

      • getInfo

        @Internal
public byte getInfo()
        Get the info field for the LVLF record.

      • setInfo

        @Internal
public void setInfo​(byte field_3_info)
        Set the info field for the LVLF record.

      • getRgbxchNums

        @Internal
public byte[] getRgbxchNums()
        An array of 8-bit integers. Each integer specifies a one-based character offset to a level placeholder in the xst.rgtchar of the LVL that contains this LVLF. This array is zero-terminated, unless it is full. The count of elements in this array, before to the first terminating zero, MUST be less than or equal to the one-based level of the list to which this LVL corresponds. The integers in this array, before the first terminating zero, MUST be in ascending order, and MUST be unique.

      • setRgbxchNums

        @Internal
public void setRgbxchNums​(byte[] field_4_rgbxchNums)
        An array of 8-bit integers. Each integer specifies a one-based character offset to a level placeholder in the xst.rgtchar of the LVL that contains this LVLF. This array is zero-terminated, unless it is full. The count of elements in this array, before to the first terminating zero, MUST be less than or equal to the one-based level of the list to which this LVL corresponds. The integers in this array, before the first terminating zero, MUST be in ascending order, and MUST be unique.

      • getIxchFollow

        @Internal
public byte getIxchFollow()
        An unsigned integer that specifies the character that follows the number text.

      • setIxchFollow

        @Internal
public void setIxchFollow​(byte field_5_ixchFollow)
        An unsigned integer that specifies the character that follows the number text.

      • getDxaIndentSav

        @Internal
public int getDxaIndentSav()
        If fIndentSav is nonzero, this is a signed integer that specifies the size, in twips, of the indent that needs to be removed when the numbering is removed. This MUST be less than or equal to 0x00007BC0 or greater than or equal to 0xFFFF8440. If fIndentSav is zero, this MUST be ignored.

      • setDxaIndentSav

        @Internal
public void setDxaIndentSav​(int field_6_dxaIndentSav)
        If fIndentSav is nonzero, this is a signed integer that specifies the size, in twips, of the indent that needs to be removed when the numbering is removed. This MUST be less than or equal to 0x00007BC0 or greater than or equal to 0xFFFF8440. If fIndentSav is zero, this MUST be ignored.

      • getUnused2

        @Internal
public int getUnused2()
        This field MUST be ignored.

      • setUnused2

        @Internal
public void setUnused2​(int field_7_unused2)
        This field MUST be ignored.

      • getCbGrpprlChpx

        @Internal
public short getCbGrpprlChpx()
        An unsigned integer that specifies the size, in bytes, of the grpprlChpx in the LVL that contains this LVLF.

      • setCbGrpprlChpx

        @Internal
public void setCbGrpprlChpx​(short field_8_cbGrpprlChpx)
        An unsigned integer that specifies the size, in bytes, of the grpprlChpx in the LVL that contains this LVLF.

      • getCbGrpprlPapx

        @Internal
public short getCbGrpprlPapx()
        An unsigned integer that specifies the size, in bytes, of the grpprlPapx in the LVL that contains this LVLF.

      • setCbGrpprlPapx

        @Internal
public void setCbGrpprlPapx​(short field_9_cbGrpprlPapx)
        An unsigned integer that specifies the size, in bytes, of the grpprlPapx in the LVL that contains this LVLF.

      • getIlvlRestartLim

        @Internal
public short getIlvlRestartLim()
        An unsigned integer that specifies the first (most-significant) zero-based level after which the number sequence of this level does not restart. The number sequence of this level does restart after any level that is more significant than the specified level. This MUST be less than or equal to the zero-based level of the list to which this LVLF corresponds. If fNoRestart is zero, this MUST be ignored. If this level does not have a number sequence (see nfc), this MUST be ignored.

      • setIlvlRestartLim

        @Internal
public void setIlvlRestartLim​(short field_10_ilvlRestartLim)
        An unsigned integer that specifies the first (most-significant) zero-based level after which the number sequence of this level does not restart. The number sequence of this level does restart after any level that is more significant than the specified level. This MUST be less than or equal to the zero-based level of the list to which this LVLF corresponds. If fNoRestart is zero, this MUST be ignored. If this level does not have a number sequence (see nfc), this MUST be ignored.

      • getGrfhic

        @Internal
public Grfhic getGrfhic()
        A grfhic that specifies the HTML incompatibilities of the level..

      • setGrfhic

        @Internal
public void setGrfhic​(Grfhic field_11_grfhic)
        A grfhic that specifies the HTML incompatibilities of the level..

      • setJc

        @Internal
public void setJc​(byte value)
        Sets the jc field value. An unsigned integer that specifies the justification of this level

      • getJc

        @Internal
public byte getJc()
        An unsigned integer that specifies the justification of this level
        Returns:
        the jc field value.

      • setFLegal

        @Internal
public void setFLegal​(boolean value)
        Sets the fLegal field value. A bit that specifies whether this level overrides the nfc of all inherited level numbers. If the original nfc of a level number is msonfcArabicLZ, it is preserved. Otherwise, the nfc of the level number is overridden by msonfcArabic.

      • isFLegal

        @Internal
public boolean isFLegal()
        A bit that specifies whether this level overrides the nfc of all inherited level numbers. If the original nfc of a level number is msonfcArabicLZ, it is preserved. Otherwise, the nfc of the level number is overridden by msonfcArabic.
        Returns:
        the fLegal field value.

      • setFNoRestart

        @Internal
public void setFNoRestart​(boolean value)
        Sets the fNoRestart field value. A bit that specifies whether the number sequence of the level does not restart after a level is encountered that is more significant than the level to which this LVLF corresponds

      • isFNoRestart

        @Internal
public boolean isFNoRestart()
        A bit that specifies whether the number sequence of the level does not restart after a level is encountered that is more significant than the level to which this LVLF corresponds
        Returns:
        the fNoRestart field value.

      • setFIndentSav

        @Internal
public void setFIndentSav​(boolean value)
        Sets the fIndentSav field value. A bit that specifies whether the level indented the text it was applied to and that the indent needs to be removed when numbering is removed. The indent to be removed is stored in dxaIndentSav

      • isFIndentSav

        @Internal
public boolean isFIndentSav()
        A bit that specifies whether the level indented the text it was applied to and that the indent needs to be removed when numbering is removed. The indent to be removed is stored in dxaIndentSav
        Returns:
        the fIndentSav field value.

      • setFConverted

        @Internal
public void setFConverted​(boolean value)
        Sets the fConverted field value. A bit that specifies whether the nfc of this LVLF structure was previously a temporary value used for bidirectional compatibility that was converted into a standard MSONFC

      • isFConverted

        @Internal
public boolean isFConverted()
        A bit that specifies whether the nfc of this LVLF structure was previously a temporary value used for bidirectional compatibility that was converted into a standard MSONFC
        Returns:
        the fConverted field value.

      • setUnused1

        @Internal
public void setUnused1​(boolean value)
        Sets the unused1 field value. This bit MUST be ignored

      • isUnused1

        @Internal
@Deprecated
public boolean isUnused1()
        Deprecated.
        This field should not be used according to specification
        This bit MUST be ignored
        Returns:
        the unused1 field value.

      • setFTentative

        @Internal
public void setFTentative​(boolean value)
        Sets the fTentative field value. A bit that specifies whether the format of the level is tentative

      • isFTentative

        @Internal
public boolean isFTentative()
        A bit that specifies whether the format of the level is tentative
        Returns:
        the fTentative field value.