Интерфейс Range

public interface Range

См. также Спецификацию перемещения и диапазонов DOM уровня 2.

С тех пор:: 9, DOM Level 2

Краткое описание полей

Модификатор и тип	Поле	Описание
`static final short`	`END_TO_END`	Сравнение конечной граничной точки `sourceRange` с конечной граничной точкой диапазона, к которому применено `compareBoundaryPoints`.
`static final short`	`END_TO_START`	Сравнение конечной граничной точки `sourceRange` с начальной граничной точкой диапазона, к которому применено `compareBoundaryPoints`.
`static final short`	`START_TO_END`	Сравнение начальной граничной точки `sourceRange` с конечной граничной точкой диапазона, к которому применено `compareBoundaryPoints`.
`static final short`	`START_TO_START`	Сравнение начальной граничной точки `sourceRange` с начальной граничной точкой диапазона, к которому применено `compareBoundaryPoints`.

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

Модификатор и тип	Метод	Описание
`DocumentFragment`	`cloneContents()`	Дублирует содержимое диапазона
`Range`	`cloneRange()`	Создаёт новый диапазон, граничные точки которого равны граничным точкам исходного диапазона.
`void`	`collapse(boolean toStart)`	Сжимает диапазон до одной из его граничных точек
`short`	`compareBoundaryPoints(short how, Range sourceRange)`	Сравнивает граничные точки двух диапазонов в документе.
`void`	`deleteContents()`	Удаляет содержимое диапазона из содержащего документа или фрагмента документа без возвращения ссылки на удалённое содержимое.
`void`	`detach()`	Вызывается для обозначения того, что диапазон больше не используется, и что реализация может высвободить ресурсы, связанные с этим диапазоном.
`DocumentFragment`	`extractContents()`	Перемещает содержимое диапазона из содержащего документа или фрагмента документа в новый DocumentFragment.
`boolean`	`getCollapsed()`	TRUE, если диапазон сжат
`Node`	`getCommonAncestorContainer()`	Самый глубокий общий родительский контейнер двух граничных точек диапазона.
`Node`	`getEndContainer()`	Узел, на котором заканчивается диапазон
`int`	`getEndOffset()`	Смещение внутри конечного узла диапазона.
`Node`	`getStartContainer()`	Узел, на котором начинается диапазон
`int`	`getStartOffset()`	Смещение внутри начального узла диапазона.
`void`	`insertNode(Node newNode)`	Вставляет узел в документ или фрагмент документа в начале диапазона.
`void`	`selectNode(Node refNode)`	Выделяет узел и его содержимое
`void`	`selectNodeContents(Node refNode)`	Выделяет содержимое внутри узла
`void`	`setEnd(Node refNode, int offset)`	Устанавливает атрибуты, описывающие конец диапазона.
`void`	`setEndAfter(Node refNode)`	Устанавливает конец диапазона после узла
`void`	`setEndBefore(Node refNode)`	Устанавливает конечную позицию перед узлом.
`void`	`setStart(Node refNode, int offset)`	Устанавливает атрибуты, описывающие начало диапазона.
`void`	`setStartAfter(Node refNode)`	Устанавливает начало диапазона после узла
`void`	`setStartBefore(Node refNode)`	Устанавливает начальную позицию перед узлом
`void`	`surroundContents(Node newParent)`	Перемещает содержимое диапазона в указанный узел и вставляет узел в позицию начала диапазона.
`String`	`toString()`	Возвращает содержимое диапазона в виде строки.

Подробное описание полей

START_TO_START

static final short START_TO_START

Сравнение начальной граничной точки sourceRange с начальной граничной точкой диапазона, на котором вызывается метод compareBoundaryPoints.

См. также:

START_TO_END

static final short START_TO_END

Сравнение начальной граничной точки sourceRange с конечной граничной точкой диапазона, на котором вызывается метод compareBoundaryPoints.

См. также:

END_TO_END

static final short END_TO_END

Сравнение конечной граничной точки sourceRange с конечной граничной точкой диапазона, на котором вызывается метод compareBoundaryPoints.

См. также:

END_TO_START

static final short END_TO_START

Сравнение конечной граничной точки sourceRange с начальной граничной точкой диапазона, на котором вызывается метод compareBoundaryPoints.

См. также:

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

getStartContainer

Node getStartContainer() throws DOMException

Узел, в котором начинается диапазон

