Comment

open class Comment(data: String = definedExternally) : CharacterData(source)

The Comment interface represents textual notations within markup; although it is generally not visually shown, such comments are available to be read in the source view.

MDN Reference

Constructors

Comment

constructor(data: String = definedExternally)

Properties

ATTRIBUTE_NODE

val ATTRIBUTE_NODE: NodeType

baseURI

val baseURI: String

The read-only baseURI property of the Node interface returns the absolute base URL of the document containing the node.

CDATA_SECTION_NODE

val CDATA_SECTION_NODE: NodeType

node is a CDATASection node.

childNodes

val childNodes: NodeList<ChildNode>

The read-only childNodes property of the Node interface returns a live the first child node is assigned index 0.

COMMENT_NODE

val COMMENT_NODE: NodeType

node is a Comment node.

data

var data: String

The data property of the CharacterData interface represent the value of the current object's data.

DOCUMENT_FRAGMENT_NODE

val DOCUMENT_FRAGMENT_NODE: NodeType

node is a DocumentFragment node.

DOCUMENT_NODE

val DOCUMENT_NODE: NodeType

node is a document.

DOCUMENT_POSITION_CONTAINED_BY

val DOCUMENT_POSITION_CONTAINED_BY: NodeType

Set when other is a descendant of node.

DOCUMENT_POSITION_CONTAINS

val DOCUMENT_POSITION_CONTAINS: NodeType

Set when other is an ancestor of node.

DOCUMENT_POSITION_DISCONNECTED

val DOCUMENT_POSITION_DISCONNECTED: NodeType

Set when node and other are not in the same tree.

DOCUMENT_POSITION_FOLLOWING

val DOCUMENT_POSITION_FOLLOWING: NodeType

Set when other is following node.

DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC

val DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC: NodeType

DOCUMENT_POSITION_PRECEDING

val DOCUMENT_POSITION_PRECEDING: NodeType

Set when other is preceding node.

DOCUMENT_TYPE_NODE

val DOCUMENT_TYPE_NODE: NodeType

node is a doctype.

ELEMENT_NODE

val ELEMENT_NODE: NodeType

node is an element.

ENTITY_NODE

val ENTITY_NODE: NodeType

ENTITY_REFERENCE_NODE

val ENTITY_REFERENCE_NODE: NodeType

firstChild

val firstChild: ChildNode?

The read-only firstChild property of the Node interface returns the node's first child in the tree, or null if the node has no children.

isConnected

val isConnected: Boolean

The read-only isConnected property of the Node interface returns a boolean indicating whether the node is connected (directly or indirectly) to a Document object.

lastChild

val lastChild: ChildNode?

The read-only lastChild property of the Node interface returns the last child of the node, or null if there are no child nodes.

length

val length: Int

The read-only CharacterData.length property returns the number of characters in the contained data, as a positive integer.

nextElementSibling

open val nextElementSibling: Element?

Returns the first following sibling that is an element, and null otherwise.

nextSibling

val nextSibling: ChildNode?

The read-only nextSibling property of the Node interface returns the node immediately following the specified one in their parent's Node.childNodes, or returns null if the specified node is the last child in the parent element.

nodeName

val nodeName: String

The read-only nodeName property of Node returns the name of the current node as a string.

nodeType

val nodeType: NodeType

The read-only nodeType property of a Node interface is an integer that identifies what the node is.

nodeValue

var nodeValue: String?

The nodeValue property of the Node interface returns or sets the value of the current node.

NOTATION_NODE

val NOTATION_NODE: NodeType

ownerDocument

open override val ownerDocument: Document

The read-only ownerDocument property of the Node interface returns the top-level document object of the node.

parentElement

val parentElement: HTMLElement?

The read-only parentElement property of Node interface returns the DOM node's parent Element, or null if the node either has no parent, or its parent isn't a DOM Element.

parentNode

val parentNode: ParentNode?

The read-only parentNode property of the Node interface returns the parent of the specified node in the DOM tree.

previousElementSibling

open val previousElementSibling: Element?

Returns the first preceding sibling that is an element, and null otherwise.

previousSibling

val previousSibling: ChildNode?

The read-only previousSibling property of the Node interface returns the node immediately preceding the specified one in its parent's or null if the specified node is the first in that list.

PROCESSING_INSTRUCTION_NODE

val PROCESSING_INSTRUCTION_NODE: NodeType

