Class: Document

@nginstack/engine/lib/dom/Document~ Document

new Document()

Para cada documento XML carregado, existe um objeto Document. A interface Document serve como um ponto de entrada para o conteúdo ad árvore DOM que representa o XML e provê funcionalidades globais ao documento, como criar novos elementos.

A classe Document herda as propriedades e métodos de module:@nginstack/engine/lib/dom/Node~Node.

Documentação adaptada de Document dos Mozilla Contributors e licenciada sob CC-BY-SA 2.5.

Extends

Members

<readonly> childNodes :module:@nginstack/engine/lib/dom/NodeList~NodeList

Retorna um objeto NodeList "vivo" contendo todos os filhos deste nó. Dizer que um objeto NodeList é vivo significa que se houver alguma mudança em um dos filhos deste nó, o objeto NodeList é automaticamente atualizado com tais mudanças.

Type:
Inherited From:

<readonly> doctype :module:@nginstack/engine/lib/dom/DocumentType~DocumentType

Instância de module:@nginstack/engine/lib/dom/DocumentType~DocumentType associada a este documento. Para documentos XML sem uma declaração de tipo de documento ele retornará null. Para documentos HTML, uma instância de DocumentType pode ser retornada, independente da presença ou ausência da declaração de tipo de documento no HTML.

Provê acesso direto ao nó do tipo module:@nginstack/engine/lib/dom/DocumentType~DocumentType, filho deste documento.

Type:

documentElement :module:@nginstack/engine/lib/dom/Element~Element

Retorna o elemento que é o filho direto do documento. Para documentos HTML, ele é normalmente o elemento que representa a tag HTML.

Type:

<readonly> firstChild :module:@nginstack/engine/lib/dom/Node~Node

Retorna um Node representando o primeiro filho direto do nó ou null, caso o nó não tenha nenhum filho.

Type:
Inherited From:

<readonly> lastChild :module:@nginstack/engine/lib/dom/Node~Node

Retorna um Node representando o último filho direto do elemento ou null, caso o elemento não tenha nenhum filho.

Type:
Inherited From:

<readonly> namespaceURI :string

O espaço de nomes URI desse nó, ou null se não estiver no espaço de nomes.

Type:
  • string
Inherited From:
Deprecated:
  • Yes

<readonly> nextSibling :module:@nginstack/engine/lib/dom/Node~Node

Retorna um Node representando o próximo nó em uma árvore ou null se não existe tal nodo.

Type:
Inherited From:

<readonly> nodeName :string

Retorna uma DOMString contendo o nome do elemento, do Node. A estrutura do nome irá mudar conforme o tipo do elemento. Veja as diferenças na documentação do método Node.nodeName.

Type:
  • string
Inherited From:

<readonly> nodeType :NodeType|''

Retorna um número inteiro representando o tipo do nó. Os valores possíveis são:

  • ELEMENT_NODE: 1
  • ATTRIBUTE_NODE: 2
  • TEXT_NODE: 3
  • CDATA_SECTION_NODE: 4
  • ENTITY_REFERENCE_NODE: 5
  • ENTITY_NODE: 6
  • PROCESSING_INSTRUCTION_NODE: 7
  • COMMENT_NODE: 8
  • DOCUMENT_NODE: 9
  • DOCUMENT_TYPE_NODE: 10
  • DOCUMENT_FRAGMENT_NODE: 11
  • NOTATION_NODE: 12
Type:
  • NodeType| ''
Inherited From:

<readonly> nodeValue :string

Retorna ou define o valor do nó atual.

Type:
  • string
Inherited From:

<readonly> ownerDocument :module:@nginstack/engine/lib/dom/Document~Document

Retorna o Document qual esse nó pertence. Se o nó em si é um documento, retorna null.

Type:
Inherited From:

<readonly> parentNode :module:@nginstack/engine/lib/dom/Node~Node

