com.gargoylesoftware.htmlunit.html
Class DomText

java.lang.Object
  com.gargoylesoftware.htmlunit.html.DomNode
      com.gargoylesoftware.htmlunit.html.DomCharacterData
          com.gargoylesoftware.htmlunit.html.DomText

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, org.w3c.dom.CharacterData, org.w3c.dom.Node, org.w3c.dom.Text

Direct Known Subclasses:

DomCDataSection

public class DomText
extends DomCharacterData
implements org.w3c.dom.Text

Representation of a text node in the HTML DOM.

Version:

$Revision: 4794 $

Author:

David K. Taylor, Christian Sell, Rodney Gitzel, Ahmed Ashour, Sudhan Moghe

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.gargoylesoftware.htmlunit.html.DomNode

DomNode.ChildIterator, DomNode.DescendantElementsIterator

Field Summary

static java.lang.String

NODE_NAME The symbolic node name.

Fields inherited from class com.gargoylesoftware.htmlunit.html.DomNode

AS_TEXT_BLANK, AS_TEXT_BLOCK_SEPARATOR, AS_TEXT_NEW_LINE, AS_TEXT_TAB, PROPERTY_ELEMENT, READY_STATE_COMPLETE, READY_STATE_INTERACTIVE, READY_STATE_LOADED, READY_STATE_LOADING, READY_STATE_UNINITIALIZED

Fields inherited from interface org.w3c.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

Constructor Summary

DomText(SgmlPage page, java.lang.String data)
Creates an instance of DomText.

Method Summary

protected DomText	createSplitTextNode(int offset) Creates a new text node split from another text node.
java.lang.String	getNodeName() Returns this node's node name.
short	getNodeType() Returns this node's node type.
java.lang.String	getWholeText() Not yet implemented.
boolean	isElementContentWhitespace() Not yet implemented.
protected boolean	isTrimmedText() Returns a flag indicating whether or not this node should have any leading and trailing whitespace removed when DomNode.asText() is called.
protected void	printXml(java.lang.String indent, java.io.PrintWriter printWriter) Recursively writes the XML data for the node tree starting at node.
org.w3c.dom.Text	replaceWholeText(java.lang.String content) Not yet implemented.
DomText	splitDomText(int offset) Deprecated. as of 2.6, please use splitText(int) instead
DomText	splitText(int offset)
java.lang.String	toString() Gives a simple representation to facilitate debugging.

Methods inherited from class com.gargoylesoftware.htmlunit.html.DomCharacterData

appendData, deleteData, getData, getLength, getNodeValue, insertData, replaceData, setData, setNodeValue, substringData

Methods inherited from class com.gargoylesoftware.htmlunit.html.DomNode

addDomChangeListener, appendChild, asText, asXml, checkChildHierarchy, cloneNode, compareDocumentPosition, fireNodeAdded, fireNodeDeleted, getAllHtmlChildElements, getAncestors, getAttributes, getBaseURI, getByXPath, getCanonicalXPath, getChildNodes, getChildren, getEndColumnNumber, getEndLineNumber, getFeature, getFirstByXPath, getFirstChild, getLastChild, getLocalName, getNamespaceURI, getNextSibling, getOwnerDocument, getPage, getParentNode, getPrefix, getPreviousSibling, getReadyState, getScriptObject, getStartColumnNumber, getStartLineNumber, getTextContent, getUserData, hasAttributes, hasChildNodes, insertBefore, insertBefore, isAncestorOf, isBlock, isDefaultNamespace, isDisplayed, isEqualNode, isSameNode, isSupported, lookupNamespaceURI, lookupPrefix, normalize, notifyIncorrectness, onAddedToPage, onAllChildrenAddedToPage, printChildrenAsXml, remove, removeAllChildren, removeChild, removeDomChangeListener, replace, replaceChild, selectNodes, selectSingleNode, setNextSibling, setParentNode, setPrefix, setPreviousSibling, setReadyState, setScriptObject, setTextContent, setUserData

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.w3c.dom.CharacterData

appendData, deleteData, getData, getLength, insertData, replaceData, setData, substringData

Methods inherited from interface org.w3c.dom.Node

appendChild, cloneNode, compareDocumentPosition, getAttributes, getBaseURI, getChildNodes, getFeature, getFirstChild, getLastChild, getLocalName, getNamespaceURI, getNextSibling, getNodeValue, getOwnerDocument, getParentNode, getPrefix, getPreviousSibling, getTextContent, getUserData, hasAttributes, hasChildNodes, insertBefore, isDefaultNamespace, isEqualNode, isSameNode, isSupported, lookupNamespaceURI, lookupPrefix, normalize, removeChild, replaceChild, setNodeValue, setPrefix, setTextContent, setUserData

Field Detail

NODE_NAME

public static final java.lang.String NODE_NAME

The symbolic node name.

See Also:

Constant Field Values

Constructor Detail

DomText

public DomText(SgmlPage page,
               java.lang.String data)

Creates an instance of DomText.

Parameters:

page - the Page that contains this element

data - the string data held by this node

Method Detail

splitText

public DomText splitText(int offset)

Specified by:

splitText in interface org.w3c.dom.Text

createSplitTextNode

protected DomText createSplitTextNode(int offset)

Creates a new text node split from another text node. This method allows the derived type of the new text node to match the original node type.

Parameters:

offset - the character position at which to split the DomText node

Returns:

the newly created Text node

splitDomText

@Deprecated
public DomText splitDomText(int offset)

Deprecated. as of 2.6, please use splitText(int) instead

Splits a DomText node in two.

Parameters:

offset - the character position at which to split the DomText node

Returns:

the DomText node that was split from this node

isElementContentWhitespace

public boolean isElementContentWhitespace()

Not yet implemented.

Specified by:

isElementContentWhitespace in interface org.w3c.dom.Text

getWholeText

public java.lang.String getWholeText()

Not yet implemented.

Specified by:

getWholeText in interface org.w3c.dom.Text

replaceWholeText

public org.w3c.dom.Text replaceWholeText(java.lang.String content)
                                  throws org.w3c.dom.DOMException

Not yet implemented.

Specified by:

replaceWholeText in interface org.w3c.dom.Text

Throws:

org.w3c.dom.DOMException

getNodeType

public short getNodeType()

Description copied from class: DomNode

Returns this node's node type.

Specified by:

getNodeType in interface org.w3c.dom.Node

Specified by:

getNodeType in class DomNode

Returns:

the node type constant, in this case Node.TEXT_NODE

getNodeName

public java.lang.String getNodeName()

Description copied from class: DomNode

Returns this node's node name.

Specified by:

getNodeName in interface org.w3c.dom.Node

Specified by:

getNodeName in class DomNode

Returns:

the node name, in this case NODE_NAME

printXml

protected void printXml(java.lang.String indent,
                        java.io.PrintWriter printWriter)

Recursively writes the XML data for the node tree starting at node.

Overrides:

printXml in class DomNode

Parameters:

indent - white space to indent child nodes

printWriter - writer where child nodes are written

toString

public java.lang.String toString()

Gives a simple representation to facilitate debugging.

Overrides:

toString in class java.lang.Object

Returns:

a simple representation

isTrimmedText

protected boolean isTrimmedText()

Returns a flag indicating whether or not this node should have any leading and trailing whitespace removed when DomNode.asText() is called. This method should usually return true, but must return false for such things as text formatting tags.

Overrides:

isTrimmedText in class DomNode

Returns:

a flag indicating whether or not this node should have any leading and trailing whitespace removed when DomNode.asText() is called