js.html.CharacterData - Haxe 4.1.3 API

The CharacterData abstract interface represents a Node object that contains characters. This is an abstract interface, meaning there aren't any object of type CharacterData: it is implemented by other interfaces, like Text, '. In XML, the character sequence '--' cannot be used within a comment.">Comment, or ProcessingInstruction which aren't abstract.

Documentation CharacterData by Mozilla Contributors, licensed under CC-BY-SA 2.5.

Variables

`data:String`

Is a DOMString representing the textual data contained in this object.

`read onlylength:Int`

Returns an unsigned long representing the size of the string contained in CharacterData.data.

`read onlynextElementSibling:Element`

`read onlypreviousElementSibling:Element`

Methods

`after(nodes:Rest<Node>):Void`

`after(nodes:Rest<String>):Void`

Throws:

`null`	DOMError

`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

`before(nodes:Rest<Node>):Void`

`before(nodes:Rest<String>):Void`

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

`remove():Void`

`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

`replaceWith(nodes:Rest<Node>):Void`

`replaceWith(nodes:Rest<String>):Void`

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

Inherited Variables

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`

Returns a live NodeList containing all the children of this node. NodeList being live means that if the children of the Node change, the NodeList object is automatically updated.

`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:

Name Value

`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`

`nodeValue:String`

Returns / Sets the value of the current node

`read onlyownerDocument:HTMLDocument`

Returns the Document that this node belongs to. If the node is itself a document, returns null.

`read onlyparentElement:Element`

Returns an Element that is the parent of this node. If the node has no parent, or if that parent is not an Element, this property returns null.

`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.

`textContent:String`

Returns / Sets the textual content of an element and all its descendants.

Inherited Methods

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.

`hasChildNodes():Bool`

Returns a Boolean indicating if the element has any child nodes, or not.

`insertBefore(node:Node, child:Node):Node`

Inserts a Node before the reference node as a child of a specified parent node.

Throws:

`null`	DOMError

`isDefaultNamespace(namespace:String):Bool`

Accepts a namespace URI as an argument and returns a Boolean with a value of true if the namespace is the default namespace on the given node or false if not.

`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.

`normalize():Void`

Clean up all the text nodes under this element (merge adjacent, remove empty).

`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

class CharacterData

package js.html

extends Node › EventTarget

extended by Comment, ProcessingInstruction, Text

Variables

data:String

read onlylength:Int

read onlynextElementSibling:Element

read onlypreviousElementSibling:Element

Methods

after(nodes:Rest<Node>):Void

after(nodes:Rest<String>):Void

appendData(data:String):Void

before(nodes:Rest<Node>):Void

before(nodes:Rest<String>):Void

deleteData(offset:Int, count:Int):Void

insertData(offset:Int, data:String):Void

remove():Void

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

replaceWith(nodes:Rest<Node>):Void

replaceWith(nodes:Rest<String>):Void

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

Inherited Variables

Defined by Node

read onlybaseURI:String

read onlychildNodes:NodeList

read onlyfirstChild:Node

read onlyisConnected:Bool

read onlylastChild:Node

read onlynextSibling:Node

read onlynodeName:String

read onlynodeType:Int

nodeValue:String

read onlyownerDocument:HTMLDocument

read onlyparentElement:Element

read onlyparentNode:Node

read onlypreviousSibling:Node

textContent:String

Inherited Methods

Defined by Node

appendChild(node:Node):Node

@:value({ deep : false })cloneNode(deep:Bool = false):Node

compareDocumentPosition(other:Node):Int

contains(other:Node):Bool

getRootNode(?options:Null<GetRootNodeOptions>):Node

hasChildNodes():Bool

insertBefore(node:Node, child:Node):Node

isDefaultNamespace(namespace:String):Bool

isEqualNode(node:Node):Bool

isSameNode(node:Node):Bool

lookupNamespaceURI(prefix:String):String

lookupPrefix(namespace:String):String

normalize():Void

removeChild(child:Node):Node

replaceChild(node:Node, child:Node):Node

Defined by EventTarget

addEventListener(type:String, listener:Function, ?options:EitherType<AddEventListenerOptions, Bool>, ?wantsUntrusted:Bool):Void

addEventListener(type:String, listener:EventListener, ?options:EitherType<AddEventListenerOptions, Bool>, ?wantsUntrusted:Bool):Void

dispatchEvent(event:Event):Bool

removeEventListener(type:String, listener:Function, ?options:EitherType<EventListenerOptions, Bool>):Void

removeEventListener(type:String, listener:EventListener, ?options:EitherType<EventListenerOptions, Bool>):Void

`data:String`

`read onlylength:Int`

`read onlynextElementSibling:Element`

`read onlypreviousElementSibling:Element`

`after(nodes:Rest<Node>):Void`

`after(nodes:Rest<String>):Void`

`appendData(data:String):Void`

`before(nodes:Rest<Node>):Void`

`before(nodes:Rest<String>):Void`

`deleteData(offset:Int, count:Int):Void`

`insertData(offset:Int, data:String):Void`

`remove():Void`

`replaceData(offset:Int, count:Int, data:String):Void`

`replaceWith(nodes:Rest<Node>):Void`

`replaceWith(nodes:Rest<String>):Void`

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

`read onlybaseURI:String`

`read onlychildNodes:NodeList`

`read onlyfirstChild:Node`

`read onlyisConnected:Bool`

`read onlylastChild:Node`

`read onlynextSibling:Node`

`read onlynodeName:String`

`read onlynodeType:Int`

`nodeValue:String`

`read onlyownerDocument:HTMLDocument`

`read onlyparentElement:Element`

`read onlyparentNode:Node`

`read onlypreviousSibling:Node`

`textContent:String`

`appendChild(node:Node):Node`

`@:value({ deep : false })cloneNode(deep:Bool = false):Node`

`compareDocumentPosition(other:Node):Int`

`contains(other:Node):Bool`

`getRootNode(?options:Null<GetRootNodeOptions>):Node`

`hasChildNodes():Bool`

`insertBefore(node:Node, child:Node):Node`

`isDefaultNamespace(namespace:String):Bool`

`isEqualNode(node:Node):Bool`

`isSameNode(node:Node):Bool`

`lookupNamespaceURI(prefix:String):String`

`lookupPrefix(namespace:String):String`

`normalize():Void`

`removeChild(child:Node):Node`

`replaceChild(node:Node, child:Node):Node`

`addEventListener(type:String, listener:Function, ?options:EitherType<AddEventListenerOptions, Bool>, ?wantsUntrusted:Bool):Void`

`addEventListener(type:String, listener:EventListener, ?options:EitherType<AddEventListenerOptions, Bool>, ?wantsUntrusted:Bool):Void`

`dispatchEvent(event:Event):Bool`

`removeEventListener(type:String, listener:Function, ?options:EitherType<EventListenerOptions, Bool>):Void`

`removeEventListener(type:String, listener:EventListener, ?options:EitherType<EventListenerOptions, Bool>):Void`