Package Summary  Overview Summary

class:Range [NONE]

field:START_TO_START [NONE]

  • START_TO_START

    static final short START_TO_START
    Compare start boundary-point of sourceRange to start boundary-point of Range on which compareBoundaryPoints is invoked.
    See Also:
    Constant Field Values

field:START_TO_END [NONE]

  • START_TO_END

    static final short START_TO_END
    Compare start boundary-point of sourceRange to end boundary-point of Range on which compareBoundaryPoints is invoked.
    See Also:
    Constant Field Values

field:END_TO_END [NONE]

  • END_TO_END

    static final short END_TO_END
    Compare end boundary-point of sourceRange to end boundary-point of Range on which compareBoundaryPoints is invoked.
    See Also:
    Constant Field Values

field:END_TO_START [NONE]

  • END_TO_START

    static final short END_TO_START
    Compare end boundary-point of sourceRange to start boundary-point of Range on which compareBoundaryPoints is invoked.
    See Also:
    Constant Field Values

method:getStartContainer() [NONE]

  • getStartContainer

    Node getStartContainer()
                throws DOMException
    Node within which the Range begins
    Throws:
    DOMException - INVALID_STATE_ERR: Raised if detach() has already been invoked on this object.

method:getStartOffset() [NONE]

  • getStartOffset

    int getStartOffset()
            throws DOMException
    Offset within the starting node of the Range.
    Throws:
    DOMException - INVALID_STATE_ERR: Raised if detach() has already been invoked on this object.

method:getEndContainer() [NONE]

  • getEndContainer

    Node getEndContainer()
              throws DOMException
    Node within which the Range ends
    Throws:
    DOMException - INVALID_STATE_ERR: Raised if detach() has already been invoked on this object.

method:getEndOffset() [NONE]

  • getEndOffset

    int getEndOffset()
          throws DOMException
    Offset within the ending node of the Range.
    Throws:
    DOMException - INVALID_STATE_ERR: Raised if detach() has already been invoked on this object.

method:getCollapsed() [NONE]

  • getCollapsed

    boolean getCollapsed()
              throws DOMException
    TRUE if the Range is collapsed
    Throws:
    DOMException - INVALID_STATE_ERR: Raised if detach() has already been invoked on this object.

method:getCommonAncestorContainer() [NONE]

  • getCommonAncestorContainer

    Node getCommonAncestorContainer()
                         throws DOMException
    The deepest common ancestor container of the Range's two boundary-points.
    Throws:
    DOMException - INVALID_STATE_ERR: Raised if detach() has already been invoked on this object.

method:setStart(org.w3c.dom.Node,int) [NONE]

  • setStart

    void setStart​(Node refNode,
              int offset)
       throws RangeException,
              DOMException
    Sets the attributes describing the start of the Range.
    Parameters:
    refNode - The refNode value. This parameter must be different from null.
    offset - The startOffset value.
    Throws:
    RangeException - INVALID_NODE_TYPE_ERR: Raised if refNode or an ancestor of refNode is an Entity, Notation, or DocumentType node.
    DOMException - INDEX_SIZE_ERR: Raised if offset is negative or greater than the number of child units in refNode. Child units are 16-bit units if refNode is a type of CharacterData node (e.g., a Text or Comment node) or a ProcessingInstruction node. Child units are Nodes in all other cases.
    INVALID_STATE_ERR: Raised if detach() has already been invoked on this object.
    WRONG_DOCUMENT_ERR: Raised if refNode was created from a different document than the one that created this range.

method:setEnd(org.w3c.dom.Node,int) [NONE]

  • setEnd

    void setEnd​(Node refNode,
            int offset)
     throws RangeException,
            DOMException
    Sets the attributes describing the end of a Range.
    Parameters:
    refNode - The refNode value. This parameter must be different from null.
    offset - The endOffset value.
    Throws:
    RangeException - INVALID_NODE_TYPE_ERR: Raised if refNode or an ancestor of refNode is an Entity, Notation, or DocumentType node.
    DOMException - INDEX_SIZE_ERR: Raised if offset is negative or greater than the number of child units in refNode. Child units are 16-bit units if refNode is a type of CharacterData node (e.g., a Text or Comment node) or a ProcessingInstruction node. Child units are Nodes in all other cases.
    INVALID_STATE_ERR: Raised if detach() has already been invoked on this object.
    WRONG_DOCUMENT_ERR: Raised if refNode was created from a different document than the one that created this range.

method:setStartBefore(org.w3c.dom.Node) [NONE]

  • setStartBefore

    void setStartBefore​(Node refNode)
             throws RangeException,
                    DOMException
    Sets the start position to be before a node
    Parameters:
    refNode - Range starts before refNode
    Throws:
    RangeException - INVALID_NODE_TYPE_ERR: Raised if the root container of refNode is not an Attr, Document, or DocumentFragment node or if refNode is a Document, DocumentFragment, Attr, Entity, or Notation node.
    DOMException - INVALID_STATE_ERR: Raised if detach() has already been invoked on this object.
    WRONG_DOCUMENT_ERR: Raised if refNode was created from a different document than the one that created this range.