Retorna um Node que é pai desse nó. Se não existe tal nó, como, por exemplo, se esse nó é o topo da árvore ou se ele não participa de uma árvore, essa propriedade retorna null.

Type:
Inherited From:

<readonly> prefix :string

É um DOMString representando o espaço de nomes do nó, ou null se nenhum prefixo é especificado.

Type:
  • string
Inherited From:

<readonly> previousSibling :module:@nginstack/engine/lib/dom/Node~Node

Retorna um Node representando o nó anterior em uma árvore ou null se não existe tal nodo.

Type:
Inherited From:

Methods

appendChild(newChild)

Adiciona um nó ao final da lista de filhos de um nó pai especificado.

Se filho é uma referência a um nó existente no documento, appendChild vai movê-lo de sua posição atual para a nova posição (i.e, não é necessário remover o nó de seu pai atual antes de adicioná-lo a outro nó).

Isso também significa que um nó não pode estar em dois lugares do documento ao mesmo tempo. Assim, se o nó já tem um pai, ele é primeiro removido para, só então, ser adicionado na nova posição.

Você pode usar o método #cloneNode para criar uma cópia do nó antes de adicioná-lo ao novo pai. Note que cópias feitas com o método cloneNode não serão mantidas sincronizadas automaticamente.

Parameters:
Name Type Description
newChild module:@nginstack/engine/lib/dom/Node~Node

É o nó a ser adicionado como filho de elemento.
Inherited From:
Returns:

Nó adicionado no DOM, o mesmo que foi informado em newChild.

Type
module:@nginstack/engine/lib/dom/Node~Node

cloneNode(deep)

Duplica um elemento node (nó) da estrutura de um documento DOM. Ele retorna um clone do elemento para o qual foi invocado.

Parameters:
Name Type Description
deep boolean

Indica se os elementos filhos do nó que está sendo clonado devem ser clonados juntos. Informe false para clonar apenas o nó específico dispensando, assim, qualquer elemento DOM filho.
Inherited From:
Returns:

O novo elemento node (nó) resultado da clonagem.

Type
module:@nginstack/engine/lib/dom/Node~Node

createAttribute(name)

Cria uma instância de module:@nginstack/engine/lib/dom/Attr~Attr com o nome informado.

Parameters:
Name Type Description
name string

Nome do novo atributo a ser criado.
Returns:

Atributo criado.

Type
module:@nginstack/engine/lib/dom/Attr~Attr

createCDATASection(data)

Cria uma instância de module:@nginstack/engine/lib/dom/CDATASection~CDATASection com o conteúdo informado.

Parameters:
Name Type Description
data string

Conteúdo do elemento a ser criado.
Returns:

Nó do tipo CDATASection criado.

Type
module:@nginstack/engine/lib/dom/CDATASection~CDATASection

createComment(data)

Cria uma instância de module:@nginstack/engine/lib/dom/Comment~Comment com o conteúdo informado.

Parameters:
Name Type Description
data string

Conteúdo do elemento a ser criado.
Returns:

Nó do tipo Comment criado.

Type
module:@nginstack/engine/lib/dom/Comment~Comment

createDocumentFragment()

Cria uma instância de module:@nginstack/engine/lib/dom/DocumentFragment~DocumentFragment vazia.

Returns:

Fragmento de documento criado.

Type
module:@nginstack/engine/lib/dom/DocumentFragment~DocumentFragment

createElement(tagName)

Cria uma nova instância de module:@nginstack/engine/lib/dom/Element~Element com o nome de tag informado.

Parameters:
Name Type Description
tagName string

O nome do tipo de elemento a ser instanciado.
Returns:

Elemento criado.

Type
module:@nginstack/engine/lib/dom/Element~Element

createEntityReference(name)

Cria uma instância de module:@nginstack/engine/lib/dom/EntityReference~EntityReference com o nome informado.

Parameters:
Name Type Description
name string

Nome da entidade referenciada.
Returns:

Nova instância de EntityReference.

