HWPFList (POI API Documentation)

java.lang.Object
- org.apache.poi.hwpf.usermodel.HWPFList

```
public final class HWPFList
extends java.lang.Object
```
This class is used to create a list in a Word document. It is used in conjunction with registerList in HWPFDocument. In Word, lists are not ranged entities, meaning you can't actually add one to the document. Lists only act as properties for list entries. Once you register a list, you can add list entries to a document that are a part of the list. The only benefit of this that I see, is that you can add a list entry anywhere in the document and continue numbering from the previous list. (此类用于在 Word 文档中创建列表。它与 HWPFDocument 中的 registerList 结合使用。在 Word 中，列表不是范围实体，这意味着您实际上无法在文档中添加一个。列表仅充当列表条目的属性。注册列表后，您可以将列表条目添加到作为列表一部分的文档中。我看到的唯一好处是，您可以在文档的任何位置添加一个列表条目，并从上一个列表继续编号。)

Author:

Ryan Ackley

Constructor Summary

Constructors
Constructor and Description
`HWPFList(boolean numbered, StyleSheet styleSheet)`
`HWPFList(StyleSheet styleSheet, ListTables listTables, int ilfo)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`LFO`	`getLFO()`
`LFOData`	`getLFOData()`
`ListData`	`getListData()`
`int`	`getLsid()`
`int`	`getNumberFormat(char level)` 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. (一个 MSONFC，如 [MS-OSHARED] 第 2.2.1.3 节中指定的，指定级别编号的格式，用于替换此列表中 LVL 的 xst 字段中此级别的占位符。)
`java.lang.String`	`getNumberText(char level)`
`int`	`getStartAt(char level)`
`byte`	`getTypeOfCharFollowingTheNumber(char level)` "The type of character following the number text for the paragraph: 0 == tab, 1 == space, 2 == nothing." (“段落数字文本后面的字符类型：0 == 制表符，1 == 空格，2 == 无。”)
`boolean`	`isIgnoreLogicalLeftIdentation()`
`boolean`	`isStartAtOverriden(char level)`
`void`	`setIgnoreLogicalLeftIdentation(boolean ignoreLogicalLeftIdentation)`
`void`	`setLevelNumberProperties(int level, CharacterProperties chp)` Sets the character properties of the list numbers. (设置列表编号的字符属性。)
`void`	`setLevelParagraphProperties(int level, ParagraphProperties pap)` Sets the paragraph properties for a particular level of the list. (为列表的特定级别设置段落属性。)
`void`	`setLevelStyle(int level, int styleIndex)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - HWPFList
```
public HWPFList(boolean numbered,
                StyleSheet styleSheet)
```
    Parameters:
    
    numbered - true if the list should be numbered; false if it should be bulleted. (numbered - 如果列表应该被编号，则为 true；如果它应该是项目符号，则为 false。)
    
    styleSheet - The document's stylesheet. (styleSheet - 文档的样式表。)
  - HWPFList
```
public HWPFList(StyleSheet styleSheet,
                ListTables listTables,
                int ilfo)
```
- Method Detail
  - getLFO
```
@Internal
public LFO getLFO()
```
  - getLFOData
```
@Internal
public LFOData getLFOData()
```
  - getListData
```
@Internal
public ListData getListData()
```
  - getLsid
```
public int getLsid()
```
  - getNumberFormat
```
public int getNumberFormat(char level)
```
    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. (一个 MSONFC，如 [MS-OSHARED] 第 2.2.1.3 节中指定的，指定级别编号的格式，用于替换此列表中 LVL 的 xst 字段中此级别的占位符。此值不得等于 0x08、0x09、0x0F 或 0x13。如果这等于 0xFF 或 0x17，则此级别没有数字序列，因此没有数字格式。如果这等于 0x17，则该级别使用项目符号。)
  - getNumberText
```
public java.lang.String getNumberText(char level)
```
  - getStartAt
```
public int getStartAt(char level)
```
  - getTypeOfCharFollowingTheNumber
```
public byte getTypeOfCharFollowingTheNumber(char level)
```
    "The type of character following the number text for the paragraph: 0 == tab, 1 == space, 2 == nothing." (“段落数字文本后面的字符类型：0 == 制表符，1 == 空格，2 == 无。”)
  - isIgnoreLogicalLeftIdentation
```
public boolean isIgnoreLogicalLeftIdentation()
```
  - isStartAtOverriden
```
public boolean isStartAtOverriden(char level)
```
  - setIgnoreLogicalLeftIdentation
```
public void setIgnoreLogicalLeftIdentation(boolean ignoreLogicalLeftIdentation)
```
  - setLevelNumberProperties
```
public void setLevelNumberProperties(int level,
                                     CharacterProperties chp)
```
    Sets the character properties of the list numbers. (设置列表编号的字符属性。)
    
    Parameters:
    
    level - the level number that the properties should apply to. (level - 属性应该应用到的级别编号。)
    
    chp - The character properties. (chp - 字符属性。)
  - setLevelParagraphProperties
```
public void setLevelParagraphProperties(int level,
                                        ParagraphProperties pap)
```
    Sets the paragraph properties for a particular level of the list. (为列表的特定级别设置段落属性。)
    
    Parameters:
    
    level - The level number. (级别 - 级别编号。)
    
    pap - The paragraph properties (pap - 段落属性)
  - setLevelStyle
```
public void setLevelStyle(int level,
                          int styleIndex)
```

Class HWPFList

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

HWPFList

HWPFList

Method Detail

getLFO

getLFOData

getListData

getLsid

getNumberFormat

getNumberText

getStartAt

getTypeOfCharFollowingTheNumber

isIgnoreLogicalLeftIdentation

isStartAtOverriden

setIgnoreLogicalLeftIdentation

setLevelNumberProperties

setLevelParagraphProperties

setLevelStyle