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:

Serializable, Cloneable, CharacterData, Node, Text

Direct Known Subclasses:

DomCDataSection

public class DomText
extends DomCharacterData
implements Text

Representation of a text node in the HTML DOM.

Version:

$Revision: 10794 $

Author:

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

See Also:

Serialized Form

Nested Class Summary

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

DomNode.ChildIterator, DomNode.DescendantElementsIterator<T extends DomNode>

Field Summary

Fields

Modifier and Type	Field and Description
static 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

Constructors

Constructor and Description
DomText(SgmlPage page, String data) Creates an instance of DomText.

Method Summary

Methods

Modifier and Type	Method and Description
protected boolean	acceptChar(char c) Indicates if the provided character can by "typed" in the element.
protected DomText	createSplitTextNode(int offset) Creates a new text node split from another text node.
protected void	doType(char c, boolean shiftKey, boolean ctrlKey, boolean altKey) Performs the effective type action, called after the keyPress event and before the keyUp event.
protected void	doType(int keyCode, boolean shiftKey, boolean ctrlKey, boolean altKey) Performs the effective type action, called after the keyPress event and before the keyUp event.
String	getNodeName() Returns this node's node name.
short	getNodeType() Returns this node's node type.
String	getWholeText()
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(String indent, PrintWriter printWriter) Recursively writes the XML data for the node tree starting at node.
Text	replaceWholeText(String content) Not yet implemented.
DomText	splitText(int offset)
String	toString() Gives a simple representation to facilitate debugging.

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

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

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

addCharacterDataChangeListener, addDomChangeListener, appendChild, asText, asXml, checkChildHierarchy, cloneNode, compareDocumentPosition, detach, fireCharacterDataChanged, fireNodeAdded, fireNodeDeleted, getAncestors, getAttributes, getBaseURI, getByXPath, getByXPath, getChildNodes, getChildren, getDescendants, getDomElementDescendants, getEndColumnNumber, getEndLineNumber, getFeature, getFirstByXPath, getFirstByXPath, getFirstChild, getHtmlElementDescendants, getHtmlPageOrNull, getIndex, getLastChild, getLocalName, getNamespaceURI, getNextSibling, getOwnerDocument, getPage, getParentNode, getPrefix, getPreviousSibling, getReadyState, getScriptObject, getStartColumnNumber, getStartLineNumber, getTextContent, getUserData, hasAttributes, hasChildNodes, hasFeature, insertBefore, insertBefore, isAncestorOf, isAncestorOfAny, isBlock, isDefaultNamespace, isDescendant, isDirectlyAttachedToPage, isDisplayed, isEqualNode, isSameNode, isSupported, lookupNamespaceURI, lookupPrefix, mayBeDisplayed, normalize, notifyIncorrectness, onAddedToDocumentFragment, onAddedToPage, onAllChildrenAddedToPage, printChildrenAsXml, processImportNode, querySelector, querySelectorAll, remove, removeAllChildren, removeCharacterDataChangeListener, removeChild, removeDomChangeListener, replace, replaceChild, setNextSibling, setParentNode, setPrefix, setPreviousSibling, setReadyState, setScriptObject, 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 String NODE_NAME

The symbolic node name.

See Also:

Constant Field Values

Constructor Detail

DomText

public DomText(SgmlPage page,
       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 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

isElementContentWhitespace

public boolean isElementContentWhitespace()

Not yet implemented.

Specified by:

isElementContentWhitespace in interface Text

getWholeText

public String getWholeText()

Specified by:

getWholeText in interface Text

replaceWholeText

public Text replaceWholeText(String content)
                      throws DOMException

Not yet implemented.

Specified by:

replaceWholeText in interface Text

Throws:

DOMException

getNodeType

public short getNodeType()

Description copied from class: DomNode

Returns this node's node type.

Specified by:

getNodeType in interface Node

Specified by:

getNodeType in class DomNode

Returns:

the node type constant, in this case Node.TEXT_NODE

getNodeName

public String getNodeName()

Description copied from class: DomNode

Returns this node's node name.

Specified by:

getNodeName in interface Node

Specified by:

getNodeName in class DomNode

Returns:

the node name, in this case NODE_NAME

printXml

protected void printXml(String indent,
            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 String toString()

Gives a simple representation to facilitate debugging.

Overrides:

toString in class 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

doType

protected void doType(char c,
          boolean shiftKey,
          boolean ctrlKey,
          boolean altKey)

Performs the effective type action, called after the keyPress event and before the keyUp event.

Parameters:

c - the character you with to simulate typing

shiftKey - true if SHIFT is pressed during the typing

ctrlKey - true if CTRL is pressed during the typing

altKey - true if ALT is pressed during the typing

doType

protected void doType(int keyCode,
          boolean shiftKey,
          boolean ctrlKey,
          boolean altKey)

Performs the effective type action, called after the keyPress event and before the keyUp event.

Parameters:

keyCode - the key code wish to simulate typing

shiftKey - true if SHIFT is pressed during the typing

ctrlKey - true if CTRL is pressed during the typing

altKey - true if ALT is pressed during the typing

acceptChar

protected boolean acceptChar(char c)

Indicates if the provided character can by "typed" in the element.

Parameters:

c - the character

Returns:

true if it is accepted