Range (GWT 2.7.0)

All Known Implementing Classes:

JsRange
```
public interface Range
```
The Range object represents a fragment of a document that can contain nodes and parts of text nodes in a given document.

A range can be created using the Document.createRange method of the Document object. Range objects can also be retrieved by using the Selection.getRangeAt method of the Selection object.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`END_TO_END`
`static int`	`END_TO_START`
`static int`	`NODE_AFTER`
`static int`	`NODE_BEFORE`
`static int`	`NODE_BEFORE_AND_AFTER`
`static int`	`NODE_INSIDE`
`static int`	`START_TO_END`
`static int`	`START_TO_START`

Method Summary

Methods
Modifier and Type	Method and Description
`DocumentFragment`	`cloneContents()` Returns a `DocumentFragment` copying the nodes of a Range.
`Range`	`cloneRange()` Returns a Range object with boundary points identical to the cloned Range.
`void`	`collapse(boolean toStart)` Collapses the Range to one of its boundary points.
`short`	`compareNode(Node refNode)` Returns a constant representing whether the Node is before, after, inside, or surrounding the range.
`short`	`comparePoint(Node refNode, int offset)` Returns -1, 0, or 1 indicating whether the point occurs before, inside, or after the range.
`DocumentFragment`	`createContextualFragment(String html)` Returns a `DocumentFragment` created from a given string of code.
`void`	`deleteContents()` Removes the contents of a Range from the `Document` .
`void`	`detach()` Releases Range from use to improve performance.
`void`	`expand(String unit)`
`DocumentFragment`	`extractContents()` Moves contents of a Range from the document tree into a `DocumentFragment` .
`ClientRect`	`getBoundingClientRect()` Returns a `ClientRect` object which bounds the entire contents of the range; this would be the union of all the rectangles returned by `range.getClientRects()` .
`ClientRectList`	`getClientRects()` Returns a list of `ClientRect` objects that aggregates the results of `Element.getClientRects()` for all the elements in the range.
`Node`	`getCommonAncestorContainer()` Returns the deepest `Node` that contains the startContainer and endContainer Nodes.
`Node`	`getEndContainer()` Returns the `Node` within which the Range ends.
`int`	`getEndOffset()` Returns a number representing where in the endContainer the Range ends.
`Node`	`getStartContainer()` Returns the `Node` within which the Range starts.
`int`	`getStartOffset()` Returns a number representing where in the startContainer the Range starts.
`void`	`insertNode(Node newNode)` Insert a `Node` at the start of a Range.
`boolean`	`intersectsNode(Node refNode)` Returns a `boolean` indicating whether the given node intersects the range.
`boolean`	`isCollapsed()` Returns a `boolean` indicating whether the range's start and end points are at the same position.
`boolean`	`isPointInRange(Node refNode, int offset)` Returns a `boolean` indicating whether the given point is in the range.
`void`	`selectNode(Node refNode)` Sets the Range to contain the `Node` and its contents.
`void`	`selectNodeContents(Node refNode)` Sets the Range to contain the contents of a `Node` .
`void`	`setEnd(Node refNode, int offset)` Sets the end position of a Range.
`void`	`setEndAfter(Node refNode)` Sets the end position of a Range relative to another `Node` .
`void`	`setEndBefore(Node refNode)` Sets the end position of a Range relative to another `Node` .
`void`	`setStart(Node refNode, int offset)` Sets the start position of a Range.
`void`	`setStartAfter(Node refNode)` Sets the start position of a Range relative to another `Node` .
`void`	`setStartBefore(Node refNode)` Sets the start position of a Range relative to another `Node` .
`void`	`surroundContents(Node newParent)` Moves content of a Range into a new `Node` .

- Field Detail
  - END_TO_END
```
static final int END_TO_END
```
    See Also:
    Constant Field Values
  - END_TO_START
```
static final int END_TO_START
```
    See Also:
    Constant Field Values
  - NODE_AFTER
```
static final int NODE_AFTER
```
    See Also:
    Constant Field Values
  - NODE_BEFORE
```
static final int NODE_BEFORE
```
    See Also:
    Constant Field Values
  - NODE_BEFORE_AND_AFTER
```
static final int NODE_BEFORE_AND_AFTER
```
    See Also:
    Constant Field Values
  - NODE_INSIDE
```
static final int NODE_INSIDE
```
    See Also:
    Constant Field Values
  - START_TO_END
```
static final int START_TO_END
```
    See Also:
    Constant Field Values
  - START_TO_START
