- 
 public interface Range- Since:
- 9, DOM Level 2
 
- 
- 
Field SummaryFields Modifier and Type Field Description static shortEND_TO_ENDCompare end boundary-point ofsourceRangeto end boundary-point of Range on whichcompareBoundaryPointsis invoked.static shortEND_TO_STARTCompare end boundary-point ofsourceRangeto start boundary-point of Range on whichcompareBoundaryPointsis invoked.static shortSTART_TO_ENDCompare start boundary-point ofsourceRangeto end boundary-point of Range on whichcompareBoundaryPointsis invoked.static shortSTART_TO_STARTCompare start boundary-point ofsourceRangeto start boundary-point of Range on whichcompareBoundaryPointsis invoked.
 - 
Method SummaryAll Methods Instance Methods Abstract Methods Modifier and Type Method Description DocumentFragmentcloneContents()Duplicates the contents of a RangeRangecloneRange()Produces a new Range whose boundary-points are equal to the boundary-points of the Range.voidcollapse(boolean toStart)Collapse a Range onto one of its boundary-pointsshortcompareBoundaryPoints(short how, Range sourceRange)Compare the boundary-points of two Ranges in a document.voiddeleteContents()Removes the contents of a Range from the containing document or document fragment without returning a reference to the removed content.voiddetach()Called to indicate that the Range is no longer in use and that the implementation may relinquish any resources associated with this Range.DocumentFragmentextractContents()Moves the contents of a Range from the containing document or document fragment to a new DocumentFragment.booleangetCollapsed()TRUE if the Range is collapsedNodegetCommonAncestorContainer()The deepest common ancestor container of the Range's two boundary-points.NodegetEndContainer()Node within which the Range endsintgetEndOffset()Offset within the ending node of the Range.NodegetStartContainer()Node within which the Range beginsintgetStartOffset()Offset within the starting node of the Range.voidinsertNode(Node newNode)Inserts a node into the Document or DocumentFragment at the start of the Range.voidselectNode(Node refNode)Select a node and its contentsvoidselectNodeContents(Node refNode)Select the contents within a nodevoidsetEnd(Node refNode, int offset)Sets the attributes describing the end of a Range.voidsetEndAfter(Node refNode)Sets the end of a Range to be after a nodevoidsetEndBefore(Node refNode)Sets the end position to be before a node.voidsetStart(Node refNode, int offset)Sets the attributes describing the start of the Range.voidsetStartAfter(Node refNode)Sets the start position to be after a nodevoidsetStartBefore(Node refNode)Sets the start position to be before a nodevoidsurroundContents(Node newParent)Reparents the contents of the Range to the given node and inserts the node at the position of the start of the Range.StringtoString()Returns the contents of a Range as a string.
 
- 
- 
- 
Field Detail- 
START_TO_STARTstatic final short START_TO_START Compare start boundary-point ofsourceRangeto start boundary-point of Range on whichcompareBoundaryPointsis invoked.- See Also:
- Constant Field Values
 
 - 
START_TO_ENDstatic final short START_TO_END Compare start boundary-point ofsourceRangeto end boundary-point of Range on whichcompareBoundaryPointsis invoked.- See Also:
- Constant Field Values
 
 - 
END_TO_ENDstatic final short END_TO_END Compare end boundary-point ofsourceRangeto end boundary-point of Range on whichcompareBoundaryPointsis invoked.- See Also:
- Constant Field Values
 
 - 
END_TO_STARTstatic final short END_TO_START Compare end boundary-point ofsourceRangeto start boundary-point of Range on whichcompareBoundaryPointsis invoked.- See Also:
- Constant Field Values
 
 
- 
 - 
Method Detail- 
getStartContainerNode getStartContainer() throws DOMException Node within which the Range begins- Throws:
- DOMException- INVALID_STATE_ERR: Raised if- detach()has already been invoked on this object.
 
 - 
getStartOffsetint getStartOffset() throws DOMExceptionOffset within the starting node of the Range.- Throws:
- DOMException- INVALID_STATE_ERR: Raised if- detach()has already been invoked on this object.
 
 - 
getEndContainerNode getEndContainer() throws DOMException Node within which the Range ends- Throws:
- DOMException- INVALID_STATE_ERR: Raised if- detach()has already been invoked on this object.
 
 - 
