Comment#

Annotations: @Native.new("Comment")

Constructors#

Comment() factory#

factory Comment([String? data]) {
  return JS(
    'returns:Comment;depends:none;effects:none;new:true',
    '#.createComment(#)',
    document,
    data == null ? "" : data,
  );
}

Properties#

baseUri no setter inherited#

Inherited from Node.

@JSName('baseURI')
String? get baseUri native;

childNodes no setter inherited#

A list of this node's children.

Other resources

• Node.childNodes from MDN.

Inherited from Node.

@Returns('NodeList')
@Creates('NodeList')
List<Node> get childNodes native;

data read / write inherited#

Inherited from CharacterData.

String? get data native;

set data(String? value) native;

firstChild no setter inherited#

The first child of this node.

Other resources

• Node.firstChild from MDN.

Inherited from Node.

Node? get firstChild native;

hashCode no setter inherited#

Inherited from Interceptor.

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

isConnected no setter inherited#

Inherited from Node.

bool? get isConnected native;

lastChild no setter inherited#

The last child of this node.

Other resources

• Node.lastChild from MDN.

Inherited from Node.

Node? get lastChild native;

length no setter inherited#

Inherited from CharacterData.

int? get length native;

nextElementSibling no setter inherited#

Inherited from CharacterData.

Element? get nextElementSibling native;

nextNode no setter inherited#

The next sibling node.

Other resources

• Node.nextSibling from MDN.

Inherited from Node.

@JSName('nextSibling')
/**
 * The next sibling node.
 *
 * ## Other resources
 *
 * * [Node.nextSibling](https://developer.mozilla.org/en-US/docs/Web/API/Node.nextSibling)
 *   from MDN.
 */
Node? get nextNode native;

nodeName no setter inherited#

The name of this node.

This varies by this node's nodeType.

Other resources

• Node.nodeName from MDN. This page contains a table of nodeName values for each nodeType.

Inherited from Node.

String? get nodeName native;

nodes read / write inherited#

A modifiable list of this node's children.

Inherited from Node.

List<Node> get nodes {
  return new _ChildNodeListLazy(this);
}

set nodes(Iterable<Node> value) {
  &#47;&#47; Copy list first since we don't want liveness during iteration.
  &#47;&#47; TODO(jacobr): there is a better way to do this.
  var copy = value.toList();
  text = '';
  for (Node node in copy) {
    append(node);
  }
}

nodeType no setter inherited#

The type of node.

This value is one of:

• ATTRIBUTE_NODE if this node is an attribute.
• CDATA_SECTION_NODE if this node is a CDataSection.
• COMMENT_NODE if this node is a Comment.
• DOCUMENT_FRAGMENT_NODE if this node is a DocumentFragment.
• DOCUMENT_NODE if this node is a Document.
• DOCUMENT_TYPE_NODE if this node is a _DocumentType node.
• ELEMENT_NODE if this node is an Element.
• ENTITY_NODE if this node is an entity.
• ENTITY_REFERENCE_NODE if this node is an entity reference.
• NOTATION_NODE if this node is a notation.
• PROCESSING_INSTRUCTION_NODE if this node is a ProcessingInstruction.
• TEXT_NODE if this node is a Text node.

Other resources

• Node.nodeType from MDN.

Inherited from Node.

int get nodeType native;

nodeValue no setter inherited#

The value of this node.

This varies by this type's nodeType.

Other resources

• Node.nodeValue from MDN. This page contains a table of nodeValue values for each nodeType.

Inherited from Node.

String? get nodeValue native;

on no setter inherited#

This is an ease-of-use accessor for event streams which should only be used when an explicit accessor is not available.

Inherited from EventTarget.

Events get on => new Events(this);

ownerDocument no setter inherited#

The document this node belongs to.

Returns null if this node does not belong to any document.

Other resources

• Node.ownerDocument from MDN.

Inherited from Node.

Document? get ownerDocument native;

parent no setter inherited#

The parent element of this node.

Returns null if this node either does not have a parent or its parent is not an element.

Other resources

• Node.parentElement from W3C.

Inherited from Node.

@JSName('parentElement')
/**
 * The parent element of this node.
 *
 * Returns null if this node either does not have a parent or its parent is
 * not an element.
 *
 * ## Other resources
 *
 * * [Node.parentElement](https://developer.mozilla.org/en-US/docs/Web/API/Node.parentElement)
 *   from W3C.
 */
Element? get parent native;

parentNode no setter inherited#

The parent node of this node.

Other resources

• Node.parentNode from MDN.

Inherited from Node.

Node? get parentNode native;

previousElementSibling no setter inherited#

Inherited from CharacterData.

Element? get previousElementSibling native;

previousNode no setter inherited#

The previous sibling node.

Other resources

• Node.previousSibling from MDN.

Inherited from Node.

@JSName('previousSibling')
/**
 * The previous sibling node.
 *
 * ## Other resources
 *
 * * [Node.previousSibling](https://developer.mozilla.org/en-US/docs/Web/API/Node.previousSibling)
 *   from MDN.
 */
Node? get previousNode native;

runtimeType no setter inherited#

Inherited from Interceptor.

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

text read / write inherited#

All text within this node and its descendants.

Other resources

• Node.textContent from MDN.

Inherited from Node.

@JSName('textContent')
/**
 * All text within this node and its descendants.
 *
 * ## Other resources
 *
 * * [Node.textContent](https://developer.mozilla.org/en-US/docs/Web/API/Node.textContent)
 *   from MDN.
 */