node is a ProcessingInstruction node.

TEXT_NODE

val TEXT_NODE: NodeType

node is a Text node.

textContent

var textContent: String?

The textContent property of the Node interface represents the text content of the node and its descendants.

Functions

after

open fun after(vararg nodes: String)

open fun after(vararg nodes: Node)

Inserts nodes just after node, while replacing strings in nodes with equivalent Text nodes.

appendChild

fun <T : Node> appendChild(node: T): T

The appendChild() method of the Node interface adds a node to the end of the list of children of a specified parent node.

appendData

fun appendData(data: String)

The appendData() method of the CharacterData interface adds the provided data to the end of the node's current data.

before

open fun before(vararg nodes: String)

open fun before(vararg nodes: Node)

Inserts nodes just before node, while replacing strings in nodes with equivalent Text nodes.

cloneNode

fun cloneNode(subtree: Boolean = definedExternally): Node

The cloneNode() method of the Node interface returns a duplicate of the node on which this method was called.

compareDocumentPosition

fun compareDocumentPosition(other: Node): Short

The compareDocumentPosition() method of the Node interface reports the position of its argument node relative to the node on which it is called.

contains

fun contains(other: Node?): Boolean

The contains() method of the Node interface returns a boolean value indicating whether a node is a descendant of a given node, that is the node itself, one of its direct children (Node.childNodes), one of the children's direct children, and so on.

deleteData

fun deleteData(offset: Int, count: Int)

The deleteData() method of the CharacterData interface removes all or part of the data from this CharacterData node.

dispatchEvent

fun dispatchEvent(event: Event): Boolean

getRootNode

fun getRootNode(options: GetRootNodeOptions = definedExternally): Node

The getRootNode() method of the Node interface returns the context object's root, which optionally includes the shadow root if it is available.

hasChildNodes

fun hasChildNodes(): Boolean

The hasChildNodes() method of the Node interface returns a boolean value indicating whether the given Node has child nodes or not.

insertBefore

fun <T : Node> insertBefore(node: T, child: Node?): T

The insertBefore() method of the Node interface inserts a node before a reference node as a child of a specified parent node.

insertData

fun insertData(offset: Int, data: String)

The insertData() method of the CharacterData interface inserts the provided data into this CharacterData node's current data, at the provided offset from the start of the existing data.

isDefaultNamespace

fun isDefaultNamespace(namespace: String?): Boolean

The isDefaultNamespace() method of the Node interface accepts a namespace URI as an argument.

isEqualNode

fun isEqualNode(otherNode: Node?): Boolean

The isEqualNode() method of the Node interface tests whether two nodes are equal.

isSameNode

fun isSameNode(otherNode: Node?): Boolean

The isSameNode() method of the Node interface is a legacy alias the for the === strict equality operator.

lookupNamespaceURI

fun lookupNamespaceURI(prefix: String?): String?

The lookupNamespaceURI() method of the Node interface takes a prefix as parameter and returns the namespace URI associated with it on the given node if found (and null if not).

lookupPrefix

fun lookupPrefix(namespace: String?): String?

The lookupPrefix() method of the Node interface returns a string containing the prefix for a given namespace URI, if present, and null if not.

normalize

fun normalize()

The normalize() method of the Node interface puts the specified node and all of its sub-tree into a normalized form.

remove

open fun remove()

Removes node.

removeChild

fun <T : Node> removeChild(child: T): T

The removeChild() method of the Node interface removes a child node from the DOM and returns the removed node.

replaceChild

fun <T : Node> replaceChild(node: Node, child: T): T

The replaceChild() method of the Node interface replaces a child node within the given (parent) node.

replaceData

fun replaceData(offset: Int, count: Int, data: String)

The replaceData() method of the CharacterData interface removes a certain number of characters of the existing text in a given CharacterData node and replaces those characters with the text provided.

replaceWith

open fun replaceWith(vararg nodes: String)

open fun replaceWith(vararg nodes: Node)

Replaces node with nodes, while replacing strings in nodes with equivalent Text nodes.

substringData

fun substringData(offset: Int, count: Int): String

The substringData() method of the CharacterData interface returns a portion of the existing data, starting at the specified index and extending for a given number of characters afterwards.

when

fun <T : Event> when(type: EventType<T>, options: ObservableEventListenerOptions?): Observable<T>