Class Document

    • A Document represents an XML document.

    • It includes methods for adding, getting, removing, and cloning content nodes that are immediate children or descendants of the document.

    • The Document object allows for managing the root element and Document Type declaration.

    • Methods are available to check for the presence of a root element and determine the number of immediate child nodes.
    Document

    A representation of an XML document.

    Methods

    Method Return type Brief description
    add Content(content)
    		Document Appends the given node to the end of the document.
    add Content(index, content)
    		Document Inserts the given node at the given index among all nodes that are immediate children of the document.
    clone Content()
    		Content[] Creates unattached copies of all nodes that are immediate children of the document.
    detach Root Element()
    		Element |null Detaches and returns the document's root Element node.
    get All Content()
    		Content[] Gets all nodes that are immediate children of the document.
    get Content(index)
    		Content |null Gets the node at the given index among all nodes that are immediate children of the document.
    get Content Size()
    		Integer Gets the number of nodes that are immediate children of the document.
    get Descendants()
    		Content[] Gets all nodes that are direct or indirect children of the document, in the order they appear in the document.
    get Doc Type()
    		Doc Type |null Gets the document's Doc Type declaration.
    get Root Element()
    		Element |null Gets the document's root Element node.
    has Root Element()
    		Boolean Determines whether the document has a root Element node.
    remove Content()
    		Content[] Removes all nodes that are immediate children of the document.
    remove Content(content)
    		Boolean Removes the given node, if the node is an immediate child of the document.
    remove Content(index)
    		Content |null Removes the node at the given index among all nodes that are immediate children of the document.
    set Doc Type(docType)
    		Document Sets the document's Doc Type declaration.
    set Root Element(element)
    		Document Sets the document's root Element node.

    Detailed documentation

    addContent(content)

    Appends the given node to the end of the document. The content argument can be a Content object or any node object that corresponds to a type listed in ContentType . Note, however, that a document can only have one child Element node, which is implicitly the root Element node.

    Parameters

    Name Type Description
    content
    		Content The node to append.

    Return

    Document — The document, for chaining.

    addContent(index, content)

    Inserts the given node at the given index among all nodes that are immediate children of the document. The content argument can be a Content object or any node object that corresponds to a type listed in ContentType . Note, however, that a document can only have one child Element node, which is implicitly the root Element node.

    Parameters

    Name Type Description
    index
    		Integer The index at which to insert the node among all nodes that are immediate children of the document.
    content
    		Content The node to insert.

    Return

    Document — The document, for chaining.

    cloneContent()

    Creates unattached copies of all nodes that are immediate children of the document.

    Return

    Content[] — An array of unattached copies of all nodes that are immediate children of the document.

    detachRootElement()

    Detaches and returns the document's root Element node. If the document does not have a root Element node, this method returns null .

    Return

    Element |null — The detached Element node, or null if the document does not have a root Element node.

    getAllContent()

    Gets all nodes that are immediate children of the document.

    Return

    Content[] — An array of all nodes that are immediate children of the document.

    getContent(index)

    Gets the node at the given index among all nodes that are immediate children of the document. If there is no node at the given index, this method returns null .

    Parameters

    Name Type Description
    index
    		Integer The index for the node among all nodes that are immediate children of the document.

    Return

    Content |null — The node, or null if there is no node at the given index.

    getContentSize()

    Gets the number of nodes that are immediate children of the document.

    Return

    Integer — The number of nodes that are immediate children of the document.

    getDescendants()

    Gets all nodes that are direct or indirect children of the document, in the order they appear in the document.

    Return

    Content[] — An array of all nodes that are direct or indirect children of the document.

    getDocType()

    Gets the document's DocType declaration. If the document does not have a DocumentType node, this method returns null .

    Return

    DocType |null — The DocumentType node, or null if the document does not have a DocumentType node.

    getRootElement()

    Gets the document's root Element node. If the document does not have a root Element node, this method returns null .

    Return

    Element |null — The root Element node, or null if the document does not have a root Element node.

    hasRootElement()

    Determines whether the document has a root Element node.

    Return

    Boolean — true if the document has a root Element node; false if not.

    removeContent()

    Removes all nodes that are immediate children of the document.

    Return

    Content[] — An array of all nodes that were immediate children of the document before they were removed.

    removeContent(content)

    Removes the given node, if the node is an immediate child of the document. The content argument can be a Content object or any node object that corresponds to a type listed in ContentType .

    Parameters

    Name Type Description
    content
    		Content The node to remove.

    Return

    Boolean — true if the node was an immediate child and was removed; false if not.

    removeContent(index)

    Removes the node at the given index among all nodes that are immediate children of the document. If there is no node at the given index, this method returns null .

    Parameters

    Name Type Description
    index
    		Integer The index for the node among all nodes that are immediate children of the document.

    Return

    Content |null — The node that was removed, or null if there is no node at the given index.

    setDocType(docType)

    Sets the document's DocType declaration. If the document already has a different DocType node, this method overwrites the old node. This method throws an exception if the document already contains the same DocType node that is being set.

    Parameters

    Name Type Description
    doc Type
    		Doc Type The Document Type to set.

    Return

    Document — The document, for chaining.

    setRootElement(element)

    Sets the document's root Element node. If the document already has a root Element node, this method overwrites the old node.

    Parameters

    Name Type Description
    element
    		Element The root Element node to set.

    Return

    Document — The document, for chaining.
    Create a Mobile Website
    View Site in Mobile | Classic
    Share by: