Login or Register to Ask a Question and Join Our Community

Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

xml::dom::characterdata(3) [suse man page]

XML::DOM::CharacterData(3)				User Contributed Perl Documentation				XML::DOM::CharacterData(3)

NAME

       XML::DOM::CharacterData - Common interface for Text, CDATASections and Comments

DESCRIPTION

       XML::DOM::CharacterData extends XML::DOM::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, Comment and CDATASection do inherit the interface from it.	All offsets in this interface start from 0.

   METHODS
       getData and setData (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.

       getLength
	   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 (offset, count)
	   Extracts a range of data from the node.

	   Parameters:
	    offset  Start offset of substring to extract.
	    count   The number of characters to extract.

	   Return Value: 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 (str)
	   Appends 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.

       insertData (offset, arg)
	   Inserts a string at the specified character offset.

	   Parameters:
	    offset  The character offset at which to insert.
	    arg     The DOMString to insert.

       deleteData (offset, count)
	   Removes a range of characters from the node.  Upon success, data and length reflect the change.  If the sum of offset and count exceeds
	   length then all characters from offset to the end of the data are deleted.

	   Parameters:
	    offset  The offset from which to remove characters.
	    count   The number of characters to delete.

       replaceData (offset, count, arg)
	   Replaces 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.
	    arg     The DOMString with which the range must be replaced.

	   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).

perl v5.12.1							    2000-01-31						XML::DOM::CharacterData(3)

Check Out this Related Man Page

XML::DOM::Text(3)					User Contributed Perl Documentation					 XML::DOM::Text(3)

NAME

       XML::DOM::Text - A piece of XML text in XML::DOM

DESCRIPTION

       XML::DOM::Text extends XML::DOM::CharacterData, which extends XML::DOM::Node.

       The Text interface represents the textual content (termed character data in XML) of an Element or Attr. If there is no markup inside an
       element's content, the text is contained in a single object implementing the Text interface that is the only child of the element.  If
       there is markup, it is parsed into a list of elements and Text nodes that form the list of children of the element.

       When a document is first made available via the DOM, there is only one Text node for each block of text. Users may create adjacent Text
       nodes that represent the contents of a given element without any intervening markup, but should be aware that there is no way to represent
       the separations between these nodes in XML or HTML, so they will not (in general) persist between DOM editing sessions. The normalize()
       method on Element merges any such adjacent Text objects into a single node for each block of text; this is recommended before employing
       operations that depend on a particular document structure, such as navigation with XPointers.

   METHODS
       splitText (offset)
	   Breaks this Text node into two Text nodes at the specified offset, keeping both in the tree as siblings. This node then only contains
	   all the content up to the offset point. And a new Text node, which is inserted as the next sibling of this node, contains all the
	   content at and after the offset point.

	   Parameters:
	    offset  The offset at which to split, starting from 0.

	   Return Value: The new Text node.

	   DOMExceptions:

	   o   INDEX_SIZE_ERR

	       Raised if the specified offset is negative or greater than the number of characters in data.

	   o   NO_MODIFICATION_ALLOWED_ERR

	       Raised if this node is readonly.

perl v5.12.1							    2000-01-31							 XML::DOM::Text(3)
Man Page