org.kde.koala
Class CharacterData

java.lang.Object
  org.kde.koala.Node
      org.kde.koala.CharacterData

All Implemented Interfaces:

org.kde.qt.QtSupport

Direct Known Subclasses:

Comment, Text

public class CharacterData
extends Node

The CharacterData interface extends Node with a set of attributes and methods for accessing character data in the DOM. For clarity this set is defined here rather than on each object that uses these attributes and methods. No DOM objects correspond directly to CharacterData , though Text and others do inherit the interface from it. All offsets in this interface start from 0.

Constructor Summary

	CharacterData()
	CharacterData(CharacterData other)
protected	CharacterData(java.lang.Class dummy)
	CharacterData(Node other)

Method Summary

void	appendData(java.lang.String arg) Append the string to the end of the character data of the node.
java.lang.String	data() The character data of the node that implements this interface.
void	deleteData(long offset, long count) Remove a range of characters from the node.
void	insertData(long offset, java.lang.String arg) Insert a string at the specified character offset.
long	length() The number of characters that are available through data and the substringData method below.
void	replaceData(long offset, long count, java.lang.String arg) Replace the characters starting at the specified character offset with the specified string.
void	setData(java.lang.String arg1) see data
java.lang.String	substringData(long offset, long count) Extracts a range of data from the node.

Methods inherited from class org.kde.koala.Node

addEventListener, appendChild, applyChanges, attributes, childNodes, cloneNode, dispatchEvent, elementId, firstChild, getRect, hasAttributes, hasChildNodes, index, insertBefore, isNull, isSupported, lastChild, localName, namespaceURI, nextSibling, nodeName, nodeType, nodeValue, normalize, op_equals, op_not_equals, ownerDocument, parentNode, prefix, previousSibling, removeChild, removeEventListener, replaceChild, setNodeValue, setPrefix

Methods inherited from class java.lang.Object

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

Constructor Detail

CharacterData

protected CharacterData(java.lang.Class dummy)

CharacterData

public CharacterData()

CharacterData

public CharacterData(CharacterData other)

CharacterData

public CharacterData(Node other)

Method Detail

data

public java.lang.String data()

The character data of the node that implements this interface. The DOM implementation may not put arbitrary limits on the amount of data that may be stored in a CharacterData node. However, implementation limits may mean that the entirety of a node's data may not fit into a single DOMString . In such cases, the user may call substringData to retrieve the data in appropriately sized pieces.

setData

public void setData(java.lang.String arg1)

see data

length

public long length()

The number of characters that are available through data and the substringData method below. This may have the value zero, i.e., CharacterData nodes may be empty.

substringData

public java.lang.String substringData(long offset,
                                      long count)

Extracts a range of data from the node.

Parameters:

offset - Start offset of substring to extract.

count - The number of characters to extract. DOMSTRING_SIZE_ERR: Raised if the specified range of text does not fit into a DOMString .

Returns:

The specified substring. If the sum of offset and count exceeds the length , then all characters to the end of the data are returned.

appendData

public void appendData(java.lang.String arg)

Append the string to the end of the character data of the node. Upon success, data provides access to the concatenation of data and the DOMString specified.

Parameters:

arg - The DOMString to append.

insertData

public void insertData(long offset,
                       java.lang.String arg)

Insert a string at the specified character offset.

Parameters:

offset - The character offset at which to insert.

arg - The DOMString to insert. NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.

deleteData

public void deleteData(long offset,
                       long count)

Remove a range of characters from the node. Upon success, data and length reflect the change.

Parameters:

offset - The offset from which to remove characters.

count - The number of characters to delete. If the sum of offset and count exceeds length then all characters from offset to the end of the data are deleted. NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.

replaceData

public void replaceData(long offset,
                        long count,
                        java.lang.String arg)

Replace the characters starting at the specified character offset with the specified string.

Parameters:

offset - The offset from which to start replacing.

count - The number of characters to replace. If the sum of offset and count exceeds length , then all characters to the end of the data are replaced (i.e., the effect is the same as a remove method call with the same range, followed by an append method invocation).

arg - The DOMString with which the range must be replaced. NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.