Элемент интерфейса

Все известные реализующие классы:: AbstractDocument.AbstractElement, AbstractDocument.BranchElement, AbstractDocument.LeafElement, DefaultStyledDocument.SectionElement, HTMLDocument.BlockElement, HTMLDocument.RunElement

public interface Element

Интерфейс для описания структурной части документа. Он призван отразить дух элемента SGML.

Краткое описание методов

Модификатор и тип	Метод	Описание
`AttributeSet`	`getAttributes()`	Получает коллекцию атрибутов, содержащихся в этом элементе.
`Document`	`getDocument()`	Получает документ, связанный с этим элементом.
`Element`	`getElement(int index)`	Получает дочерний элемент по заданному индексу.
`int`	`getElementCount()`	Возвращает количество дочерних элементов, содержащихся в этом элементе.
`int`	`getElementIndex(int offset)`	Получает индекс дочернего элемента, ближайшего к заданному смещению.
`int`	`getEndOffset()`	Получает смещение от начала документа, по которому заканчивается этот элемент.
`String`	`getName()`	Получает имя элемента.
`Element`	`getParentElement()`	Получает родительский элемент.
`int`	`getStartOffset()`	Получает смещение от начала документа, по которому начинается этот элемент.
`boolean`	`isLeaf()`	Является ли этот элемент листом?

Подробное описание методов

getDocument

Document getDocument()

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

Возвращает:: документ

getParentElement

Element getParentElement()

Получает родительский элемент. Если элемент находится на корневом уровне, возвращает null.

Возвращает:: родительский элемент

getName

String getName()

Получает имя элемента. Если элемент используется для представления какого-либо типа структуры, это будет имя типа.

Возвращает:: имя элемента

getAttributes

AttributeSet getAttributes()

Получает коллекцию атрибутов, содержащихся в этом элементе.

Возвращает:: атрибуты для элемента

getStartOffset

int getStartOffset()

Получает смещение от начала документа, по которому начинается этот элемент. Если у этого элемента есть дочерние элементы, это будет смещение первого дочернего элемента. Позиция в документе подразумевает смещение вперед.

Возвращает:

начальное смещение >= 0 и < getEndOffset();

См. также:

getEndOffset

int getEndOffset()

Получает смещение от начала документа, по которому заканчивается этот элемент. Если у этого элемента есть дочерние элементы, это будет конечное смещение последнего дочернего элемента. Позиция в документе подразумевает смещение назад.

Все реализации Document унаследованы от AbstractDocument. AbstractDocument моделирует неявный разрыв в конце документа. В результате возможно, что это вернет значение больше длины документа.

Возвращает:

конечное смещение > getStartOffset() и <= getDocument().getLength() + 1

См. также:

getElementIndex

int getElementIndex(int offset)

Получает индекс дочернего элемента, ближайшего к заданному смещению. Смещение указано относительно начала документа. Возвращает -1 если Element - лист, в противном случае возвращает индекс Element, который лучше всего представляет данное местоположение. Возвращает 0 если местоположение меньше начального смещения. Возвращает getElementCount() - 1 если местоположение больше или равно конечному смещению.

Параметры:: offset - заданное смещение >= 0
Возвращает:: индекс элемента >= 0

getElementCount

int getElementCount()

Возвращает количество дочерних элементов, содержащихся в этом элементе. Если этот элемент является листом, возвращается ноль.

Возвращает:: количество дочерних элементов >= 0

getElement

Element getElement(int index)

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

Параметры:: index - заданный индекс >= 0
Возвращает:: дочерний элемент

isLeaf

boolean isLeaf()

Является ли этот элемент листом? Элемент, который *может* иметь дочерние элементы, даже если у него их сейчас нет, вернет false.

Возвращает:: true, если элемент лист, иначе false

© 1993, 2023, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
https://docs.oracle.com/en/java/javase/21/docs/api/java.desktop/javax/swing/text/Element.html