com.gargoylesoftware.htmlunit.javascript.host.dom

Class CharacterData

java.lang.Object

net.sourceforge.htmlunit.corejs.javascript.ScriptableObject

com.gargoylesoftware.htmlunit.javascript.HtmlUnitScriptable

com.gargoylesoftware.htmlunit.javascript.SimpleScriptable

com.gargoylesoftware.htmlunit.javascript.host.event.EventTarget

com.gargoylesoftware.htmlunit.javascript.host.dom.Node

com.gargoylesoftware.htmlunit.javascript.host.dom.CharacterData

All Implemented Interfaces:

Serializable, Cloneable, net.sourceforge.htmlunit.corejs.javascript.ConstProperties, net.sourceforge.htmlunit.corejs.javascript.debug.DebuggableObject, net.sourceforge.htmlunit.corejs.javascript.Scriptable, net.sourceforge.htmlunit.corejs.javascript.SymbolScriptable

Direct Known Subclasses:

Comment, ProcessingInstruction, Text

public class CharacterData
extends Node

A JavaScript object for CharacterData.

Author:

David K. Taylor, Chris Erskine, Ahmed Ashour, Ronald Brill

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class net.sourceforge.htmlunit.corejs.javascript.ScriptableObject

net.sourceforge.htmlunit.corejs.javascript.ScriptableObject.KeyComparator

Field Summary

Fields inherited from class com.gargoylesoftware.htmlunit.javascript.host.dom.Node

ATTRIBUTE_NODE, CDATA_SECTION_NODE, COMMENT_NODE, DOCUMENT_FRAGMENT_NODE, DOCUMENT_NODE, DOCUMENT_POSITION_CONTAINED_BY, DOCUMENT_POSITION_CONTAINS, DOCUMENT_POSITION_DISCONNECTED, DOCUMENT_POSITION_FOLLOWING, DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC, DOCUMENT_POSITION_PRECEDING, DOCUMENT_TYPE_NODE, ELEMENT_NODE, ENTITY_NODE, ENTITY_REFERENCE_NODE, NOTATION_NODE, PROCESSING_INSTRUCTION_NODE, TEXT_NODE

Fields inherited from class net.sourceforge.htmlunit.corejs.javascript.ScriptableObject

CONST, DONTENUM, EMPTY, PERMANENT, READONLY, UNINITIALIZED_CONST

Fields inherited from interface net.sourceforge.htmlunit.corejs.javascript.Scriptable

NOT_FOUND

Constructor Summary

Constructors

Constructor and Description
CharacterData() Creates an instance.

Method Summary

Modifier and Type	Method and Description
static void	after(net.sourceforge.htmlunit.corejs.javascript.Context context, net.sourceforge.htmlunit.corejs.javascript.Scriptable thisObj, Object[] args, net.sourceforge.htmlunit.corejs.javascript.Function function) Inserts a set of Node or DOMString objects in the children list of this ChildNode's parent, just after this ChildNode.
void	appendData(String arg) Append a string to character data.
static void	before(net.sourceforge.htmlunit.corejs.javascript.Context context, net.sourceforge.htmlunit.corejs.javascript.Scriptable thisObj, Object[] args, net.sourceforge.htmlunit.corejs.javascript.Function function) Inserts a set of Node or DOMString objects in the children list of this ChildNode's parent, just before this ChildNode.
void	deleteData(int offset, int count) Delete characters from character data.
Object	getData() Gets the JavaScript property data for this character data.
int	getLength() Gets the number of character in the character data.
Element	getNextElementSibling() Returns the next element sibling.
Element	getPreviousElementSibling() Returns the previous element sibling.
void	insertData(int offset, String arg) Insert a string into character data.
void	remove() Removes the DOM node from its parent.
void	replaceData(int offset, int count, String arg) Replace characters of character data with a string.
static void	replaceWith(net.sourceforge.htmlunit.corejs.javascript.Context context, net.sourceforge.htmlunit.corejs.javascript.Scriptable thisObj, Object[] args, net.sourceforge.htmlunit.corejs.javascript.Function function) Replaces the node wit a set of Node or DOMString objects.
void	setData(String newValue) Sets the JavaScript property data for this character data.
String	substringData(int offset, int count) Extract a substring from character data.

Methods inherited from class com.gargoylesoftware.htmlunit.javascript.host.dom.Node

appendChild, asJavaScriptException, cloneNode, compareDocumentPosition, contains, getAttributes, getBaseURI, getChildElementCount, getChildNodes, getChildren, getFirstChild, getFirstElementChild, getJavaScriptNode, getLastChild, getLastElementChild, getLocalName, getNamespaceURI, getNextSibling, getNodeName, getNodeType, getNodeValue, getOwnerDocument, getParent, getParentElement, getParentNode, getPrefix, getPreviousSibling, getTextContent, hasAttributes, hasChildNodes, insertBefore, insertBeforeImpl, isSameNode, normalize, removeChild, replaceChild, setNodeValue, setTextContent

Methods inherited from class com.gargoylesoftware.htmlunit.javascript.host.event.EventTarget

addEventListener, clearEventListenersContainer, dispatchEvent, executeEventLocally, fireEvent, getEventHandler, getEventListenersContainer, hasEventHandlers, isEventHandlerOnWindow, removeEventListener, setEventHandler

