class Comment
package js.html
extends CharacterData › Node › EventTarget
@:native("Comment")Available on js
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. Comments are represented in HTML and XML as content between '!--' and '--'. In XML, the character sequence '--' cannot be used within a comment.
Documentation Comment by Mozilla Contributors, licensed under CC-BY-SA 2.5.
See also:
Constructor
Inherited Variables
Defined by CharacterData
read onlylength:Int
Returns an unsigned long representing the size of the string contained in CharacterData.data.
Defined by Node
read onlybaseURI:String
Returns a DOMString representing the base URL. The concept of base URL changes from one language to another; in HTML, it corresponds to the protocol, the domain name and the directory structure, that is all until the last '/'.
read onlychildNodes:NodeList
read onlyfirstChild:Node
Returns a Node representing the first direct child node of the node, or null if the node has no child.
read onlyisConnected:Bool
Returns a boolean indicating whether or not the Node is connected (directly or indirectly) to the context object, e.g. the Document object in the case of the normal DOM, or the ShadowRoot in the case of a shadow DOM.
read onlylastChild:Node
Returns a Node representing the last direct child node of the node, or null if the node has no child.
read onlynextSibling:Node
Returns a Node representing the next node in the tree, or null if there isn't such node.
read onlynodeName:String
Returns a DOMString containing the name of the Node. The structure of the name will differ with the node type. E.g. An HTMLElement will contain the name of the corresponding tag, like 'audio' for an HTMLAudioElement, a Text node will have the '#text' string, or a Document node will have the '#document' string.
read onlynodeType:Int
Returns an unsigned short representing the type of the node. Possible values are:
ELEMENT_NODE |
1 |
ATTRIBUTE_NODE (deprecated) |
2 |
TEXT_NODE |
3 |
CDATA_SECTION_NODE (deprecated) |
4 |
ENTITY_REFERENCE_NODE (deprecated) |
5 |
ENTITY_NODE (deprecated) |
6 |
PROCESSING_INSTRUCTION_NODE |
7 |
COMMENT_NODE |
8 |
DOCUMENT_NODE |
9 |
DOCUMENT_TYPE_NODE |
10 |
DOCUMENT_FRAGMENT_NODE |
11 |
NOTATION_NODE (deprecated) |
12 |
read onlyownerDocument:HTMLDocument
Returns the Document that this node belongs to. If the node is itself a document, returns null.
read onlyparentElement:Element
read onlyparentNode:Node
Returns a Node that is the parent of this node. If there is no such node, like if this node is the top of the tree or if doesn't participate in a tree, this property returns null.
read onlypreviousSibling:Node
Returns a Node representing the previous node in the tree, or null if there isn't such node.
Inherited Methods
Defined by CharacterData
appendData(data:String):Void
Appends the given DOMString to the CharacterData.data string; when this method returns, data contains the concatenated DOMString.
Throws:
null | DOMError |
|---|
deleteData(offset:Int, count:Int):Void
Removes the specified amount of characters, starting at the specified offset, from the CharacterData.data string; when this method returns, data contains the shortened DOMString.
Throws:
null | DOMError |
|---|
insertData(offset:Int, data:String):Void
Inserts the specified characters, at the specified offset, in the CharacterData.data string; when this method returns, data contains the modified DOMString.
Throws:
null | DOMError |
|---|
replaceData(offset:Int, count:Int, data:String):Void
Replaces the specified amount of characters, starting at the specified offset, with the specified DOMString; when this method returns, data contains the modified DOMString.
Throws:
null | DOMError |
|---|
substringData(offset:Int, count:Int):String
Returns a DOMString containing the part of CharacterData.data of the specified length and starting at the specified offset.
Throws:
null | DOMError |
|---|
Defined by Node
appendChild(node:Node):Node
Adds the specified childNode argument as the last child to the current node.
If the argument referenced an existing node on the DOM tree, the node will be detached from its current position and attached at the new position.
@throws DOMError
@:value({ deep : false })cloneNode(deep:Bool = false):Node
Clone a Node, and optionally, all of its contents. By default, it clones the content of the node.
Throws:
null | DOMError |
|---|
compareDocumentPosition(other:Node):Int
Compares the position of the current node against another node in any other document.
contains(other:Node):Bool
Returns a Boolean value indicating whether a node is a descendant of a given node or not.
getRootNode(?options:Null<GetRootNodeOptions>):Node
Returns the context object's root which optionally includes the shadow root if it is available.
insertBefore(node:Node, child:Node):Node
isDefaultNamespace(namespace:String):Bool
isEqualNode(node:Node):Bool
Returns a Boolean which indicates whether or not two nodes are of the same type and all their defining data points match.
isSameNode(node:Node):Bool
Returns a Boolean value indicating whether or not the two nodes are the same (that is, they reference the same object).
lookupNamespaceURI(prefix:String):String
Accepts a prefix and returns the namespace URI associated with it on the given node if found (and null if not). Supplying null for the prefix will return the default namespace.
lookupPrefix(namespace:String):String
Returns a DOMString containing the prefix for a given namespace URI, if present, and null if not. When multiple prefixes are possible, the result is implementation-dependent.
removeChild(child:Node):Node
Removes a child node from the current element, which must be a child of the current node.
Throws:
null | DOMError |
|---|
replaceChild(node:Node, child:Node):Node
Replaces one child Node of the current one with the second one given in parameter.
Throws:
null | DOMError |
|---|