Module java.xml
Package org.w3c.dom.ranges

Interface Range

public interface Range

另请参阅文档对象模型（DOM）级别2遍历和范围规范。

自从:
9，DOM级别2

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    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的范围的开始边界点进行比较。

  • Method Summary

    Modifier and Type
    Method
    Description
    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()
    将范围的内容作为字符串返回。

  • Field Details

    • 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的范围的开始边界点进行比较。
      另请参阅:

  • Method Details

    • 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
      如果范围折叠，则为TRUE
      抛出:
      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中子单元的数量。如果refNode是CharacterData节点（例如Text或Comment节点）或ProcessingInstruction节点，则子单元为16位单元。在所有其他情况下，子单元为节点。
      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中子单元的数量。如果refNode是CharacterData节点（例如Text或Comment节点）或ProcessingInstruction节点，则子单元为16位单元。在所有其他情况下，子单元为节点。
      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 - 如果为TRUE，则将范围折叠到其起始点；如果为FALSE，则将其折叠到其结束点。
      抛出:
      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
      将节点插入到范围的起始点处的文档或文档片段中。如果容器是文本节点，则将在范围的起始点处拆分该节点（就像在插入点执行了文本节点的splitText方法一样），并且插入将发生在两个结果文本节点之间。相邻的文本节点不会自动合并。如果要插入的节点是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最终会有一个不允许的类型的子节点，则引发异常。
      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()，则引发异常。