nginstack

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

  • Node

Members

<readonly> doctype :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:
  • DocumentType

documentElement :Element

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

Type:
  • Element

Methods

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
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
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
Comment

createDocumentFragment()

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

Returns:

Fragmento de documento criado.

Type
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
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
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
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
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
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
NodeList

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.