LayoutEnumerator

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

public class LayoutEnumerator

Перечисляет объекты макета страницы документа. Вы можете использовать этот класс для просмотра модели макета страницы. Доступными свойствами являются тип, геометрия, текст и индекс страницы, на которой отображается объект, а также общая структура и отношения. Используйте комбинациюLayoutCollector.getEntity(com.aspose.words.Node) а такжеgetCurrent() / setCurrent(java.lang.Object) перейти к объекту, который соответствует узлу документа.

Чтобы узнать больше, посетитеConverting to Fixed-page Format документальная статья.

Конструкторы

КонструкторОписание
LayoutEnumerator(Document document)Инициализирует новый экземпляр этого класса.

Методы

МетодОписание
equals(Object arg0)
get(String key)Получает именованное свойство объекта.
getClass()
getCurrent()Получает текущую позицию в модели макета страницы.
getDocument()Получает документ, перечисляемый этим экземпляром.
getKind()Получает вид текущей сущности.
getPageIndex()Получает отсчитываемый от 1 индекс страницы, содержащей текущий объект.
getRectangle()Возвращает ограничивающий прямоугольник текущего объекта относительно верхнего левого угла страницы (в пунктах).
getText()Получает текст текущего объекта диапазона.
getType()Получает тип текущей сущности.
hashCode()
moveFirstChild()Переходит к первому дочернему объекту.
moveLastChild()Переходит к последнему дочернему объекту.
moveNext()Переходит к следующему родственному объекту в визуальном порядке.
moveNextLogical()Переходит к следующему одноуровневому объекту в логическом порядке.
moveParent()Перемещается к родительскому объекту.
moveParent(int types)
movePrevious()Переходит к предыдущему родственному объекту.
movePreviousLogical()Переходит к предыдущему одноуровневому объекту в логическом порядке.
notify()
notifyAll()
reset()Перемещает перечислитель на первую страницу документа.
setCurrent(Object value)Устанавливает текущую позицию в модели макета страницы.
toString()
wait()
wait(long arg0)
wait(long arg0, int arg1)

LayoutEnumerator(Document document)

public LayoutEnumerator(Document document)

Инициализирует новый экземпляр этого класса.

Параметры:

ПараметрТипОписание
documentDocumentДокумент, модель макета страницы которого необходимо перечислить.

Если модель макета страницы документа не была построена, перечислитель вызываетDocument.updatePageLayout() построить его.

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

equals(Object arg0)

public boolean equals(Object arg0)

Параметры:

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

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

get(String key)

public Object get(String key)

Получает именованное свойство объекта.

Параметры:

ПараметрТипОписание
keyjava.lang.StringИмя свойства (с учетом регистра).

Возвращает: java.lang.Object — Null, если свойство недоступно, в противном случае — значение свойства. В настоящее время это используется для получения свойств шрифта диапазонов. ВидетьFont class для возможных имен свойств. Поддерживаются не все свойства.

getClass()

public final native Class<?> getClass()

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

getCurrent()

public Object getCurrent()

Получает текущую позицию в модели макета страницы. Это свойство возвращает непрозрачный объект, соответствующий текущему объекту макета.

Возвращает: java.lang.Object — Текущая позиция в модели макета страницы.

getDocument()

public Document getDocument()

Получает документ, перечисляемый этим экземпляром.

Возвращает: Document - Документ перечисляет этот экземпляр.

getKind()

public String getKind()

Получает вид текущей сущности. Это может быть пустая строка, но не null. Это более конкретный тип текущего объекта, например, диапазон закладок имеетLayoutEntityType.SPAN тип и может иметь вид BOOKMARKSTART или BOOKMARKEND.

Возвращает: java.lang.String — вид текущего объекта.

getPageIndex()

public int getPageIndex()

Получает отсчитываемый от 1 индекс страницы, содержащей текущий объект.

Возвращает: int — индекс страницы, начинающийся с 1 и содержащий текущий объект.

getRectangle()

public Rectangle2D.Float getRectangle()

Возвращает ограничивающий прямоугольник текущего объекта относительно верхнего левого угла страницы (в пунктах).

Возвращает: java.awt.geom.Rectangle2D.Float — ограничивающий прямоугольник текущего объекта относительно верхнего левого угла страницы (в пунктах).

getText()

public String getText()

Получает текст текущего объекта диапазона. Броски для других типов сущностей.

Возвращает: java.lang.String — текст текущего объекта диапазона.

getType()

public int getType()

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

Возвращает: int - Тип текущего объекта. Возвращаемое значение представляет собой побитовую комбинациюLayoutEntityType константы.

hashCode()

public native int hashCode()

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

moveFirstChild()

public boolean moveFirstChild()

Переходит к первому дочернему объекту.

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

moveLastChild()

public boolean moveLastChild()

Переходит к последнему дочернему объекту.

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

moveNext()

public boolean moveNext()

Переходит к следующему родственному объекту в визуальном порядке. При повторении строк абзаца, разбитых на страницы, этот метод не будет переходить на следующую страницу, а скорее перейдет к следующему объекту на той же странице.

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

moveNextLogical()

public boolean moveNextLogical()

Переходит к следующему одноуровневому объекту в логическом порядке. При повторении строк абзаца, разбитых на страницы, этот метод перейдет к следующей строке, даже если она находится на другой странице. Обратите внимание, что всеLayoutEntityType.SPAN объекты связаны друг с другом таким образом, еслиgetCurrent() / setCurrent(java.lang.Object) объект охватывает повторный вызов этого метода, который будет повторять полную историю документа.

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

moveParent()

public boolean moveParent()

Перемещается к родительскому объекту.

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

moveParent(int types)

public boolean moveParent(int types)

Параметры:

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

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

movePrevious()

public boolean movePrevious()

Переходит к предыдущему родственному объекту.

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

movePreviousLogical()

public boolean movePreviousLogical()

Переходит к предыдущему одноуровневому объекту в логическом порядке. При повторении строк абзаца, разбитых на страницы, этот метод переместится на предыдущую строку, даже если она находится на другой странице. Обратите внимание, что всеLayoutEntityType.SPAN объекты связаны друг с другом таким образом, еслиgetCurrent() / setCurrent(java.lang.Object) объект охватывает повторный вызов этого метода, который будет повторять полную историю документа.

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

notify()

public final native void notify()

notifyAll()

public final native void notifyAll()

reset()

public void reset()

Перемещает перечислитель на первую страницу документа.

setCurrent(Object value)

public void setCurrent(Object value)

Устанавливает текущую позицию в модели макета страницы. Это свойство возвращает непрозрачный объект, соответствующий текущему объекту макета.

Параметры:

ПараметрТипОписание
valuejava.lang.ObjectТекущая позиция в модели макета страницы.

toString()

public String toString()

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

wait()

public final void wait()

wait(long arg0)

public final native void wait(long arg0)

Параметры:

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

wait(long arg0, int arg1)

public final void wait(long arg0, int arg1)

Параметры:

ПараметрТипОписание
arg0long
arg1int