[][src]Struct stdweb::web::Document

pub struct Document(_);

The Document interface represents any web page loaded in the browser and serves as an entry point into the web page's content, which is the DOM tree.

(JavaScript docs)

Methods

impl Document[src]

pub fn create_document_fragment(&self) -> DocumentFragment[src]

In an HTML document, the Document.createDocumentFragment() method creates a new empty DocumentFragment.

(JavaScript docs)

pub fn create_element(
    &self,
    tag: &str
) -> Result<Element, InvalidCharacterError>
[src]

In an HTML document, the Document.createElement() method creates the HTML element specified by tag, or an HTMLUnknownElement if tag isn't recognized. In other documents, it creates an element with a null namespace URI.

(JavaScript docs)

pub fn create_element_ns(
    &self,
    namespace_uri: &str,
    tag: &str
) -> Result<Element, CreateElementNsError>
[src]

Creates an element with the specified namespace URI and qualified name. To create an element without specifying a namespace URI, use the createElement method.

(JavaScript docs)

pub fn create_text_node(&self, text: &str) -> TextNode[src]

Creates a new text node.

(JavaScript docs)

pub fn location(&self) -> Option<Location>[src]

Returns a Location object which contains information about the URL of the document and provides methods for changing that URL and loading another URL.

(JavaScript docs)

pub fn body(&self) -> Option<HtmlElement>[src]

Returns the <body> or <frameset> node of the current document, or null if no such element exists.

(JavaScript docs)

pub fn head(&self) -> Option<HtmlElement>[src]

Returns the <head> element of the current document. If there are more than one <head> elements, the first one is returned.

(JavaScript docs)

pub fn title(&self) -> String[src]

Gets the title of the document.

(JavaScript docs)

pub fn set_title(&self, title: &str)[src]

Sets the title of the document.

(JavaScript docs)

pub fn document_element(&self) -> Option<Element>[src]

Returns the Element that is the root element of the document (for example, the <html> element for HTML documents).

(JavaScript docs)

pub fn pointer_lock_element(&self) -> Option<Element>[src]

Returns the Element that the pointer is locked to, if it is locked to any

(JavaScript docs)

pub fn exit_pointer_lock(&self)[src]

Exit the pointer lock on the current element

(JavaScript docs)

pub fn import_node<N: INode>(
    &self,
    n: &N,
    kind: CloneKind
) -> Result<Node, NotSupportedError>
[src]

Import node from another document

(JavaScript docs)

Trait Implementations

impl JsSerialize for Document[src]

impl TryFrom<EventTarget> for Document[src]

type Error = ConversionError

The type returned in the event of a conversion error.

impl TryFrom<Node> for Document[src]

type Error = ConversionError

The type returned in the event of a conversion error.

impl TryFrom<Document> for Reference[src]

type Error = Void

The type returned in the event of a conversion error.

impl TryFrom<Reference> for Document[src]

type Error = ConversionError

The type returned in the event of a conversion error.

impl<'_r> TryFrom<&'_r Reference> for Document[src]

type Error = ConversionError

The type returned in the event of a conversion error.

impl TryFrom<Value> for Document[src]

type Error = ConversionError

The type returned in the event of a conversion error.

impl<'_r> TryFrom<&'_r Value> for Document[src]

type Error = ConversionError

The type returned in the event of a conversion error.

impl InstanceOf for Document[src]

impl ReferenceType for Document[src]

impl IEventTarget for Document[src]

fn add_event_listener<T, F>(&self, listener: F) -> EventListenerHandle where
    T: ConcreteEvent,
    F: FnMut(T) + 'static, 
[src]

Adds given event handler to the list of event listeners for the specified EventTarget on which it's called. Read more

fn dispatch_event<T: IEvent>(&self, event: &T) -> Result<bool, TODO>[src]

Dispatches an Event at this EventTarget, invoking the affected event listeners in the appropriate order. Read more

impl INode for Document[src]

fn as_node(&self) -> &Node[src]

Casts a reference to this object into a reference to a Node.

fn append_child<T: INode>(&self, child: &T)[src]

Adds a node to the end of the list of children of a specified parent node. Read more

fn remove_child<T: INode>(&self, child: &T) -> Result<Node, NotFoundError>[src]

Removes a child node from the DOM. Read more

fn clone_node(&self, kind: CloneKind) -> Result<Self, TODO>[src]

Returns a duplicate of the node on which this method was called. Read more

fn contains<T: INode>(&self, node: &T) -> bool[src]

Checks whenever a given node is a descendant of this one or not. Read more

fn insert_before<T: INode, U: INode>(
    &self,
    new_node: &T,
    reference_node: &U
) -> Result<Node, InsertNodeError>
[src]

