Интерфейс Range

public interface Range

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

С момента:: 9, DOM Level 2

Поля

Модификатор и тип	Поле	Описание
`static short`	`END_TO_END`	Сравнение конечной граничной точки `sourceRange` с конечной граничной точкой диапазона, на котором вызывается `compareBoundaryPoints`.
`static short`	`END_TO_START`	Сравнение конечной граничной точки `sourceRange` с начальной граничной точкой диапазона, на котором вызывается `compareBoundaryPoints`.
`static short`	`START_TO_END`	Сравнение начальной граничной точки `sourceRange` с конечной граничной точкой диапазона, на котором вызывается `compareBoundaryPoints`.
`static 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 является узлом 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 или какой-либо его предок является узлом Entity, Notation или DocumentType.; DOMException - INVALID_STATE_ERR: Вызывается, если detach() уже был вызван для этого объекта.
WRONG_DOCUMENT_ERR: Вызывается, если refNode был создан из документа, отличного от того, который создал этот диапазон.

compareBoundaryPoints

short compareBoundaryPoints(short how,
                            Range sourceRange)
                     throws DOMException

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

Параметры:: how - Код, представляющий тип сравнения, как определено выше.; sourceRange - Диапазон, с которым сравнивается текущий диапазон.
Возвращает:: -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

Вставляет узел в Документ или DocumentFragment в начале диапазона. Если контейнер является узлом 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, 2020, 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/11/docs/api/java.xml/org/w3c/dom/ranges/Range.html