OpenJDK 27 · org.w3c.dom.ranges.Range · APIdia, the JavaDoc alternative

Modifier and Type	Field and Description
public static final short	END_TO_END Compare end boundary-point of `sourceRange` to end boundary-point of Range on which `compareBoundaryPoints` is invoked.
public static final short	END_TO_START Compare end boundary-point of `sourceRange` to start boundary-point of Range on which `compareBoundaryPoints` is invoked.
public static final short	START_TO_END Compare start boundary-point of `sourceRange` to end boundary-point of Range on which `compareBoundaryPoints` is invoked.
public static final short	START_TO_START Compare start boundary-point of `sourceRange` to start boundary-point of Range on which `compareBoundaryPoints` is invoked.

Method Summary

Modifier and Type	Method and Description
public DocumentFragment	Returns: A DocumentFragment that contains content equivalent to this Range. cloneContents() Duplicates the contents of a Range
public Range	Returns: The duplicated Range. cloneRange() Produces a new Range whose boundary-points are equal to the boundary-points of the Range.
public void	collapse(boolean If TRUE, collapses the Range onto its start; if FALSE, collapses it onto its end. toStart) Collapse a Range onto one of its boundary-points
public short	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`. compareBoundaryPoints(short A code representing the type of comparison, as defined above. how, Range The `Range` on which this current `Range` is compared to. sourceRange) Compare the boundary-points of two Ranges in a document.
public void	deleteContents() Removes the contents of a Range from the containing document or document fragment without returning a reference to the removed content.
public void	detach() Called to indicate that the Range is no longer in use and that the implementation may relinquish any resources associated with this Range.
public DocumentFragment	Returns: A DocumentFragment containing the extracted contents. extractContents() Moves the contents of a Range from the containing document or document fragment to a new DocumentFragment.
public boolean	getCollapsed() TRUE if the Range is collapsed
public Node	getCommonAncestorContainer() The deepest common ancestor container of the Range's two boundary-points.
public Node	getEndContainer() Node within which the Range ends
public int	getEndOffset() Offset within the ending node of the Range.
public Node	getStartContainer() Node within which the Range begins
public int	getStartOffset() Offset within the starting node of the Range.
public void	insertNode(Node The node to insert at the start of the Range newNode) Inserts a node into the Document or DocumentFragment at the start of the Range.
public void	selectNode(Node The node to select. refNode) Select a node and its contents
public void	selectNodeContents(Node Node to select from refNode) Select the contents within a node
public void	setEnd(Node The `refNode` value. This parameter must be different from `null`. refNode, int The `endOffset` value. offset) Sets the attributes describing the end of a Range.
public void	setEndAfter(Node Range ends after `refNode`. refNode) Sets the end of a Range to be after a node
public void	setEndBefore(Node Range ends before `refNode` refNode) Sets the end position to be before a node.
public void	setStart(Node The `refNode` value. This parameter must be different from `null`. refNode, int The `startOffset` value. offset) Sets the attributes describing the start of the Range.
public void	setStartAfter(Node Range starts after `refNode` refNode) Sets the start position to be after a node
public void	setStartBefore(Node Range starts before `refNode` refNode) Sets the start position to be before a node
public void	surroundContents(Node The node to surround the contents with. newParent) Reparents the contents of the Range to the given node and inserts the node at the position of the start of the Range.
public String	Returns: The contents of the Range. toString() Returns the contents of a Range as a string.

END_TO_END	back to summary
public static final short END_TO_END Compare end boundary-point of `sourceRange` to end boundary-point of Range on which `compareBoundaryPoints` is invoked.

END_TO_START	back to summary
public static final short END_TO_START Compare end boundary-point of `sourceRange` to start boundary-point of Range on which `compareBoundaryPoints` is invoked.

START_TO_END	back to summary
public static final short START_TO_END Compare start boundary-point of `sourceRange` to end boundary-point of Range on which `compareBoundaryPoints` is invoked.

START_TO_START	back to summary
public static final short START_TO_START Compare start boundary-point of `sourceRange` to start boundary-point of Range on which `compareBoundaryPoints` is invoked.

Method Detail

cloneContents back to summary

cloneContents	back to summary
public DocumentFragment cloneContents() throws DOMException Duplicates the contents of a Range Returns:DocumentFragment A DocumentFragment that contains content equivalent to this Range. Exceptions 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.

public DocumentFragment cloneContents() throws DOMException

Duplicates the contents of a Range

Returns:DocumentFragment

A DocumentFragment that contains content equivalent to this Range.

Exceptions

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.

cloneRange back to summary

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

public Range cloneRange() throws DOMException

Produces a new Range whose boundary-points are equal to the boundary-points of the Range.

Returns:Range

The duplicated Range.

Exceptions

DOMException:: INVALID_STATE_ERR: Raised if detach() has already been invoked on this object.

collapse back to summary

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

public void collapse(boolean toStart) throws DOMException

Collapse a Range onto one of its boundary-points

Parameters

toStart:boolean: If TRUE, collapses the Range onto its start; if FALSE, collapses it onto its end.

Exceptions

DOMException:: INVALID_STATE_ERR: Raised if detach() has already been invoked on this object.

compareBoundaryPoints back to summary

compareBoundaryPoints	back to summary
public short compareBoundaryPoints(short how, Range sourceRange) throws DOMException Compare the boundary-points of two Ranges in a document. Parameters how:short A code representing the type of comparison, as defined above. sourceRange:Range The `Range` on which this current `Range` is compared to. Returns:short -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`. Exceptions 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.

