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

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