Class CharacterDataImpl

All Implemented Interfaces:
Serializable, Cloneable, EventTarget, Node, NodeList
Direct Known Subclasses:
CommentImpl, ProcessingInstructionImpl, TextImpl

public abstract class CharacterDataImpl extends ChildNode
CharacterData is an abstract Node that can carry character data as its Value. It provides shared behavior for Text, CData, and possibly other node types. All offsets are 0-based.

Since ProcessingInstructionImpl inherits from this class to reuse the setNodeValue method, this class isn't declared as implementing the interface CharacterData. This is done by relevant subclasses (TexImpl, CommentImpl).

This class doesn't directly support mutation events, however, it notifies the document when mutations are performed so that the document class do so.

INTERNAL:

Usage of this class is not supported. It may be altered or removed at any time.
Since:
PR-DOM-Level-1-19980818.
Version:
$Id: CharacterDataImpl.java 1057476 2011-01-11 03:31:36Z mrglavas $
See Also:
  • Field Details

    • data

      protected String data
  • Constructor Details

    • CharacterDataImpl

      public CharacterDataImpl()
    • CharacterDataImpl

      protected CharacterDataImpl(CoreDocumentImpl ownerDocument, String data)
      Factory constructor.
  • Method Details

    • getChildNodes

      public NodeList getChildNodes()
      Returns an empty node list.
      Specified by:
      getChildNodes in interface Node
      Overrides:
      getChildNodes in class NodeImpl
    • getNodeValue

      public String getNodeValue()
      Description copied from class: NodeImpl
      Returns the node value.
      Specified by:
      getNodeValue in interface Node
      Overrides:
      getNodeValue in class NodeImpl
    • setNodeValueInternal

      protected void setNodeValueInternal(String value)
      Convenience wrapper for calling setNodeValueInternal when we are not performing a replacement operation
    • setNodeValueInternal

      protected void setNodeValueInternal(String value, boolean replace)
      This function added so that we can distinguish whether setNodeValue has been called from some other DOM functions. or by the client.

      This is important, because we do one type of Range fix-up, from the high-level functions in CharacterData, and another type if the client simply calls setNodeValue(value).

    • setNodeValue

      public void setNodeValue(String value)
      Sets the content, possibly firing related events, and updating ranges (via notification to the document)
      Specified by:
      setNodeValue in interface Node
      Overrides:
      setNodeValue in class NodeImpl
    • getData

      public String getData()
      Retrieve character data currently stored in this node.
    • getLength

      public int getLength()
      Report number of characters currently stored in this node's data. It may be 0, meaning that the value is an empty string.
      Specified by:
      getLength in interface NodeList
      Overrides:
      getLength in class NodeImpl
      Returns:
      int
      See Also:
    • appendData

      public void appendData(String data)
      Concatenate additional characters onto the end of the data stored in this node. Note that this, and insert(), are the paths by which a DOM could wind up accumulating more data than the language's strings can easily handle. (See above discussion.)
    • deleteData

      public void deleteData(int offset, int count) throws DOMException
      Remove a range of characters from the node's value. Throws a DOMException if the offset is beyond the end of the string. However, a deletion _count_ that exceeds the available data is accepted as a delete-to-end request.
      Throws:
      DOMException
    • insertData

      public void insertData(int offset, String data) throws DOMException
      Insert additional characters into the data stored in this node, at the offset specified.
      Throws:
      DOMException
    • replaceData

      public void replaceData(int offset, int count, String data) throws DOMException
      Replace a series of characters at the specified (zero-based) offset with a new string, NOT necessarily of the same length. Convenience method, equivalent to a delete followed by an insert. Throws a DOMException if the specified offset is beyond the end of the existing data.
      Parameters:
      offset - The offset at which to begin replacing.
      count - The number of characters to remove, interpreted as in the delete() method.
      data - The new string to be inserted at offset in place of the removed data. Note that the entire string will be inserted -- the count parameter does not affect insertion, and the new data may be longer or shorter than the substring it replaces.
      Throws:
      DOMException
    • setData

      public void setData(String value) throws DOMException
      Store character data into this node.
      Throws:
      DOMException
    • substringData

      public String substringData(int offset, int count) throws DOMException
      Substring is more than a convenience function. In some implementations of the DOM, where the stored data may exceed the length that can be returned in a single string, the only way to read it all is to extract it in chunks via this method.
      Parameters:
      offset - Zero-based offset of first character to retrieve.
      count - Number of characters to retrieve. If the sum of offset and count exceeds the length, all characters to end of data are returned.
      Throws:
      DOMException