Возбуждает:: DOMException - INVALID_STATE_ERR: Поднимается, если detach() уже был вызван для этого объекта.

getStartOffset

int getStartOffset() throws DOMException

Смещение в узле начала диапазона.

Возбуждает:: DOMException - INVALID_STATE_ERR: Поднимается, если detach() уже был вызван для этого объекта.

getEndContainer

Node getEndContainer() throws DOMException

Узел, в котором заканчивается диапазон

Возбуждает:: DOMException - INVALID_STATE_ERR: Поднимается, если detach() уже был вызван для этого объекта.

getEndOffset

int getEndOffset() throws DOMException

Смещение в узле окончания диапазона.

Возбуждает:: DOMException - INVALID_STATE_ERR: Поднимается, если detach() уже был вызван для этого объекта.

getCollapsed

boolean getCollapsed() throws DOMException

ИСТИНА, если диапазон сжат

Возбуждает:: DOMException - INVALID_STATE_ERR: Поднимается, если detach() уже был вызван для этого объекта.

getCommonAncestorContainer

Node getCommonAncestorContainer() throws DOMException

Самый глубокий общий контейнер предка двух граничных точек диапазона.

Возбуждает:: DOMException - INVALID_STATE_ERR: Поднимается, если detach() уже был вызван для этого объекта.

setStart

void setStart(Node refNode, int offset) throws RangeException, DOMException

Устанавливает атрибуты, описывающие начало диапазона.

Параметры:: refNode - Значение refNode. Этот параметр должен отличаться от null.; offset - Значение startOffset.
Возбуждает:: RangeException - INVALID_NODE_TYPE_ERR: Поднимается, если refNode или предковый узел refNode является узлом сущности, обозначения или типа документа.; DOMException - INDEX_SIZE_ERR: Поднимается, если offset отрицательно или больше, чем количество дочерних элементов в refNode. Дочерние элементы — это 16-битные единицы, если refNode является типом узла CharacterData (например, узел Text или Comment) или узлом ProcessingInstruction. В остальных случаях дочерние элементы — это узлы.
INVALID_STATE_ERR: Поднимается, если detach() уже был вызван для этого объекта.
WRONG_DOCUMENT_ERR: Поднимается, если refNode был создан из другого документа, чем тот, который создал этот диапазон.

setEnd

void setEnd(Node refNode, int offset) throws RangeException, DOMException

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

Параметры:: refNode - Значение refNode. Этот параметр должен отличаться от null.; offset - Значение endOffset.
Возбуждает:: RangeException - INVALID_NODE_TYPE_ERR: Поднимается, если refNode или предковый узел refNode является узлом сущности, обозначения или типа документа.; DOMException - INDEX_SIZE_ERR: Поднимается, если offset отрицательно или больше, чем количество дочерних элементов в refNode. Дочерние элементы — это 16-битные единицы, если refNode является типом узла CharacterData (например, узел Text или Comment) или узлом ProcessingInstruction. В остальных случаях дочерние элементы — это узлы.
INVALID_STATE_ERR: Поднимается, если detach() уже был вызван для этого объекта.
WRONG_DOCUMENT_ERR: Поднимается, если refNode был создан из другого документа, чем тот, который создал этот диапазон.

setStartBefore

void setStartBefore(Node refNode) throws RangeException, DOMException

Устанавливает начальную позицию перед узлом

Параметры:: refNode - Диапазон начинается перед refNode
Возбуждает:: RangeException - INVALID_NODE_TYPE_ERR: Поднимается, если корневой контейнер refNode не является узлом Attr, Document или DocumentFragment, или если refNode является узлом Document, DocumentFragment, Attr, Entity или Notation.; DOMException - INVALID_STATE_ERR: Поднимается, если detach() уже был вызван для этого объекта.
WRONG_DOCUMENT_ERR: Поднимается, если refNode был создан из другого документа, чем тот, который создал этот диапазон.

setStartAfter

void setStartAfter(Node refNode) throws RangeException, DOMException

Устанавливает начальную позицию после узла

Параметры:: refNode - Диапазон начинается после refNode
Возбуждает:: RangeException - INVALID_NODE_TYPE_ERR: Поднимается, если корневой контейнер refNode не является узлом Attr, Document или DocumentFragment, или если refNode является узлом Document, DocumentFragment, Attr, Entity или Notation.; DOMException - INVALID_STATE_ERR: Поднимается, если detach() уже был вызван для этого объекта.
WRONG_DOCUMENT_ERR: Поднимается, если refNode был создан из другого документа, чем тот, который создал этот диапазон.