Methods inherited from class com.gargoylesoftware.htmlunit.javascript.SimpleScriptable

clone, equivalentValues, get, getBrowserVersion, getDefaultValue, getDomNodeOrDie, getDomNodeOrNull, getPrototype, getScriptableFor, getStartingScope, getWindow, getWindow, getWithPreemption, has, hasInstance, initParentScope, makeScriptableFor, setCaseSensitive, setDomNode, setDomNode, setHtmlElement

Methods inherited from class com.gargoylesoftware.htmlunit.javascript.HtmlUnitScriptable

defineFunctionProperties, defineProperty, getClassName, put, setClassName, setParentScope

Methods inherited from class net.sourceforge.htmlunit.corejs.javascript.ScriptableObject

applyDescriptorToAttributeBitset, associateValue, avoidObjectDetection, buildDataDescriptor, callMethod, callMethod, checkPropertyChange, checkPropertyDefinition, defineClass, defineClass, defineClass, defineConst, defineConstProperty, defineOwnProperties, defineOwnProperty, defineOwnProperty, defineProperty, defineProperty, defineProperty, defineProperty, delete, delete, delete, deleteProperty, deleteProperty, ensureScriptable, ensureScriptableObject, ensureSymbolScriptable, get, get, get, getAllIds, getArrayPrototype, getAssociatedValue, getAttributes, getAttributes, getAttributes, getAttributes, getAttributes, getClassPrototype, getDefaultValue, getExternalArrayData, getExternalArrayLength, getFunctionPrototype, getGetterOrSetter, getIds, getObjectPrototype, getOwnPropertyDescriptor, getParentScope, getProperty, getProperty, getProperty, getPropertyIds, getPrototype, getSlot, getTopLevelScope, getTopScopeValue, getTypedProperty, getTypedProperty, getTypeOf, has, has, hasProperty, hasProperty, hasProperty, isAccessorDescriptor, isConst, isDataDescriptor, isEmpty, isExtensible, isFalse, isGenericDescriptor, isGetterOrSetter, isReadOnlySettable, isSealed, isTrue, preventExtensions, put, put, putConst, putConstProperty, putProperty, putProperty, putProperty, redefineProperty, sameValue, sealObject, setAttributes, setAttributes, setAttributes, setAttributes, setAttributes, setExternalArrayData, setGetterOrSetter, setPrototype, size

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CharacterData

public CharacterData()

Creates an instance.

Method Detail

getData

public Object getData()

Gets the JavaScript property data for this character data.

Returns:

the String of data

setData

public void setData(String newValue)

Sets the JavaScript property data for this character data.

Parameters:

newValue - the new String of data

getLength

public int getLength()

Gets the number of character in the character data.

Returns:

the number of characters

appendData

public void appendData(String arg)

Append a string to character data.

Parameters:

arg - the string to be appended to the character data

deleteData

public void deleteData(int offset,
                       int count)

Delete characters from character data.

Parameters:

offset - the position of the first character to be deleted

count - the number of characters to be deleted

insertData

public void insertData(int offset,
                       String arg)

Insert a string into character data.

Parameters:

offset - the position within the first character at which the string is to be inserted.

arg - the string to insert

replaceData

public void replaceData(int offset,
                        int count,
                        String arg)

Replace characters of character data with a string.

Parameters:

offset - the position within the first character at which the string is to be replaced.

count - the number of characters to be replaced

arg - the string that replaces the count characters beginning at the character at offset.

substringData

public String substringData(int offset,
                            int count)

Extract a substring from character data.

Parameters:

offset - the position of the first character to be extracted

count - the number of characters to be extracted

Returns:

a string that consists of the count characters of the character data starting from the character at position offset

getNextElementSibling

public Element getNextElementSibling()

Returns the next element sibling.

Returns:

the next element sibling

getPreviousElementSibling

public Element getPreviousElementSibling()

Returns the previous element sibling.

Returns:

the previous element sibling

remove

public void remove()

Removes the DOM node from its parent.

Overrides:

remove in class Node

See Also:

MDN documentation

before

public static void before(net.sourceforge.htmlunit.corejs.javascript.Context context,
                          net.sourceforge.htmlunit.corejs.javascript.Scriptable thisObj,
                          Object[] args,
                          net.sourceforge.htmlunit.corejs.javascript.Function function)

Inserts a set of Node or DOMString objects in the children list of this ChildNode's parent, just before this ChildNode.

Parameters:

context - the context

thisObj - this object

args - the arguments

function - the function

after

public static void after(net.sourceforge.htmlunit.corejs.javascript.Context context,
                         net.sourceforge.htmlunit.corejs.javascript.Scriptable thisObj,
                         Object[] args,
                         net.sourceforge.htmlunit.corejs.javascript.Function function)

Inserts a set of Node or DOMString objects in the children list of this ChildNode's parent, just after this ChildNode.

Parameters:

context - the context

thisObj - this object

args - the arguments

function - the function

replaceWith

public static void replaceWith(net.sourceforge.htmlunit.corejs.javascript.Context context,
                               net.sourceforge.htmlunit.corejs.javascript.Scriptable thisObj,
                               Object[] args,
                               net.sourceforge.htmlunit.corejs.javascript.Function function)

Replaces the node wit a set of Node or DOMString objects.

Parameters:

context - the context

thisObj - this object

args - the arguments

function - the function