LayoutCollector
Наследование: java.lang.Object
public class LayoutCollector
Этот класс позволяет вычислять номера страниц узлов документа.
Чтобы узнать больше, посетитеConverting to Fixed-page Format документальная статья.
Когда вы создаетеLayoutCollector и указатьDocument объект документа для присоединения, коллектор запишет сопоставление узлов документа с объектами макета, когда документ отформатирован в страницы.
Вы сможете узнать, на какой странице находится тот или иной узел документа (например, прогон, абзац или ячейка таблицы), воспользовавшись кнопкойgetStartPageIndex(com.aspose.words.Node), getEndPageIndex(com.aspose.words.Node) а такжеgetNumPagesSpanned(com.aspose.words.Node) методы. Эти методы автоматически создают модель макета страницы документа и при необходимости обновляют поля.
Когда вам больше не нужно собирать информацию о макете, лучше всего установитьgetDocument() / setDocument(com.aspose.words.Document) значение null, чтобы избежать ненужного сбора дополнительных сопоставлений макета.
Конструкторы
| Конструктор | Описание |
|---|---|
| LayoutCollector(Document doc) | Инициализирует экземпляр этого класса. |
Методы
| Метод | Описание |
|---|---|
| clear() | Очищает все собранные данные макета. |
| equals(Object arg0) | |
| getClass() | |
| getDocument() | Получает документ, к которому присоединен этот экземпляр сборщика. |
| getEndPageIndex(Node node) | Получает отсчитываемый от 1 индекс страницы, на которой заканчивается узел. |
| getEntity(Node node) | Возвращает непрозрачную позициюLayoutEnumerator что соответствует указанному узлу. |
| getNumPagesSpanned(Node node) | Получает количество страниц, которые охватывает указанный узел. |
| getStartPageIndex(Node node) | Получает отсчитываемый от 1 индекс страницы, с которой начинается узел. |
| hashCode() | |
| notify() | |
| notifyAll() | |
| setDocument(Document value) | Задает документ, к которому прикреплен этот экземпляр сборщика. |
| toString() | |
| wait() | |
| wait(long arg0) | |
| wait(long arg0, int arg1) |
LayoutCollector(Document doc)
public LayoutCollector(Document doc)
Инициализирует экземпляр этого класса.
Параметры:
| Параметр | Тип | Описание |
|---|---|---|
| doc | Document | Документ, к которому будет прикреплен этот экземпляр коллектора. |
clear()
public void clear()
Очищает все собранные данные макета. Вызовите этот метод после обновления документа вручную или перестроения макета.
equals(Object arg0)
public boolean equals(Object arg0)
Параметры:
| Параметр | Тип | Описание |
|---|---|---|
| arg0 | java.lang.Object |
Возвращает: логический
getClass()
public final native Class<?> getClass()
Возвращает: java.lang.Класс
getDocument()
public Document getDocument()
Получает документ, к которому присоединен этот экземпляр сборщика. Если вам нужно получить доступ к индексам страниц узлов документа, вам нужно установить это свойство так, чтобы оно указывало на экземпляр документа, прежде чем будет построен макет страницы документа. Лучше всего впоследствии установить для этого свойства значение null, иначе сборщик продолжит накапливать информацию из последующих перестроений макета страницы документа.
Возвращает: Document - Документ, к которому прикреплен этот экземпляр коллектора.
getEndPageIndex(Node node)
public int getEndPageIndex(Node node)
Получает отсчитываемый от 1 индекс страницы, на которой заканчивается узел. Возвращает 0, если узел не может быть сопоставлен со страницей.
Параметры:
| Параметр | Тип | Описание |
|---|---|---|
| node | Node |
Возвращает: инт
getEntity(Node node)
public Object getEntity(Node node)
Возвращает непрозрачную позициюLayoutEnumerator что соответствует указанному узлу. Вы можете использовать возвращаемое значение в качестве аргумента дляLayoutEnumerator.getCurrent() / LayoutEnumerator.setCurrent(java.lang.Object)учитывая, что перечисляемый документ и документ узла совпадают.
Этот метод работает только дляParagraph узлы, а также неделимые встроенные узлы, напримерBookmarkStart или жеShape . Это не работает дляRun, Cell Row или жеTable узлы и узлы в верхнем/нижнем колонтитуле.
Обратите внимание, что объект вернулся дляParagraph узел является диапазоном разрыва абзаца. Используйте соответствующий метод, чтобы подняться на родительскую линию
Если вам нужно перейти кRun текста, вы можете вставить закладку прямо перед ней, а затем вместо этого перейти к закладке.
Если вам нужно перейти кCell node, затем вы можете перейти кParagraph узла в этой ячейке, а затем подняться к родительскому объекту. Тот же подход можно использовать дляRow а такжеTable узлы.
Параметры:
| Параметр | Тип | Описание |
|---|---|---|
| node | Node |
Возвращает: java.lang.Объект
getNumPagesSpanned(Node node)
public int getNumPagesSpanned(Node node)
Получает количество страниц, которые охватывает указанный узел. 0, если узел находится на одной странице. Это то же самое, чтоgetEndPageIndex(com.aspose.words.Node) -getStartPageIndex(com.aspose.words.Node).
Параметры:
| Параметр | Тип | Описание |
|---|---|---|
| node | Node |
Возвращает: инт
getStartPageIndex(Node node)
public int getStartPageIndex(Node node)
Получает отсчитываемый от 1 индекс страницы, с которой начинается узел. Возвращает 0, если узел не может быть сопоставлен со страницей.
Параметры:
| Параметр | Тип | Описание |
|---|---|---|
| node | Node |
Возвращает: инт
hashCode()
public native int hashCode()
Возвращает: инт
notify()
public final native void notify()
notifyAll()
public final native void notifyAll()
setDocument(Document value)
public void setDocument(Document value)
Задает документ, к которому прикреплен этот экземпляр сборщика. Если вам нужно получить доступ к индексам страниц узлов документа, вам нужно установить это свойство так, чтобы оно указывало на экземпляр документа, прежде чем будет построен макет страницы документа. Лучше всего впоследствии установить для этого свойства значение null, иначе сборщик продолжит накапливать информацию из последующих перестроений макета страницы документа.
Параметры:
| Параметр | Тип | Описание |
|---|---|---|
| value | Document | Документ, к которому прикреплен этот экземпляр сборщика. |
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 |