setEndBefore

void setEndBefore(Node refNode) throws RangeException, DOMException

Устанавливает конечную позицию перед узлом.

Параметры:: refNode - Диапазон заканчивается перед refNode
Возбуждает:: RangeException - INVALID_NODE_TYPE_ERR: Поднимается, если корневой контейнер refNode не является узлом Attr, Document или DocumentFragment, или если refNode является узлом Document, DocumentFragment, Attr, Entity или Notation.; DOMException - INVALID_STATE_ERR: Поднимается, если detach() уже был вызван для этого объекта.
WRONG_DOCUMENT_ERR: Поднимается, если refNode был создан из другого документа, чем тот, который создал этот диапазон.

setEndAfter

void setEndAfter(Node refNode) throws RangeException, DOMException

Устанавливает конец диапазона после узла

Параметры:: refNode - Диапазон заканчивается после refNode.
Возбуждает:: RangeException - INVALID_NODE_TYPE_ERR: Поднимается, если корневой контейнер refNode не является узлом Attr, Document или DocumentFragment, или если refNode является узлом Document, DocumentFragment, Attr, Entity или Notation.; DOMException - INVALID_STATE_ERR: Поднимается, если detach() уже был вызван для этого объекта.
WRONG_DOCUMENT_ERR: Поднимается, если refNode был создан из другого документа, чем тот, который создал этот диапазон.

collapse

void collapse(boolean toStart) throws DOMException

Сжимает диапазон в одну из своих граничных точек

Параметры:: toStart - Если ИСТИНА, сжимает диапазон до его начальной точки; если ЛОЖЬ, сжимает его до конечной точки.
Возбуждает:: DOMException - INVALID_STATE_ERR: Поднимается, если detach() уже был вызван для этого объекта.

selectNode

void selectNode(Node refNode) throws RangeException, DOMException

Выбрать узел и его содержимое

Параметры:: refNode - Выбираемый узел.
Исключения:: RangeException - INVALID_NODE_TYPE_ERR: Бросается, если предком refNode является узел Entity, Notation или DocumentType, или если refNode является узлом Document, DocumentFragment, Attr, Entity или Notation.; DOMException - INVALID_STATE_ERR: Бросается, если detach() уже был вызван для этого объекта.
WRONG_DOCUMENT_ERR: Бросается, если refNode был создан из другого документа, чем тот, который создал этот диапазон.

selectNodeContents

void selectNodeContents(Node refNode) throws RangeException, DOMException

Выбрать содержимое внутри узла

Параметры:: refNode - Узел для выбора
Исключения:: RangeException - INVALID_NODE_TYPE_ERR: Бросается, если refNode или предком refNode является узел Entity, Notation или DocumentType.; DOMException - INVALID_STATE_ERR: Бросается, если detach() уже был вызван для этого объекта.
WRONG_DOCUMENT_ERR: Бросается, если refNode был создан из другого документа, чем тот, который создал этот диапазон.

compareBoundaryPoints

short compareBoundaryPoints(short how, Range sourceRange) throws DOMException

Сравнение граничных точек двух диапазонов в документе.

Параметры:: how - Код, представляющий тип сравнения, как определено выше.; sourceRange - Range, с которым сравнивается текущий Range.
Возвращает:: -1, 0 или 1 в зависимости от того, находится ли соответствующая граничная точка диапазона соответственно до, равна или после соответствующей граничной точки sourceRange.
Исключения:: DOMException - WRONG_DOCUMENT_ERR: Бросается, если два диапазона не находятся в одном документе или фрагменте документа.
INVALID_STATE_ERR: Бросается, если detach() уже был вызван для этого объекта.

deleteContents

void deleteContents() throws DOMException

Удаляет содержимое диапазона из содержащего документа или фрагмента документа без возвращения ссылки на удаленное содержимое.

Исключения:: DOMException - NO_MODIFICATION_ALLOWED_ERR: Бросается, если какая-либо часть содержимого диапазона является только для чтения или любой из узлов, содержащих часть содержимого диапазона, является только для чтения.
INVALID_STATE_ERR: Бросается, если detach() уже был вызван для этого объекта.

extractContents

DocumentFragment extractContents() throws DOMException

