Trait xml_dom::level2::Element

pub trait Element: Node {
    fn get_attribute(&self, name: &str) -> Option<String>;
    fn set_attribute(&mut self, name: &str, value: &str) -> Result<()>;
    fn remove_attribute(&mut self, _name: &str) -> Result<()>;
    fn get_attribute_node(&self, name: &str) -> Option<Self::NodeRef>;
    fn set_attribute_node(
        &mut self, 
        new_attribute: Self::NodeRef
    ) -> Result<Self::NodeRef>;
    fn remove_attribute_node(
        &mut self, 
        _old_attribute: Self::NodeRef
    ) -> Result<Self::NodeRef>;
    fn get_elements_by_tag_name(&self, _tag_name: &str) -> Vec<Self::NodeRef>;
    fn get_attribute_ns(
        &self, 
        _namespace_uri: &str, 
        _local_name: &str
    ) -> Option<String>;
    fn set_attribute_ns(
        &mut self, 
        namespace_uri: &str, 
        qualified_name: &str, 
        value: &str
    ) -> Result<()>;
    fn remove_attribute_ns(
        &mut self, 
        _namespace_uri: &str, 
        _local_name: &str
    ) -> Result<()>;
    fn get_attribute_node_ns(
        &self, 
        _namespace_uri: &str, 
        _local_name: &str
    ) -> Option<Self::NodeRef>;
    fn set_attribute_node_ns(
        &mut self, 
        _new_attribute: Self::NodeRef
    ) -> Result<Self::NodeRef>;
    fn get_elements_by_tag_name_ns(
        &self, 
        _namespace_uri: &str, 
        _local_name: &str
    ) -> Vec<Self::NodeRef>;
    fn has_attribute(&self, name: &str) -> bool;
    fn has_attribute_ns(&self, namespace_uri: &str, local_name: &str) -> bool;

    fn tag_name(&self) -> String { ... }
}

This corresponds to the DOM Element interface.

Specification

The Element interface represents an element in an HTML or XML document. Elements may have attributes associated with them; since the Element interface inherits from Node, the generic Node interface attribute attributes may be used to retrieve the set of all attributes for an element. There are methods on the Element interface to retrieve either an Attr object by name or an attribute value by name. In XML, where an attribute value may contain entity references, an Attr object should be retrieved to examine the possibly fairly complex sub-tree representing the attribute value. On the other hand, in HTML, where all attributes have simple string values, methods to directly access an attribute value can safely be used as a convenience.

Note: In DOM Level 2, the method normalize is inherited from the Node interface where it was moved.

Required Methods

fn get_attribute(&self, name: &str) -> Option<String>

Retrieves an attribute value by name.

Specification

Parameters

• name of type DOMString: The name of the attribute to retrieve.

Return Value

• DOMString: The Attr value as a string, or the empty string if that attribute does not have a specified or default value.

fn set_attribute(&mut self, name: &str, value: &str) -> Result<()>

Adds a new attribute.

Specification

If an attribute with that name is already present in the element, its value is changed to be that of the value parameter. This value is a simple string; it is not parsed as it is being set. So any markup (such as syntax to be recognized as an entity reference) is treated as literal text, and needs to be appropriately escaped by the implementation when it is written out. In order to assign an attribute value that contains entity references, the user must create an Attr node plus any Text and EntityReference nodes, build the appropriate subtree, and use setAttributeNode to assign it as the value of an attribute.

To set an attribute with a qualified name and namespace URI, use the setAttributeNS method.

Parameters

• name of type DOMString: The name of the attribute to create or alter. value of type DOMString: Value to set in string form.

Exceptions

• INVALID_CHARACTER_ERR: Raised if the specified name contains an illegal character.
• NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.

fn remove_attribute(&mut self, _name: &str) -> Result<()>

Removes an attribute by name. If the removed attribute is known to have a default value, an attribute immediately appears containing the default value as well as the corresponding namespace URI, local name, and prefix when applicable.

Specification

To remove an attribute by local name and namespace URI, use the removeAttributeNS method.

