All Classes |Grouped Classes |Index

Class CL_DomDocumentFragment

DOM Document Fragment class. More...

Derived from:

public CL_DomNode

Derived by:

None

Group:

XML (Core)

#include <ClanLib/>

Class Members:

Construction:

CL_DomDocumentFragment

Constructs a DOM Document Fragment handle.


Attributes:

get_node_name

Returns the node name.

get_namespace_uri

Returns the namespace URI of this node.

get_prefix

Returns the namespace prefix of the node.

set_prefix

Sets the namespace prefix of the node.

get_local_name

Returns local part of the qualified name of this node.

get_node_value

Returns the node value.

set_node_value

Sets the node value.

get_node_type

Returns the node type (one of those in the NodeType enum).

get_parent_node

Returns the parent of this node.

get_child_nodes

Returns a NodeList that contains all children of this node.

get_first_child

The first child of this node.

get_last_child

The last child of this node.

get_previous_sibling

The node immediately preceding this node.

get_next_sibling

The node immediately following this node.

get_attributes

A NamedNodeMap containing the attributes of this node (if it is an Element) or null otherwise.

get_owner_document

The Document object associated with this node.

is_null

Returns true if this is a null node.

is_element

Returns true if this is an element node.

is_attr

Returns true if this is an attribute node.

is_text

Returns true if this is a text node.

is_cdata_section

Returns true if this is a CDATA section node.

is_entity_reference

Returns true if this is an entity reference node.

is_entity

Returns true if this is an entity node.

is_processing_instruction

Returns true if this is a processing instruction node.

is_comment

Returns true if this is a comment node.

is_document

Returns true if this is a document node.

is_document_type

Returns true if this is a document type node.

is_document_fragment

Returns true if this is a document fragment node.

is_notation

Returns true if this is a notation node.

is_supported

Tests whether the DOM implementation implements a specific feature and that feature is supported by this node.

has_attributes

Returns true if this node (if its an element) has any attributes.

has_child_nodes

Returns true if this node has any children.

NodeType

An integer indicating which type of node this is.


Operations:

operator==

Compare operator.

operator!=

Compare operator.

normalize

Merges any adjacent Text nodes.

insert_before

Inserts the node new_child before the existing child node ref_child.

replace_child

Replaces the child node old_child with new_child in the list of children.

remove_child

Removes the child node indicated by old_child from the list of children, and returns it.

append_child

Adds the node new_child to the end of the list of children of this node.

clone_node

Returns a duplicate of this node, i.e., serves as a generic copy constructor for nodes.

to_element

Returns the Element interface to this node.

to_attr

Returns the Attribute interface to this node.

to_text

Returns the Text interface to this node.

to_cdata_section

Returns the CDATA Section interface to this node.

to_entity_reference

Returns the Entity Reference interface to this node.

to_entity

Returns the Entity interface to this node.

to_processing_instruction

Returns the Processing Instruction interface to this node.

to_comment

Returns the Comment interface to this node.

to_document

Returns the Document interface to this node.

to_document_type

Returns the Document Type interface to this node.

to_document_fragment

Returns the Document Fragment interface to this node.

to_notation

Returns the Notation interface to this node.

named_item

Returns the first child node with the specified node name.

named_item_ns

Retrieves the first child node with the specified namespace URI and local name.

find_namespace_uri

Searches the node tree upwards for the namespace URI of the given qualified name.

find_prefix

Searches the node tree upwards for the prefix name for the namespace URI.

select_nodes

Returns all the nodes matching the specified xpath expression using this node as the context node.

select_node

Returns the first node matching the specified xpath expression using this node as the context node.

select_string

Returns the first node value matching the specified xpath expression using this node as the context node.

select_int

Returns the first node value (as integer) matching the specified xpath expression using this node as the context node.

select_float

Returns the first node value (as float) matching the specified xpath expression using this node as the context node.

select_bool

Returns the first node value (as boolean) matching the specified xpath expression using this node as the context node.

Detailed description:

DocumentFragment is a "lightweight" or "mi"umentct. It is t is very common to wato want to be a be able to extract a portion of a document's tree or to create a new fragment ofcument. Imagine implemmplementing a user command like cut or rearranging a document by moving fragments around. It is desirable to have an object which can hold such fragments and it is quite natural to use a Node for this purpose. While it is true that a Document object could fulfil this role, a Document object can potentially be a heavyweight object, depending on the underlying implementation. What is really needed for tiiy liight ight ight oght objectumentumentFragme such such an object.

Furthermore, various operations such as inserting nodes as children of another Node may take DocumentFragment objects as arguments; this results in all the child nodes of the DocumentFragment being moved to the child list of this node.

The children of a DocumentFragment node are zero or more nodes representing the tops of any sub-trees defining the structure of the document. DocumentFragment nodes do not need to be well-formed XML documents (although they do need to follow the rules imposed upon well-formed XML parsed entities, which can have multiple top nodes). For example, a DocumentFragment might have only one child and that child node could be a Text node. Such a structure model represents neither an HTML document nor a well-formed XML document.

When a DocumentFragment is inserted into a Document (or indeed any other Node that may take children) the children of the DocumentFragment and not the DocumentFragment itself are inserted into the Node. This makes the DocumentFragment very useful when the user wishes to create nodes that are siblings; the DocumentFragment acts as the parent of these nodes so that the user can use the standard methods from the Node interface, such as insertBefore() and appendChild().

!header=core.h