Inserts the specified node before the reference node as a child of the current node. Read more

fn replace_child<T: INode, U: INode>(
    &self,
    new_child: &T,
    old_child: &U
) -> Result<Node, InsertNodeError>
[src]

Replaces one hild node of the specified node with another. Read more

fn parent_node(&self) -> Option<Node>[src]

Returns the parent of this node in the DOM tree. Read more

fn first_child(&self) -> Option<Node>[src]

Returns the node's first child in the tree, or None if the node is childless. Read more

fn last_child(&self) -> Option<Node>[src]

Returns the node's last child in the tree, or None if the node is childless. Read more

fn next_sibling(&self) -> Option<Node>[src]

Returns the node's next sibling in the tree, or None if there isn't such a node. Read more

fn node_name(&self) -> String[src]

Returns the name of the node. Read more

fn node_type(&self) -> NodeType[src]

Returns the type of the node. Read more

fn node_value(&self) -> Option<String>[src]

Returns the value of the node. Read more

fn set_node_value(&self, value: Option<&str>)[src]

Sets the value of the node. Read more

fn owner_document(&self) -> Option<Document>[src]

Returns the Document that this node belongs to. Read more

fn parent_element(&self) -> Option<Element>[src]

Returns an Element that is the parent of this node. Returns null if the node has no parent or the parent is not an Element. Read more

fn previous_sibling(&self) -> Option<Node>[src]

Returns the node's previous sibling in the tree, or None if there isn't such a node. Read more

fn text_content(&self) -> Option<String>[src]

A property which represents the text content of a node and its descendants. Read more

fn set_text_content(&self, text: &str)[src]

Sets the text content of this node; calling thil removes all of node's children and replaces them with a single text node with the given value. Read more

fn child_nodes(&self) -> NodeList[src]

Returns a live collection of child nodes of this node. Read more

fn base_uri(&self) -> String[src]

Gets the base URL. Read more

fn has_child_nodes(&self) -> bool[src]

Returns whether this node has children nodes. Read more

fn is_default_namespace(&self, namespace: &str) -> bool[src]

Determines whether the given namespace is the default namespace of this node. Read more

fn is_equal_node<T: INode>(&self, node: &T) -> bool[src]

Tests whether this node is equal to another node. Two nodes are equal if they have the same type, defining characteristics, matching attributes, and so on. Read more

fn is_same_node<T: INode>(&self, node: &T) -> bool[src]

Test whether two Node references are the same. Read more

fn lookup_prefix(&self, namespace: &str) -> Option<String>[src]

Returns the prefix for the given namespace URI, if present. Read more

fn lookup_namespace_uri(&self, prefix: &str) -> Option<String>[src]

Returns the namespace URI for the given prefix. Read more

fn normalize(&self)[src]

Merges any adjacent text nodes and removes empty text nodes under this node. Read more

impl IParentNode for Document[src]

fn query_selector(&self, selector: &str) -> Result<Option<Element>, SyntaxError>[src]

Returns the first element that is a descendant of the element on which it is invoked that matches the specified group of selectors. Read more

fn query_selector_all(&self, selector: &str) -> Result<NodeList, SyntaxError>[src]

Returns a non-live NodeList of all elements descended from the element on which it is invoked that matches the specified group of CSS selectors. Read more

impl INonElementParentNode for Document[src]

fn get_element_by_id(&self, id: &str) -> Option<Element>[src]

Returns a reference to the element by its ID; the ID is a string which can be used to uniquely identify the element, found in the HTML id attribute. Read more

impl PartialEq<Document> for Document[src]

impl AsRef<Reference> for Document[src]

impl Clone for Document[src]

fn clone_from(&mut self, source: &Self)
1.0.0
[src]

Performs copy-assignment from source. Read more

impl From<Document> for EventTarget[src]

impl From<Document> for Node[src]

impl From<Document> for Reference[src]

impl Eq for Document[src]

impl Debug for Document[src]

Auto Trait Implementations

impl Send for Document

impl Sync for Document

Blanket Implementations

impl<T> ToOwned for T where
    T: Clone
[src]

type Owned = T

The resulting type after obtaining ownership.

impl<T> From for T[src]

impl<T, U> Into for T where
    U: From<T>, 
[src]

impl<T, U> TryFrom for T where
    U: Into<T>, 
[src]

type Error = Infallible

The type returned in the event of a conversion error.

impl<T, U> TryInto for T where
    U: TryFrom<T>, 
[src]

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

impl<T> Borrow for T where
    T: ?Sized
[src]

impl<T> BorrowMut for T where
    T: ?Sized
[src]

impl<T> Any for T where
    T: 'static + ?Sized
[src]