Logo Search packages:      
Sourcecode: lib-dom-java version File versions  Download package

org::w3c::dom::DocumentFragment Interface Reference

Inheritance diagram for org::w3c::dom::DocumentFragment:

org::w3c::dom::Node

List of all members.


Detailed Description

DocumentFragment is a "lightweight" or "minimal" Document object. It is very common to want to be able to extract a portion of a document's tree or to create a new fragment of a document. Imagine implementing 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 this is a very lightweight object. DocumentFragment is 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().

Definition at line 45 of file DocumentFragment.java.


Public Member Functions

Node appendChild (Node newChild) throws DOMException
Node cloneNode (boolean deep)
NamedNodeMap getAttributes ()
NodeList getChildNodes ()
Node getFirstChild ()
Node getLastChild ()
Node getNextSibling ()
String getNodeName ()
short getNodeType ()
String getNodeValue () throws DOMException
Document getOwnerDocument ()
Node getParentNode ()
Node getPreviousSibling ()
boolean hasChildNodes ()
Node insertBefore (Node newChild, Node refChild) throws DOMException
Node removeChild (Node oldChild) throws DOMException
Node replaceChild (Node newChild, Node oldChild) throws DOMException
void setNodeValue (String nodeValue) throws DOMException

Static Public Attributes

static final short ATTRIBUTE_NODE = 2
static final short CDATA_SECTION_NODE = 4
static final short COMMENT_NODE = 8
static final short DOCUMENT_FRAGMENT_NODE = 11
static final short DOCUMENT_NODE = 9
static final short DOCUMENT_TYPE_NODE = 10
static final short ELEMENT_NODE = 1
static final short ENTITY_NODE = 6
static final short ENTITY_REFERENCE_NODE = 5
static final short NOTATION_NODE = 12
static final short PROCESSING_INSTRUCTION_NODE = 7
static final short TEXT_NODE = 3

The documentation for this interface was generated from the following file:

Generated by  Doxygen 1.6.0   Back to index