ListCollection

Наследование: java.lang.Object

Все реализованные интерфейсы: java.lang.Cloneable, java.lang.Iterable

public class ListCollection implements Cloneable, Iterable

Хранит и управляет форматированием маркированных и нумерованных списков, используемых в документе.

Чтобы узнать больше, посетитеWorking with Lists документальная статья.

Список в документе Microsoft Word представляет собой набор свойств форматирования списка. Форматирование списков сохраняется вListCollection сбор отдельно от абзацев текста.

Вы не создаете объекты этого класса. Всегда есть только одинListCollection объекта для каждого документа, и он доступен черезDocumentBase.getLists() имущество.

Чтобы создать новый список на основе предопределенного шаблона списка или на основе стиля списка, используйте кнопкуadd(com.aspose.words.Style) метод.

Чтобы создать новый список с форматированием, идентичным существующему списку, используйтеaddCopy(com.aspose.words.List) метод.

Чтобы сделать абзац маркированным или пронумерованным, необходимо применить форматирование списка к абзацу, назначивList возражать противListFormat.getList() / ListFormat.setList(com.aspose.words.List) свойствоListFormat.

Чтобы удалить форматирование списка из абзаца, используйтеListFormat.removeNumbers() метод.

Если вы немного знакомы с WordprocessingML, то, возможно, знаете, что он определяет отдельные понятия для «списка» и «определения списка». Это точно соответствует тому, как форматирование списка хранится в документе Microsoft Word на низком уровне. Определение списка похоже на «схему», а список — на экземпляр определения списка.

Чтобы упростить модель программирования, Aspose.Words скрывает различие между списком и определением списка почти так же, как Microsoft Word скрывает это в своем пользовательском интерфейсе. Это позволяет вам больше сосредоточиться на том, как должен выглядеть ваш документ, а не на создании низкоуровневых объектов для удовлетворения требований формата файла Microsoft Word.

Невозможно удалить списки после их создания в текущей версии Aspose.Words. Это похоже на Microsoft Word, где пользователь не имеет явного контроля над определениями списков.

Методы

Метод	Описание
add(Style listStyle)	Создает новый список, который ссылается на стиль списка, и добавляет его в коллекцию списков в документе.
add(int listTemplate)
addCopy(List srcList)	Создает новый список, копируя указанный список и добавляя его в коллекцию списков в документе.
equals(Object arg0)
get(int index)	Получает список по индексу.
getClass()
getCount()	Получает количество нумерованных и маркированных списков в документе.
getDocument()	Получает документ владельца.
getListByListId(int listId)	Получает список по идентификатору списка.
hashCode()
iterator()	Получает объект перечислителя, который будет перечислять списки в документе.
notify()
notifyAll()
toString()
wait()
wait(long arg0)
wait(long arg0, int arg1)

add(Style listStyle)

public List add(Style listStyle)

Создает новый список, который ссылается на стиль списка, и добавляет его в коллекцию списков в документе.

Параметры:

Параметр	Тип	Описание
listStyle	Style	Стиль списка.

Возвращает: List - Недавно созданный список.

Вновь созданный список ссылается на стиль списка. Если вы измените свойства стиля списка, это отразится в свойствах списка. И наоборот, если вы измените свойства списка, это отразится на свойствах стиля списка.

add(int listTemplate)

public List add(int listTemplate)

Параметры:

Параметр	Тип	Описание
listTemplate	int

Возвращает: List

addCopy(List srcList)

public List addCopy(List srcList)

Создает новый список, копируя указанный список и добавляя его в коллекцию списков в документе.

Параметры:

Параметр	Тип	Описание
srcList	List	Список источников для копирования.

Возвращает: List - Недавно созданный список.

Список источников может быть из любого документа. Если исходный список принадлежит другому документу, копия списка создается и добавляется в текущий документ.

Если исходный список является ссылкой или определением стиля списка, вновь созданный список не связан с исходным стилем списка.

equals(Object arg0)

public boolean equals(Object arg0)

Параметры:

Параметр	Тип	Описание
arg0	java.lang.Object

Возвращает: логический

get(int index)

public List get(int index)

Получает список по индексу.

Параметры:

Параметр	Тип	Описание
index	int

Возвращает: List - Список по индексу.

getClass()

public final native Class<?> getClass()

Возвращает: java.lang.Класс

getCount()

public int getCount()

Получает количество нумерованных и маркированных списков в документе.

Возвращает: int — количество нумерованных и маркированных списков в документе.

getDocument()

public DocumentBase getDocument()

Получает документ владельца.

Возвращает: DocumentBase - Документ собственника.

getListByListId(int listId)

public List getListByListId(int listId)

Получает список по идентификатору списка.

Параметры:

Параметр	Тип	Описание
listId	int	Идентификатор списка.

Возвращает: List - Возвращает объект списка. Возвращает null, если список с указанным идентификатором не найден.

Обычно вам не нужно использовать этот метод. В большинстве случаев вы применяете форматирование списка к абзацам, просто устанавливаяListFormat.getList() / ListFormat.setList(com.aspose.words.List) собственностьListFormat объект.

hashCode()

public native int hashCode()

Возвращает: инт

iterator()

public Iterator iterator()

Получает объект перечислителя, который будет перечислять списки в документе.

Возвращает: java.util.Iterator

notify()

public final native void notify()

notifyAll()

public final native void notifyAll()

toString()

public String toString()

Возвращает: java.lang.String

wait()

public final void wait()

wait(long arg0)

public final native void wait(long arg0)

Параметры:

Параметр	Тип	Описание
arg0	long

wait(long arg0, int arg1)

public final void wait(long arg0, int arg1)

Параметры:

Параметр	Тип	Описание
arg0	long
arg1	int