Перемещает содержимое диапазона из содержащего документа или фрагмента документа в новый DocumentFragment.

Возвращает:: DocumentFragment, содержащий извлеченное содержимое.
Исключения:: DOMException - NO_MODIFICATION_ALLOWED_ERR: Бросается, если какая-либо часть содержимого диапазона является только для чтения или любой из узлов, содержащих часть содержимого диапазона, является только для чтения.
HIERARCHY_REQUEST_ERR: Бросается, если узел DocumentType будет извлечен в новый DocumentFragment.
INVALID_STATE_ERR: Бросается, если detach() уже был вызван для этого объекта.

cloneContents

DocumentFragment cloneContents() throws DOMException

Создает дубликат содержимого диапазона

Возвращает:: DocumentFragment, содержащий содержимое, эквивалентное этому диапазону.
Исключения:: DOMException - HIERARCHY_REQUEST_ERR: Бросается, если узел DocumentType будет извлечен в новый DocumentFragment.
INVALID_STATE_ERR: Бросается, если detach() уже был вызван для этого объекта.

insertNode

void insertNode(Node newNode) throws DOMException, RangeException

Вставляет узел в документ или фрагмент документа в начале диапазона. Если контейнер — узел Text, он будет разделен в начале диапазона (как если бы метод splitText узла Text был выполнен в точке вставки), и вставка произойдет между двумя полученными узлами Text. Смежные узлы Text не будут автоматически объединены. Если вставляемый узел — DocumentFragment, вставлены будут его дочерние узлы, а не сам DocumentFragment.

Параметры:: newNode - Узел для вставки в начале диапазона
Исключения:: DOMException - NO_MODIFICATION_ALLOWED_ERR: Бросается, если предковый контейнер начала диапазона является только для чтения.
WRONG_DOCUMENT_ERR: Бросается, если newNode и контейнер начала диапазона не были созданы из одного документа.
HIERARCHY_REQUEST_ERR: Бросается, если контейнер начала диапазона является типом, который не допускает дочерние узлы типа newNode или если newNode является предком контейнера.
INVALID_STATE_ERR: Бросается, если detach() уже был вызван для этого объекта.; RangeException - INVALID_NODE_TYPE_ERR: Бросается, если newNode является узлом Attr, Entity, Notation или Document.

surroundContents

void surroundContents(Node newParent) throws DOMException, RangeException

Изменяет родительский узел для содержимого диапазона на указанный узел и вставляет его в позицию начала диапазона.

Параметры:: newParent - Узел, которым будет окружено содержимое.
Исключения:: DOMException - NO_MODIFICATION_ALLOWED_ERR: Бросается, если предковый контейнер любой из граничных точек диапазона является только для чтения.
WRONG_DOCUMENT_ERR: Бросается, если newParent и контейнер начала диапазона не были созданы из одного документа.
HIERARCHY_REQUEST_ERR: Бросается, если контейнер начала диапазона является типом, который не допускает дочерние узлы типа newParent или если newParent является предком контейнера или если node получит дочерний узел типа, не разрешенного типом node.
INVALID_STATE_ERR: Бросается, если detach() уже был вызван для этого объекта.; RangeException - BAD_BOUNDARYPOINTS_ERR: Бросается, если диапазон частично выбирает узел, отличный от текста.
INVALID_NODE_TYPE_ERR: Бросается, если node является узлом Attr, Entity, DocumentType, Notation, Document или DocumentFragment.

cloneRange

Range cloneRange() throws DOMException

Создает новый диапазон, граничные точки которого совпадают с граничными точками текущего диапазона.

Возвращает:: Дублированный диапазон.
Исключения:: DOMException - INVALID_STATE_ERR: Бросается, если detach() уже был вызван для этого объекта.

toString

String toString() throws DOMException

Возвращает содержимое диапазона в виде строки. Эта строка содержит только символы данных, а не разметку.

Переопределяет:: toString в классе Object
Возвращает:: Содержимое диапазона.
Исключения:: DOMException - INVALID_STATE_ERR: Бросается, если detach() уже был вызван для этого объекта.

detach

void detach() throws DOMException

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

Исключения:: DOMException - INVALID_STATE_ERR: Бросается, если detach() уже был вызван для этого объекта.

© 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://download.java.net/java/early_access/jdk24/docs/api/java.xml/org/w3c/dom/ranges/Range.html