method:setStartAfter(org.w3c.dom.Node) [NONE]

  • setStartAfter

    void setStartAfter​(Node refNode)
            throws RangeException,
                   DOMException
    Sets the start position to be after a node
    Parameters:
    refNode - Range starts after refNode
    Throws:
    RangeException - INVALID_NODE_TYPE_ERR: Raised if the root container of refNode is not an Attr, Document, or DocumentFragment node or if refNode is a Document, DocumentFragment, Attr, Entity, or Notation node.
    DOMException - INVALID_STATE_ERR: Raised if detach() has already been invoked on this object.
    WRONG_DOCUMENT_ERR: Raised if refNode was created from a different document than the one that created this range.

method:setEndBefore(org.w3c.dom.Node) [NONE]

  • setEndBefore

    void setEndBefore​(Node refNode)
           throws RangeException,
                  DOMException
    Sets the end position to be before a node.
    Parameters:
    refNode - Range ends before refNode
    Throws:
    RangeException - INVALID_NODE_TYPE_ERR: Raised if the root container of refNode is not an Attr, Document, or DocumentFragment node or if refNode is a Document, DocumentFragment, Attr, Entity, or Notation node.
    DOMException - INVALID_STATE_ERR: Raised if detach() has already been invoked on this object.
    WRONG_DOCUMENT_ERR: Raised if refNode was created from a different document than the one that created this range.

method:setEndAfter(org.w3c.dom.Node) [NONE]

  • setEndAfter

    void setEndAfter​(Node refNode)
          throws RangeException,
                 DOMException
    Sets the end of a Range to be after a node
    Parameters:
    refNode - Range ends after refNode.
    Throws:
    RangeException - INVALID_NODE_TYPE_ERR: Raised if the root container of refNode is not an Attr, Document or DocumentFragment node or if refNode is a Document, DocumentFragment, Attr, Entity, or Notation node.
    DOMException - INVALID_STATE_ERR: Raised if detach() has already been invoked on this object.
    WRONG_DOCUMENT_ERR: Raised if refNode was created from a different document than the one that created this range.

method:collapse(boolean) [NONE]

  • collapse

    void collapse​(boolean toStart)
       throws DOMException
    Collapse a Range onto one of its boundary-points
    Parameters:
    toStart - If TRUE, collapses the Range onto its start; if FALSE, collapses it onto its end.
    Throws:
    DOMException - INVALID_STATE_ERR: Raised if detach() has already been invoked on this object.

method:selectNode(org.w3c.dom.Node) [NONE]

  • selectNode

    void selectNode​(Node refNode)
         throws RangeException,
                DOMException
    Select a node and its contents
    Parameters:
    refNode - The node to select.
    Throws:
    RangeException - INVALID_NODE_TYPE_ERR: Raised if an ancestor of refNode is an Entity, Notation or DocumentType node or if refNode is a Document, DocumentFragment, Attr, Entity, or Notation node.
    DOMException - INVALID_STATE_ERR: Raised if detach() has already been invoked on this object.
    WRONG_DOCUMENT_ERR: Raised if refNode was created from a different document than the one that created this range.

method:selectNodeContents(org.w3c.dom.Node) [NONE]

  • selectNodeContents

    void selectNodeContents​(Node refNode)
                 throws RangeException,
                        DOMException
    Select the contents within a node
    Parameters:
    refNode - Node to select from
    Throws:
    RangeException - INVALID_NODE_TYPE_ERR: Raised if refNode or an ancestor of refNode is an Entity, Notation or DocumentType node.
    DOMException - INVALID_STATE_ERR: Raised if detach() has already been invoked on this object.
    WRONG_DOCUMENT_ERR: Raised if refNode was created from a different document than the one that created this range.

method:compareBoundaryPoints(short,org.w3c.dom.ranges.Range) [NONE]

  • compareBoundaryPoints

    short compareBoundaryPoints​(short how,
                            Range sourceRange)
                     throws DOMException
    Compare the boundary-points of two Ranges in a document.
    Parameters:
    how - A code representing the type of comparison, as defined above.
    sourceRange - The Range on which this current Range is compared to.
    Returns:
    -1, 0 or 1 depending on whether the corresponding boundary-point of the Range is respectively before, equal to, or after the corresponding boundary-point of sourceRange.
    Throws:
    DOMException - WRONG_DOCUMENT_ERR: Raised if the two Ranges are not in the same Document or DocumentFragment.
    INVALID_STATE_ERR: Raised if detach() has already been invoked on this object.