getEndOffsetint getEndOffset() throws DOMExceptionOffset within the ending node of the Range.- Throws:
- DOMException- INVALID_STATE_ERR: Raised if- detach()has already been invoked on this object.
 
 - 
getCollapsedboolean getCollapsed() throws DOMExceptionTRUE if the Range is collapsed- Throws:
- DOMException- INVALID_STATE_ERR: Raised if- detach()has already been invoked on this object.
 
 - 
getCommonAncestorContainerNode 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.
 
 - 
setStartvoid setStart(Node refNode, int offset) throws RangeException, DOMException Sets the attributes describing the start of the Range.- Parameters:
- refNode- The- refNodevalue. This parameter must be different from- null.
- offset- The- startOffsetvalue.
- Throws:
- RangeException- INVALID_NODE_TYPE_ERR: Raised if- refNodeor an ancestor of- refNodeis an Entity, Notation, or DocumentType node.
- DOMException- INDEX_SIZE_ERR: Raised if- offsetis negative or greater than the number of child units in- refNode. Child units are 16-bit units if- refNodeis 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- refNodewas created from a different document than the one that created this range.
 
 - 
setEndvoid setEnd(Node refNode, int offset) throws RangeException, DOMException Sets the attributes describing the end of a Range.- Parameters:
- refNode- The- refNodevalue. This parameter must be different from- null.
- offset- The- endOffsetvalue.
- Throws:
- RangeException- INVALID_NODE_TYPE_ERR: Raised if- refNodeor an ancestor of- refNodeis an Entity, Notation, or DocumentType node.
- DOMException- INDEX_SIZE_ERR: Raised if- offsetis negative or greater than the number of child units in- refNode. Child units are 16-bit units if- refNodeis 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- refNodewas created from a different document than the one that created this range.
 
 - 
setStartBeforevoid 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- refNodeis not an Attr, Document, or DocumentFragment node or if- refNodeis 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- refNodewas created from a different document than the one that created this range.
 
 - 
setStartAftervoid 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- refNodeis not an Attr, Document, or DocumentFragment node or if- refNodeis 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- refNodewas created from a different document than the one that created this range.
 
 - 
setEndBeforevoid 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- refNodeis not an Attr, Document, or DocumentFragment node or if- refNodeis 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- refNodewas created from a different document than the one that created this range.
 
 - 
setEndAftervoid 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- refNodeis not an Attr, Document or DocumentFragment node or if- refNodeis 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- refNodewas created from a different document than the one that created this range.
 
 - 
collapsevoid collapse(boolean toStart) throws DOMExceptionCollapse 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.
 
 - 
selectNodevoid 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- refNodeis an Entity, Notation or DocumentType node or if- refNodeis 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- refNodewas created from a different document than the one that created this range.
 
 - 
selectNodeContentsvoid 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- refNodeor an ancestor of- refNodeis 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- refNodewas created from a different document than the one that created this range.
 
 - 
compareBoundaryPointsshort compareBoundaryPoints(short how, Range sourceRange) throws DOMExceptionCompare the boundary-points of two Ranges in a document.- Parameters:
- how- A code representing the type of comparison, as defined above.
- sourceRange- The- Rangeon which this current- Rangeis 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.
 
 - 
deleteContentsvoid deleteContents() throws DOMExceptionRemoves 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.
 
 - 
extractContentsDocumentFragment 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.
 
 - 
cloneContentsDocumentFragment 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.
 
 - 
insertNodevoid 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- newNodeand 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- newNodeor if- newNodeis 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- newNodeis an Attr, Entity, Notation, or Document node.
 
 - 
surroundContentsvoid 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- newParentand 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- newParentor if- newParentis an ancestor of the container or if- nodewould 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- nodeis an Attr, Entity, DocumentType, Notation, Document, or DocumentFragment node.
 
 - 
cloneRangeRange 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.
 
 - 
toStringString toString() throws DOMException Returns the contents of a Range as a string. This string contains only the data characters, not any markup.- Overrides:
- toStringin class- Object
- Returns:
- The contents of the Range.
- Throws:
- DOMException- INVALID_STATE_ERR: Raised if- detach()has already been invoked on this object.
 
 - 
detachvoid detach() throws DOMExceptionCalled 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 aDOMExceptionbeing thrown with an error code ofINVALID_STATE_ERR.- Throws:
- DOMException- INVALID_STATE_ERR: Raised if- detach()has already been invoked on this object.
 
 
- 
 
-