Parameters

• name of type DOMString: The name of the attribute to remove.

Exceptions

• NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.

fn get_attribute_node(&self, name: &str) -> Option<Self::NodeRef>

Retrieves an attribute node by name.

Specification

To retrieve an attribute node by qualified name and namespace URI, use the getAttributeNodeNS method.

Parameters

• name of type DOMString: The name (nodeName) of the attribute to retrieve.

Return Value

• Attr: The Attr node with the specified name (nodeName) or null if there is no such attribute.

fn set_attribute_node(
    &mut self,
    new_attribute: Self::NodeRef
) -> Result<Self::NodeRef>

Adds a new attribute node.

Specification

If an attribute with that name (nodeName) is already present in the element, it is replaced by the new one.

To add a new attribute node with a qualified name and namespace URI, use the setAttributeNodeNS method.

Parameters

• newAttr of type Attr: The Attr node to add to the attribute list.

Return Value

• Attr: If the newAttr attribute replaces an existing attribute, the replaced Attr node is returned, otherwise null is returned.

Exceptions

• WRONG_DOCUMENT_ERR: Raised if newAttr was created from a different document than the one that created the element.
• NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.
• INUSE_ATTRIBUTE_ERR: Raised if newAttr is already an attribute of another Element object. The DOM user must explicitly clone Attr nodes to re-use them in other elements.

fn remove_attribute_node(
    &mut self,
    _old_attribute: Self::NodeRef
) -> Result<Self::NodeRef>

Removes the specified attribute node.

Specification

If the removed Attr has a default value it is immediately replaced. The replacing attribute has the same namespace URI and local name, as well as the original prefix, when applicable.

Parameters

• oldAttr of type Attr: The Attr node to remove from the attribute list.

Return Value

• Attr: The Attr node that was removed.

Exceptions

• NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.
• NOT_FOUND_ERR: Raised if oldAttr is not an attribute of the element.

fn get_elements_by_tag_name(&self, _tag_name: &str) -> Vec<Self::NodeRef>

Returns a NodeList of all descendant Elements with a given tag name, in the order in which they are encountered in a preorder traversal of this Element tree.

Specification

Parameters

• name of type DOMString: The name of the tag to match on. The special value “*” matches all tags.

Return Value

• NodeList: A list of matching Element nodes.

fn get_attribute_ns(
    &self,
    _namespace_uri: &str,
    _local_name: &str
) -> Option<String>

Retrieves an attribute value by local name and namespace URI.

Specification

HTML-only DOM implementations do not need to implement this method.

Parameters

• namespaceURI of type DOMString: The namespace URI of the attribute to retrieve.
• localName of type DOMString: The local name of the attribute to retrieve.

Return Value

• DOMString: The Attr value as a string, or the empty string if that attribute does not have a specified or default value.

fn set_attribute_ns(
    &mut self,
    namespace_uri: &str,
    qualified_name: &str,
    value: &str
) -> Result<()>

Adds a new attribute.

Specification

If an attribute with the same local name and namespace URI is already present on the element, its prefix is changed to be the prefix part of the qualifiedName, and its value is changed to be the value parameter. This value is a simple string; it is not parsed as it is being set. So any markup (such as syntax to be recognized as an entity reference) is treated as literal text, and needs to be appropriately escaped by the implementation when it is written out. In order to assign an attribute value that contains entity references, the user must create an Attr node plus any Text and EntityReference nodes, build the appropriate subtree, and use setAttributeNodeNS or setAttributeNode to assign it as the value of an attribute.

HTML-only DOM implementations do not need to implement this method.

Parameters

• namespaceURI of type DOMString: The namespace URI of the attribute to create or alter.
• qualifiedName of type DOMString: The qualified name of the attribute to create or alter.
• value of type DOMString: The value to set in string form.

Exceptions