method:deleteContents() [NONE]

  • deleteContents

    void deleteContents()
             throws DOMException
    Removes the contents of a Range from the containing document or document fragment without returning a reference to the removed content.
    Throws:
    DOMException - NO_MODIFICATION_ALLOWED_ERR: Raised if any portion of the content of the Range is read-only or any of the nodes that contain any of the content of the Range are read-only.
    INVALID_STATE_ERR: Raised if detach() has already been invoked on this object.

method:extractContents() [NONE]

  • extractContents

    DocumentFragment extractContents()
                          throws DOMException
    Moves the contents of a Range from the containing document or document fragment to a new DocumentFragment.
    Returns:
    A DocumentFragment containing the extracted contents.
    Throws:
    DOMException - NO_MODIFICATION_ALLOWED_ERR: Raised if any portion of the content of the Range is read-only or any of the nodes which contain any of the content of the Range are read-only.
    HIERARCHY_REQUEST_ERR: Raised if a DocumentType node would be extracted into the new DocumentFragment.
    INVALID_STATE_ERR: Raised if detach() has already been invoked on this object.

method:cloneContents() [NONE]

  • cloneContents

    DocumentFragment cloneContents()
                        throws DOMException
    Duplicates the contents of a Range
    Returns:
    A DocumentFragment that contains content equivalent to this Range.
    Throws:
    DOMException - HIERARCHY_REQUEST_ERR: Raised if a DocumentType node would be extracted into the new DocumentFragment.
    INVALID_STATE_ERR: Raised if detach() has already been invoked on this object.

method:insertNode(org.w3c.dom.Node) [NONE]

  • insertNode

    void insertNode​(Node newNode)
         throws DOMException,
                RangeException
    Inserts a node into the Document or DocumentFragment at the start of the Range. If the container is a Text node, this will be split at the start of the Range (as if the Text node's splitText method was performed at the insertion point) and the insertion will occur between the two resulting Text nodes. Adjacent Text nodes will not be automatically merged. If the node to be inserted is a DocumentFragment node, the children will be inserted rather than the DocumentFragment node itself.
    Parameters:
    newNode - The node to insert at the start of the Range
    Throws:
    DOMException - NO_MODIFICATION_ALLOWED_ERR: Raised if an ancestor container of the start of the Range is read-only.
    WRONG_DOCUMENT_ERR: Raised if newNode and the container of the start of the Range were not created from the same document.
    HIERARCHY_REQUEST_ERR: Raised if the container of the start of the Range is of a type that does not allow children of the type of newNode or if newNode is an ancestor of the container.
    INVALID_STATE_ERR: Raised if detach() has already been invoked on this object.
    RangeException - INVALID_NODE_TYPE_ERR: Raised if newNode is an Attr, Entity, Notation, or Document node.

method:surroundContents(org.w3c.dom.Node) [NONE]

  • surroundContents

    void surroundContents​(Node newParent)
               throws DOMException,
                      RangeException
    Reparents the contents of the Range to the given node and inserts the node at the position of the start of the Range.
    Parameters:
    newParent - The node to surround the contents with.
    Throws:
    DOMException - NO_MODIFICATION_ALLOWED_ERR: Raised if an ancestor container of either boundary-point of the Range is read-only.
    WRONG_DOCUMENT_ERR: Raised if newParent and the container of the start of the Range were not created from the same document.
    HIERARCHY_REQUEST_ERR: Raised if the container of the start of the Range is of a type that does not allow children of the type of newParent or if newParent is an ancestor of the container or if node would end up with a child node of a type not allowed by the type of node.
    INVALID_STATE_ERR: Raised if detach() has already been invoked on this object.
    RangeException - BAD_BOUNDARYPOINTS_ERR: Raised if the Range partially selects a non-text node.
    INVALID_NODE_TYPE_ERR: Raised if node is an Attr, Entity, DocumentType, Notation, Document, or DocumentFragment node.

method:cloneRange() [NONE]

  • cloneRange

    Range cloneRange()
          throws DOMException
    Produces a new Range whose boundary-points are equal to the boundary-points of the Range.
    Returns:
    The duplicated Range.
    Throws:
    DOMException - INVALID_STATE_ERR: Raised if detach() has already been invoked on this object.

method:toString() [NONE]

  • toString

    String toString()
         throws DOMException
    Returns the contents of a Range as a string. This string contains only the data characters, not any markup.
    Overrides:
    toString in class Object
    Returns:
    The contents of the Range.
    Throws:
    DOMException - INVALID_STATE_ERR: Raised if detach() has already been invoked on this object.

method:detach() [NONE]

  • detach

    void detach()
     throws DOMException
    Called to indicate that the Range is no longer in use and that the implementation may relinquish any resources associated with this Range. Subsequent calls to any methods or attribute getters on this Range will result in a DOMException being thrown with an error code of INVALID_STATE_ERR.
    Throws:
    DOMException - INVALID_STATE_ERR: Raised if detach() has already been invoked on this object.

© 2019 Oracle Corporation and/or its affiliates