Интерфейс Element

Все известные классы, реализующие интерфейс:: 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, 2025, 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/25/docs/api/java.desktop/javax/swing/text/Element.html