String? get text native;

@JSName('textContent')
set text(String? value) native;

Methods#

addEventListener() inherited#

Inherited from EventTarget.

void addEventListener(
  String type,
  EventListener? listener, [
  bool? useCapture,
]) {
  // TODO(leafp): This check is avoid a bug in our dispatch code when
  // listener is null.  The browser treats this call as a no-op in this
  // case, so it's fine to short-circuit it, but we should not have to.
  if (listener != null) {
    _addEventListener(type, listener, useCapture);
  }
}

after() inherited#

Inherited from CharacterData.

void after(Object nodes) native;

append() inherited#

Adds a node to the end of the child nodes list of this node.

If the node already exists in this document, it will be removed from its current parent node, then added to this node.

This method is more efficient than nodes.add, and is the preferred way of appending a child node.

Inherited from Node.

@JSName('appendChild')
/**
 * Adds a node to the end of the child [nodes] list of this node.
 *
 * If the node already exists in this document, it will be removed from its
 * current parent node, then added to this node.
 *
 * This method is more efficient than `nodes.add`, and is the preferred
 * way of appending a child node.
 */
Node append(Node node) native;

appendData() inherited#

Inherited from CharacterData.

void appendData(String data) native;

before() inherited#

Inherited from CharacterData.

void before(Object nodes) native;

clone() inherited#

Returns a copy of this node.

If deep is true, then all of this node's children and descendants are copied as well. If deep is false, then only this node is copied.

Other resources

• Node.cloneNode from MDN.

Inherited from Node.

@JSName('cloneNode')
/**
 * Returns a copy of this node.
 *
 * If [deep] is `true`, then all of this node's children and descendants are
 * copied as well. If [deep] is `false`, then only this node is copied.
 *
 * ## Other resources
 *
 * * [Node.cloneNode](https://developer.mozilla.org/en-US/docs/Web/API/Node.cloneNode)
 *   from MDN.
 */
Node clone(bool? deep) native;

contains() inherited#

Returns true if this node contains the specified node.

Other resources

• Node.contains from MDN.

Inherited from Node.

bool contains(Node? other) native;

deleteData() inherited#

Inherited from CharacterData.

void deleteData(int offset, int count) native;

dispatchEvent() inherited#

Inherited from EventTarget.

bool dispatchEvent(Event event) native;

getRootNode() inherited#

Inherited from Node.

Node getRootNode([Map? options]) {
  if (options != null) {
    var options_1 = convertDartToNative_Dictionary(options);
    return _getRootNode_1(options_1);
  }
  return _getRootNode_2();
}

hasChildNodes() inherited#

Returns true if this node has any children.

Other resources

• Node.hasChildNodes from MDN.

Inherited from Node.

bool hasChildNodes() native;

insertAllBefore() inherited#

Inserts all of the nodes into this node directly before child.

See also:

• insertBefore

Inherited from Node.

void insertAllBefore(Iterable<Node> newNodes, Node child) {
  if (newNodes is _ChildNodeListLazy) {
    _ChildNodeListLazy otherList = newNodes;
    if (identical(otherList._this, this)) {
      throw new ArgumentError(newNodes);
    }

    &#47;&#47; Optimized route for copying between nodes.
    for (var i = 0, len = otherList.length; i < len; ++i) {
      this.insertBefore(otherList._this.firstChild!, child);
    }
  } else {
    for (var node in newNodes) {
      this.insertBefore(node, child);
    }
  }
}

insertBefore() inherited#

Inserts the given node into this node directly before child. If child is null, then the given node is inserted at the end of this node's child nodes.

Other resources

• Node.insertBefore from MDN.

Inherited from Node.

Node insertBefore(Node node, Node? child) native;

insertData() inherited#

Inherited from CharacterData.

void insertData(int offset, String data) native;

noSuchMethod() inherited#

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.

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

remove() inherited#

Removes this node from the DOM.

Inherited from Node.

void remove() {
  // TODO(jacobr): should we throw an exception if parent is already null?
  // TODO(vsm): Use the native remove when available.
  if (this.parentNode != null) {
    final Node parent = this.parentNode!;
    parent._removeChild(this);
  }
}

removeEventListener() inherited#

Inherited from EventTarget.

void removeEventListener(
  String type,
  EventListener? listener, [
  bool? useCapture,
]) {
  // TODO(leafp): This check is avoid a bug in our dispatch code when
  // listener is null.  The browser treats this call as a no-op in this
  // case, so it's fine to short-circuit it, but we should not have to.
  if (listener != null) {
    _removeEventListener(type, listener, useCapture);
  }
}

replaceData() inherited#

Inherited from CharacterData.

void replaceData(int offset, int count, String data) native;

replaceWith() inherited#

Replaces this node with another node.

Inherited from Node.

Node replaceWith(Node otherNode) {
  try {
    final Node parent = this.parentNode!;
    parent._replaceChild(otherNode, this);
  } catch (e) {}
  return this;
}

substringData() inherited#

Inherited from CharacterData.

String substringData(int offset, int count) native;

toString() inherited#

Print out a String representation of this Node.

Inherited from Node.

String toString() {
  String? value = nodeValue; // Fetch DOM Node property once.
  return value == null ? super.toString() : value;
}

Operators#

operator ==() inherited#

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.

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