public short compareBoundaryPoints(short how, Range sourceRange) throws DOMException

Compare the boundary-points of two Ranges in a document.

Parameters

how:short: A code representing the type of comparison, as defined above.
sourceRange:Range: The Range on which this current Range is compared to.

Returns:short

-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.

Exceptions

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.

deleteContents back to summary

deleteContents	back to summary
public 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. Exceptions 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.

public 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.

Exceptions

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.

detach back to summary

detach	back to summary
public 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`. Exceptions DOMException: INVALID_STATE_ERR: Raised if `detach()` has already been invoked on this object.

public 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.

Exceptions

DOMException:: INVALID_STATE_ERR: Raised if detach() has already been invoked on this object.

extractContents back to summary

extractContents	back to summary
public DocumentFragment extractContents() throws DOMException Moves the contents of a Range from the containing document or document fragment to a new DocumentFragment. Returns:DocumentFragment A DocumentFragment containing the extracted contents. Exceptions 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.

public DocumentFragment extractContents() throws DOMException

Moves the contents of a Range from the containing document or document fragment to a new DocumentFragment.

Returns:DocumentFragment

A DocumentFragment containing the extracted contents.

Exceptions

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.

getCollapsed back to summary

getCollapsed	back to summary
public boolean getCollapsed() throws DOMException TRUE if the Range is collapsed Exceptions DOMException: INVALID_STATE_ERR: Raised if `detach()` has already been invoked on this object.

public boolean getCollapsed() throws DOMException

TRUE if the Range is collapsed

Exceptions

DOMException:: INVALID_STATE_ERR: Raised if detach() has already been invoked on this object.

getCommonAncestorContainer back to summary

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

public Node getCommonAncestorContainer() throws DOMException

The deepest common ancestor container of the Range's two boundary-points.

Exceptions

DOMException:: INVALID_STATE_ERR: Raised if detach() has already been invoked on this object.

getEndContainer back to summary

getEndContainer	back to summary
public Node getEndContainer() throws DOMException Node within which the Range ends Exceptions DOMException: INVALID_STATE_ERR: Raised if `detach()` has already been invoked on this object.

public Node getEndContainer() throws DOMException

Node within which the Range ends

Exceptions

DOMException:: INVALID_STATE_ERR: Raised if detach() has already been invoked on this object.

getEndOffset back to summary

getEndOffset	back to summary
public int getEndOffset() throws DOMException Offset within the ending node of the Range. Exceptions DOMException: INVALID_STATE_ERR: Raised if `detach()` has already been invoked on this object.

public int getEndOffset() throws DOMException

Offset within the ending node of the Range.

Exceptions

DOMException:: INVALID_STATE_ERR: Raised if detach() has already been invoked on this object.

getStartContainer back to summary

getStartContainer	back to summary
public Node getStartContainer() throws DOMException Node within which the Range begins Exceptions DOMException: INVALID_STATE_ERR: Raised if `detach()` has already been invoked on this object.

public Node getStartContainer() throws DOMException

Node within which the Range begins

Exceptions

DOMException:: INVALID_STATE_ERR: Raised if detach() has already been invoked on this object.

getStartOffset back to summary

getStartOffset	back to summary
public int getStartOffset() throws DOMException Offset within the starting node of the Range. Exceptions DOMException: INVALID_STATE_ERR: Raised if `detach()` has already been invoked on this object.

public int getStartOffset() throws DOMException

Offset within the starting node of the Range.

Exceptions

DOMException:: INVALID_STATE_ERR: Raised if detach() has already been invoked on this object.

insertNode back to summary

insertNode	back to summary
public 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:Node The node to insert at the start of the Range Exceptions 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.

public 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:Node: The node to insert at the start of the Range

Exceptions

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.

selectNode back to summary

selectNode	back to summary
public void selectNode(Node refNode) throws RangeException, DOMException Select a node and its contents Parameters refNode:Node The node to select. Exceptions 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.

public void selectNode(Node refNode) throws RangeException, DOMException

Select a node and its contents

Parameters

refNode:Node: The node to select.

Exceptions

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.

selectNodeContents back to summary

selectNodeContents	back to summary
public void selectNodeContents(Node refNode) throws RangeException, DOMException Select the contents within a node Parameters refNode:Node Node to select from Exceptions 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.

public void selectNodeContents(Node refNode) throws RangeException, DOMException

Select the contents within a node

Parameters

refNode:Node: Node to select from

Exceptions

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.

setEnd back to summary

setEnd	back to summary
public void setEnd(Node refNode, int offset) throws RangeException, DOMException Sets the attributes describing the end of a Range. Parameters refNode:Node The `refNode` value. This parameter must be different from `null`. offset:int The `endOffset` value. Exceptions 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.

public void setEnd(Node refNode, int offset) throws RangeException, DOMException

Sets the attributes describing the end of a Range.

Parameters

refNode:Node: The refNode value. This parameter must be different from null.
offset:int: The endOffset value.

Exceptions

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.

setEndAfter back to summary

setEndAfter	back to summary
public void setEndAfter(Node refNode) throws RangeException, DOMException Sets the end of a Range to be after a node Parameters refNode:Node Range ends after `refNode`. Exceptions 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.

public void setEndAfter(Node refNode) throws RangeException, DOMException

Sets the end of a Range to be after a node

Parameters

refNode:Node: Range ends after refNode.

Exceptions

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.

setEndBefore back to summary

setEndBefore	back to summary
public void setEndBefore(Node refNode) throws RangeException, DOMException Sets the end position to be before a node. Parameters refNode:Node Range ends before `refNode` Exceptions 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.

public void setEndBefore(Node refNode) throws RangeException, DOMException

Sets the end position to be before a node.

Parameters

refNode:Node: Range ends before refNode

Exceptions

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.

setStart back to summary

setStart	back to summary
public void setStart(Node refNode, int offset) throws RangeException, DOMException Sets the attributes describing the start of the Range. Parameters refNode:Node The `refNode` value. This parameter must be different from `null`. offset:int The `startOffset` value. Exceptions 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.

public void setStart(Node refNode, int offset) throws RangeException, DOMException

Sets the attributes describing the start of the Range.

Parameters

refNode:Node: The refNode value. This parameter must be different from null.
offset:int: The startOffset value.

Exceptions

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.

setStartAfter back to summary

setStartAfter	back to summary
public void setStartAfter(Node refNode) throws RangeException, DOMException Sets the start position to be after a node Parameters refNode:Node Range starts after `refNode` Exceptions 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.

public void setStartAfter(Node refNode) throws RangeException, DOMException

Sets the start position to be after a node

Parameters

refNode:Node: Range starts after refNode

Exceptions

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.

setStartBefore back to summary

setStartBefore	back to summary
public void setStartBefore(Node refNode) throws RangeException, DOMException Sets the start position to be before a node Parameters refNode:Node Range starts before `refNode` Exceptions 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.

public void setStartBefore(Node refNode) throws RangeException, DOMException

Sets the start position to be before a node

Parameters

refNode:Node: Range starts before refNode

Exceptions

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.

surroundContents back to summary

surroundContents	back to summary
public 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:Node The node to surround the contents with. Exceptions 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.

public 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:Node: The node to surround the contents with.

Exceptions

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.

toString back to summary

toString	back to summary
public String toString() throws DOMException Returns the contents of a Range as a string. This string contains only the data characters, not any markup. Returns:String The contents of the Range. Exceptions DOMException: INVALID_STATE_ERR: Raised if `detach()` has already been invoked on this object.

public String toString() throws DOMException

Returns the contents of a Range as a string. This string contains only the data characters, not any markup.

Returns:String

The contents of the Range.

Exceptions

DOMException:: INVALID_STATE_ERR: Raised if detach() has already been invoked on this object.

public Interface Range

Field Summary

Method Summary

Field Detail

Method Detail