Range

class Range extends JavaScriptObject

Annotations: @Unstable.new(), @Native.new("Range")

Constructors

Range() factory

factory Range()

Implementation

factory Range() => document.createRange();

Range.fromPoint() factory

factory Range.fromPoint(Point<num> point)

Implementation

factory Range.fromPoint(Point point) =>
    document._caretRangeFromPoint(point.x.toInt(), point.y.toInt());

Properties

collapsed no setter

bool get collapsed

Implementation

bool get collapsed native;

commonAncestorContainer no setter

Node get commonAncestorContainer

Implementation

Node get commonAncestorContainer native;

endContainer no setter

Node get endContainer

Implementation

Node get endContainer native;

endOffset no setter

int get endOffset

Implementation

int get endOffset native;

hashCode no setter inherited

int get hashCode

Inherited from Interceptor.

Implementation

int get hashCode => Primitives.objectHashCode(this);

runtimeType no setter inherited

Type get runtimeType

Inherited from Interceptor.

Implementation

Type get runtimeType =>
    getRuntimeTypeOfInterceptorNotArray(getInterceptor(this), this);

startContainer no setter

Node get startContainer

Implementation

Node get startContainer native;

startOffset no setter

int get startOffset

Implementation

int get startOffset native;

Methods

cloneContents()

DocumentFragment cloneContents()

Implementation

DocumentFragment cloneContents() native;

cloneRange()

Range cloneRange()

Implementation

Range cloneRange() native;

collapse()

void collapse([bool? toStart])

Implementation

void collapse([bool? toStart]) native;

compareBoundaryPoints()

int compareBoundaryPoints(int how, Range sourceRange)

Implementation

int compareBoundaryPoints(int how, Range sourceRange) native;

comparePoint()

int comparePoint(Node node, int offset)

Implementation

int comparePoint(Node node, int offset) native;

createContextualFragment()

DocumentFragment createContextualFragment(String fragment)

Implementation

DocumentFragment createContextualFragment(String fragment) native;

deleteContents()

void deleteContents()

Implementation

void deleteContents() native;

detach()

void detach()

Implementation

void detach() native;

expand()

void expand(String? unit)

Implementation

void expand(String? unit) native;

extractContents()

DocumentFragment extractContents()

Implementation

DocumentFragment extractContents() native;

getBoundingClientRect()

Rectangle<num> getBoundingClientRect()

Implementation

Rectangle getBoundingClientRect() native;

getClientRects()

List<Rectangle<num>> getClientRects()

Implementation

List<Rectangle> getClientRects() {
  var value = _getClientRects();

  &#47;&#47; If no prototype we need one for the world to hookup to the proper Dart class.
  var jsProto = JS('', '#.prototype', value);
  if (jsProto == null) {
    JS('', '#.prototype = Object.create(null)', value);
  }

  applyExtension('DOMRectList', value);

  return value;
}

insertNode()

void insertNode(Node node)

Implementation

void insertNode(Node node) native;

isPointInRange()

bool isPointInRange(Node node, int offset)

Implementation

bool isPointInRange(Node node, int offset) native;

noSuchMethod() inherited

dynamic noSuchMethod(Invocation invocation)

Invoked when a nonexistent method or property is accessed.

A dynamic member invocation can attempt to call a member which doesn't exist on the receiving object. Example:

dynamic object = 1;
object.add(42); // Statically allowed, run-time error

This invalid code will invoke the noSuchMethod method of the integer 1 with an Invocation representing the .add(42) call and arguments (which then throws).

Classes can override noSuchMethod to provide custom behavior for such invalid dynamic invocations.

A class with a non-default noSuchMethod invocation can also omit implementations for members of its interface. Example:

class MockList<T> implements List<T> {
  noSuchMethod(Invocation invocation) {
    log(invocation);
    super.noSuchMethod(invocation); // Will throw.
  }
}
void main() {
  MockList().add(42);
}

This code has no compile-time warnings or errors even though the MockList class has no concrete implementation of any of the List interface methods. Calls to List methods are forwarded to noSuchMethod, so this code will log an invocation similar to Invocation.method(#add, [42]) and then throw.

If a value is returned from noSuchMethod, it becomes the result of the original invocation. If the value is not of a type that can be returned by the original invocation, a type error occurs at the invocation.

The default behavior is to throw a NoSuchMethodError.

Inherited from Interceptor.

Implementation

dynamic noSuchMethod(Invocation invocation) {
  throw NoSuchMethodError.withInvocation(this, invocation);
}

selectNode()

void selectNode(Node node)

Implementation

void selectNode(Node node) native;

selectNodeContents()

void selectNodeContents(Node node)

Implementation

void selectNodeContents(Node node) native;

setEnd()

void setEnd(Node node, int offset)

Implementation

void setEnd(Node node, int offset) native;

setEndAfter()

void setEndAfter(Node node)

Implementation

void setEndAfter(Node node) native;

setEndBefore()

void setEndBefore(Node node)

Implementation

void setEndBefore(Node node) native;

setStart()

void setStart(Node node, int offset)

Implementation

void setStart(Node node, int offset) native;

setStartAfter()

void setStartAfter(Node node)

Implementation

void setStartAfter(Node node) native;

setStartBefore()

void setStartBefore(Node node)

Implementation

void setStartBefore(Node node) native;

surroundContents()

void surroundContents(Node newParent)

Implementation

void surroundContents(Node newParent) native;

toString() inherited

String toString()

A string representation of this object.

Some classes have a default textual representation, often paired with a static parse function (like int.parse). These classes will provide the textual representation as their string representation.

Other classes have no meaningful textual representation that a program will care about. Such classes will typically override toString to provide useful information when inspecting the object, mainly for debugging or logging.

Inherited from Interceptor.

Implementation

String toString() => Primitives.objectToHumanReadableString(this);

Operators

operator ==() inherited

bool operator ==(Object other)

The equality operator.

The default behavior for all Objects is to return true if and only if this object and other are the same object.

Override this method to specify a different equality relation on a class. The overriding method must still be an equivalence relation. That is, it must be:

• Total: It must return a boolean for all arguments. It should never throw.

• Reflexive: For all objects o, o == o must be true.

• Symmetric: For all objects o1 and o2, o1 == o2 and o2 == o1 must either both be true, or both be false.

• Transitive: For all objects o1, o2, and o3, if o1 == o2 and o2 == o3 are true, then o1 == o3 must be true.

The method should also be consistent over time, so whether two objects are equal should only change if at least one of the objects was modified.

If a subclass overrides the equality operator, it should override the hashCode method as well to maintain consistency.

Inherited from Interceptor.

Implementation

bool operator ==(Object other) => identical(this, other);

Static Properties

supportsCreateContextualFragment no setter

bool get supportsCreateContextualFragment

Checks if createContextualFragment is supported.

See also:

• createContextualFragment

Implementation

static bool get supportsCreateContextualFragment =>
    JS('bool', '("createContextualFragment" in window.Range.prototype)');

Constants

END_TO_END

const int END_TO_END

Implementation

static const int END_TO_END = 2;

END_TO_START

const int END_TO_START

Implementation

static const int END_TO_START = 3;

START_TO_END

const int START_TO_END

Implementation

static const int START_TO_END = 1;

START_TO_START

const int START_TO_START

Implementation

static const int START_TO_START = 0;