Type
module:@nginstack/engine/lib/dom/EntityReference~EntityReference

createProcessingInstruction(target, data)

Cria uma instância de module:@nginstack/engine/lib/dom/ProcessingInstruction~ProcessingInstruction com o target e data informados.

Parameters:
Name Type Description
target string

Target da nova instrução de processamento.
data string

Dados da nova instrução de processamento.
Returns:

Nó de instrução de processamento criado.

Type
module:@nginstack/engine/lib/dom/ProcessingInstruction~ProcessingInstruction

createTextNode(data)

Cria uma instância de module:@nginstack/engine/lib/dom/Text~Text com o conteúdo informado.

Parameters:
Name Type Description
data string

Conteúdo do elemento a ser criado.
Returns:

Nó do tipo Text criado.

Type
module:@nginstack/engine/lib/dom/Text~Text

getElementById(elementId)

Obtém o elemento que possui o id informado. Se não existir um elemento com o id informado, será retornado null. O comportamento quando há mais de um elemento com o mesmo id é indefinido.

Parameters:
Name Type Description
elementId string

Id do elemento pesquisado.
Returns:

Elemento com o id informado ou null caso não haja um.

Type
module:@nginstack/engine/lib/dom/Element~Element

getElementsByTagName(tagName)

Retorna um module:@nginstack/engine/lib/dom/NodeList~NodeList de todos os elementos que possuam o nome de tag informado na ordem em que foram encontrados no documento.

Parameters:
Name Type Description
tagName string

Nome da tag a ser pesquisada.
Returns:

Elementos que possuem a tag informada.

Type
module:@nginstack/engine/lib/dom/NodeList~NodeList

hasChildNodes()

Este método retorna um valor booleano indicando se o nó corrente tem filhos ou não.

Inherited From:
Returns:

True se o nó tiver filhos.

Type
boolean

insertBefore(newChild, refChild)

Adiciona o nó especificado, antes de um elemento de referência, como filho do nó atual.

Parameters:
Name Type Description
newChild module:@nginstack/engine/lib/dom/Node~Node

O nó a ser inserido.
refChild module:@nginstack/engine/lib/dom/Node~Node

O nó antes do qual o newChild será inserido.
Inherited From:
Returns:

O nó sendo inserido, que é newChild.

Type
module:@nginstack/engine/lib/dom/Node~Node

load(path)

Carrega um documento XML a partir de um arquivo local.

Parameters:
Name Type Description
path string

Path do arquivo XML relativo ao Engine em execução.
Returns:

True se o arquivo pode ser carregado com sucesso.

Type
boolean

loadXML(xml)

Carrega um documento XML a partir de uma string com o seu conteúdo. Será gerado um erro caso o XML seja inválido.

Parameters:
Name Type Description
xml string

Conteúdo XML a ser carregado.

normalize()

Coloca o nó e todos os nós filhos nas suas formas normalizadas. Em uma subárvore normalizada não há nós do tipo Text vazios, nem há nós adjacentes desse mesmo tipo.

Inherited From:

removeChild(oldChild)

Remove um nó filho do DOM. Devolve o nó removido.

Parameters:
Name Type Description
oldChild module:@nginstack/engine/lib/dom/Node~Node

É o nó filho a ser removido do DOM.
Inherited From:
Returns:

Contém uma referência ao nó filho removido.

Type
module:@nginstack/engine/lib/dom/Node~Node

replaceChild(newChild, oldChild)

Substitui o elemento filho especificado por outro.

Parameters:
Name Type Description
newChild module:@nginstack/engine/lib/dom/Node~Node

É o novo elemento que será inserido no lugar do oldChild. Se já existir no DOM, será removido primeiro para depois ser inserido.
oldChild module:@nginstack/engine/lib/dom/Node~Node

É o elemento existente que será substituído.
Inherited From:
Returns:

É o elemento substituído. É o mesmo elemento que oldChild.

Type
module:@nginstack/engine/lib/dom/Node~Node