• INVALID_CHARACTER_ERR: Raised if the specified qualified name contains an illegal character.
• NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.
• NAMESPACE_ERR: Raised if the qualifiedName is malformed, if the qualifiedName has a prefix and the namespaceURI is null, if the qualifiedName has a prefix that is “xml” and the namespaceURI is different from “http://www.w3.org/XML/1998/namespace”, or if the qualifiedName is “xmlns” and the namespaceURI is different from “http://www.w3.org/2000/xmlns/”.

fn remove_attribute_ns(
    &mut self,
    _namespace_uri: &str,
    _local_name: &str
) -> Result<()>

Removes an attribute by local name and namespace URI.

Specification

If the removed attribute has a default value it is immediately replaced. The replacing attribute has the same namespace URI and local name, as well as the original prefix.

HTML-only DOM implementations do not need to implement this method.

Parameters

• namespaceURI of type DOMString: The namespace URI of the attribute to remove.
• localName of type DOMString: The local name of the attribute to remove.

Exceptions

• NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.

fn get_attribute_node_ns(
    &self,
    _namespace_uri: &str,
    _local_name: &str
) -> Option<Self::NodeRef>

Retrieves an Attr node by local name and namespace URI.

Specification

HTML-only DOM implementations do not need to implement this method.

Parameters

• namespaceURI of type DOMString: The namespace URI of the attribute to retrieve.
• localName of type DOMString: The local name of the attribute to retrieve.

Return Value

• Attr: The Attr node with the specified attribute local name and namespace URI or null if there is no such attribute.

fn set_attribute_node_ns(
    &mut self,
    _new_attribute: Self::NodeRef
) -> Result<Self::NodeRef>

Adds a new attribute.

Specification

If an attribute with that local name and that namespace URI is already present in the element, it is replaced by the new one.

HTML-only DOM implementations do not need to implement this method.

Parameters

• newAttr of type Attr: The Attr node to add to the attribute list.

Return Value

• Attr: If the newAttr attribute replaces an existing attribute with the same local name and namespace URI, the replaced Attr node is returned, otherwise null is returned.

Exceptions

• WRONG_DOCUMENT_ERR: Raised if newAttr was created from a different document than the one that created the element.
• NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.
• INUSE_ATTRIBUTE_ERR: Raised if newAttr is already an attribute of another Element object. The DOM user must explicitly clone Attr nodes to re-use them in other elements.

fn get_elements_by_tag_name_ns(
    &self,
    _namespace_uri: &str,
    _local_name: &str
) -> Vec<Self::NodeRef>

Returns a NodeList of all the descendant Elements with a given local name and namespace URI in the order in which they are encountered in a preorder traversal of this Element tree.

Specification

HTML-only DOM implementations do not need to implement this method.

Parameters

• namespaceURI of type DOMString: The namespace URI of the elements to match on. The special value “*” matches all namespaces.
• localName of type DOMString: The local name of the elements to match on. The special value “*” matches all local names.

Return Value

• NodeList: A new NodeList object containing all the matched Elements.

fn has_attribute(&self, name: &str) -> bool

Returns true when an attribute with a given name is specified on this element or has a default value, false otherwise.

Specification

Parameters

• name of type DOMString: The name of the attribute to look for.

Return Value

• boolean: true if an attribute with the given name is specified on this element or has a default value, false otherwise.

fn has_attribute_ns(&self, namespace_uri: &str, local_name: &str) -> bool

Returns true when an attribute with a given local name and namespace URI is specified on this element or has a default value, false otherwise.

Specification

HTML-only DOM implementations do not need to implement this method.

Parameters

• namespaceURI of type DOMString: The namespace URI of the attribute to look for. localName of type DOMString: The local name of the attribute to look for.

Return Value

• boolean: true if an attribute with the given local name and namespace URI is specified or has a default value on this element, false otherwise.

Provided Methods

fn tag_name(&self) -> String

The name of the element.

Specification

For example, in:

<elementExample id="demo">
        ...
</elementExample>

tagName has the value “elementExample”. Note that this is case-preserving in XML, as are all of the operations of the DOM. The HTML DOM returns the tagName of an HTML element in the canonical uppercase form, regardless of the case in the source HTML document.

Implementors

impl Element for RefNode