Интерфейс Range

public interface Range

См. также Спецификацию перемещения и диапазона DOM Level 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()`	Истина, если диапазон сжат
`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 или его предок является узлом сущности, обозначения или типа документа.; 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 или его предок является узлом сущности, обозначения или типа документа.; 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 является узлом сущности, обозначения или типа документа, или если refNode является узлом Document, DocumentFragment, Attr, Entity или Notation.; DOMException - INVALID_STATE_ERR: Возникает, если detach() уже был вызван для этого объекта.
WRONG_DOCUMENT_ERR: Возникает, если refNode был создан из другого документа, чем тот, который создал этот диапазон.

выделитьСодержимоеУзла

void selectNodeContents(Node refNode) throws RangeException, DOMException

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

Параметры:: refNode - Узел для выделения
Исключения:: RangeException - INVALID_NODE_TYPE_ERR: Выбрасывается, если refNode или какой-либо из его предков является узлом типа Сущность, Аннотация или ДокументТип.; DOMException - INVALID_STATE_ERR: Выбрасывается, если метод detach() уже был вызван для этого объекта.
WRONG_DOCUMENT_ERR: Выбрасывается, если refNode был создан из документа, отличного от документа, который создал этот диапазон.

сравнитьГраницы

short compareBoundaryPoints(short how, Range sourceRange) throws DOMException

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

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

удалитьСодержимое

void deleteContents() throws DOMException

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

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

извлечьСодержимое

DocumentFragment extractContents() throws DOMException

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

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

клонироватьСодержимое

DocumentFragment cloneContents() throws DOMException

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

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

вставитьУзел

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.

окружитьСодержимое

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.

клонироватьДиапазон

Range cloneRange() throws DOMException

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

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

toString

String toString() throws DOMException

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

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

отсоединить

void detach() throws DOMException

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

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

© 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.xml/org/w3c/dom/ranges/Range.html