```
static final int START_TO_START
```
    See Also:
    Constant Field Values
- Method Detail
  - isCollapsed
```
boolean isCollapsed()
```
    Returns a boolean indicating whether the range's start and end points are at the same position.
  - getCommonAncestorContainer
```
Node getCommonAncestorContainer()
```
    Returns the deepest Node that contains the startContainer and endContainer Nodes.
  - getEndContainer
```
Node getEndContainer()
```
    Returns the Node within which the Range ends.
  - getEndOffset
```
int getEndOffset()
```
    Returns a number representing where in the endContainer the Range ends.
  - getStartContainer
```
Node getStartContainer()
```
    Returns the Node within which the Range starts.
  - getStartOffset
```
int getStartOffset()
```
    Returns a number representing where in the startContainer the Range starts.
  - cloneContents
```
DocumentFragment cloneContents()
```
    Returns a DocumentFragment copying the nodes of a Range.
  - cloneRange
```
Range cloneRange()
```
    Returns a Range object with boundary points identical to the cloned Range.
  - collapse
```
void collapse(boolean toStart)
```
    Collapses the Range to one of its boundary points.
  - compareNode
```
short compareNode(Node refNode)
```
    Returns a constant representing whether the Node is before, after, inside, or surrounding the range.
  - comparePoint
```
short comparePoint(Node refNode,
                 int offset)
```
    Returns -1, 0, or 1 indicating whether the point occurs before, inside, or after the range.
  - createContextualFragment
```
DocumentFragment createContextualFragment(String html)
```
    Returns a DocumentFragment created from a given string of code.
  - deleteContents
```
void deleteContents()
```
    Removes the contents of a Range from the Document .
  - detach
```
void detach()
```
    Releases Range from use to improve performance.
  - expand
```
void expand(String unit)
```
  - extractContents
```
DocumentFragment extractContents()
```
    Moves contents of a Range from the document tree into a DocumentFragment .
  - getBoundingClientRect
```
ClientRect getBoundingClientRect()
```
    Returns a ClientRect object which bounds the entire contents of the range; this would be the union of all the rectangles returned by range.getClientRects() .
  - getClientRects
```
ClientRectList getClientRects()
```
    Returns a list of ClientRect objects that aggregates the results of Element.getClientRects() for all the elements in the range.
  - insertNode
```
void insertNode(Node newNode)
```
    Insert a Node at the start of a Range.
  - intersectsNode
```
boolean intersectsNode(Node refNode)
```
    Returns a boolean indicating whether the given node intersects the range.
  - isPointInRange
```
boolean isPointInRange(Node refNode,
                     int offset)
```
    Returns a boolean indicating whether the given point is in the range.
  - selectNode
```
void selectNode(Node refNode)
```
    Sets the Range to contain the Node and its contents.
  - selectNodeContents
```
void selectNodeContents(Node refNode)
```
    Sets the Range to contain the contents of a Node .
  - setEnd
```
void setEnd(Node refNode,
          int offset)
```
    Sets the end position of a Range.
  - setEndAfter
```
void setEndAfter(Node refNode)
```
    Sets the end position of a Range relative to another Node .
  - setEndBefore
```
void setEndBefore(Node refNode)
```
    Sets the end position of a Range relative to another Node .
  - setStart
```
void setStart(Node refNode,
            int offset)
```
    Sets the start position of a Range.
  - setStartAfter
```
void setStartAfter(Node refNode)
```
    Sets the start position of a Range relative to another Node .
  - setStartBefore
```
void setStartBefore(Node refNode)
```
    Sets the start position of a Range relative to another Node .
  - surroundContents
```
void surroundContents(Node newParent)
```
    Moves content of a Range into a new Node .

Interface Range

Field Summary

Method Summary

Field Detail

END_TO_END

END_TO_START

NODE_AFTER

NODE_BEFORE

NODE_BEFORE_AND_AFTER

NODE_INSIDE

START_TO_END

START_TO_START

Method Detail

isCollapsed

getCommonAncestorContainer

getEndContainer

getEndOffset

getStartContainer

getStartOffset

cloneContents

cloneRange

collapse

compareNode

comparePoint

createContextualFragment

deleteContents

detach

expand

extractContents

getBoundingClientRect

getClientRects

insertNode

intersectsNode

isPointInRange

selectNode

selectNodeContents

setEnd

setEndAfter

setEndBefore

setStart

setStartAfter

setStartBefore

surroundContents