Интерфейс элемента

Все известные реализующие классы:: 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();
См. также:: Document, AbstractDocument

getEndOffset

int getEndOffset()

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

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

Возвращает:: конечное смещение > getStartOffset() и <= getDocument().getLength() + 1
См. также:: Document, AbstractDocument

getElementIndex

int getElementIndex(int offset)

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

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

getElementCount

int getElementCount()

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

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

getElement

Element getElement(int index)

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

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

isLeaf

boolean isLeaf()

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

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