Class Document

Document

Uma representação de um documento XML.

Métodos

Método	Tipo de retorno	Breve descrição
addContent(content)	Document	Acrescenta o nó especificado ao final do documento.
addContent(index, content)	Document	Insere o nó especificado no índice especificado entre todos os nós que são filhos imediatos do documento.
cloneContent()	Content[]	Cria cópias desanexadas de todos os nós que são filhos imediatos do documento.
detachRootElement()	Element|null	Desanexa e retorna o nó Element raiz do documento.
getAllContent()	Content[]	Recebe todos os nós que são filhos imediatos do documento.
getContent(index)	Content|null	Recebe o nó no índice especificado entre todos os nós que são filhos imediatos do documento.
getContentSize()	Integer	Recebe o número de nós que são filhos imediatos do documento.
getDescendants()	Content[]	Recebe todos os nós que são filhos diretos ou indiretos do documento, na ordem em que aparecem no documento.
getDocType()	DocType|null	Recebe a declaração DocType do documento.
getRootElement()	Element|null	Recebe o nó Element raiz do documento.
hasRootElement()	Boolean	Determina se o documento tem um nó Element raiz.
removeContent()	Content[]	Remove todos os nós que são filhos imediatos do documento.
removeContent(content)	Boolean	Remove o nó especificado, se ele for um filho imediato do documento.
removeContent(index)	Content|null	Remove o nó no índice especificado entre todos os nós que são filhos imediatos do documento.
setDocType(docType)	Document	Define a declaração DocType do documento.
setRootElement(element)	Document	Define o nó Element raiz do documento.

Documentação detalhada

addContent(content)

Acrescenta o nó especificado ao final do documento. O argumento content pode ser um objeto Content ou qualquer objeto de nó que corresponda a um tipo listado em ContentType. No entanto, um documento só pode ter um nó Element filho, que é implicitamente o nó Element raiz.

Parâmetros

Nome	Tipo	Descrição
content	Content	O nó a ser acrescentado.

Retornar

Document — O documento, para encadeamento.

---

addContent(index, content)

Insere o nó especificado no índice especificado entre todos os nós que são filhos imediatos do documento. O argumento content pode ser um objeto Content ou qualquer objeto de nó que corresponda a um tipo listado em ContentType. No entanto, um documento só pode ter um nó Element filho, que é implicitamente o nó Element raiz.

Parâmetros

Nome	Tipo	Descrição
index	Integer	O índice em que o nó será inserido entre todos os nós que são filhos imediatos do documento.
content	Content	O nó a ser inserido.

Retornar

Document — O documento, para encadeamento.

---

cloneContent()

Cria cópias desanexadas de todos os nós que são filhos imediatos do documento.

Retornar

Content[] — Uma matriz de cópias desanexadas de todos os nós que são filhos imediatos do documento.

---

detachRootElement()

Desanexa e retorna o nó Element raiz do documento. Se o documento não tiver um nó Element raiz, esse método retornará null.

Retornar

Element|null — O nó Element desanexado ou null se o documento não tiver um nó Element raiz.

---

getAllContent()

Recebe todos os nós que são filhos imediatos do documento.

Retornar

Content[] — Uma matriz de todos os nós que são filhos imediatos do documento.

---

getContent(index)

Recebe o nó no índice especificado entre todos os nós que são filhos imediatos do documento. Se não houver um nó no índice especificado, esse método retornará null.

Parâmetros

Nome	Tipo	Descrição
index	Integer	O índice do nó entre todos os nós que são filhos imediatos do documento.

Retornar

Content|null — O nó ou null se não houver um nó no índice especificado.

---

getContentSize()

Recebe o número de nós que são filhos imediatos do documento.

Retornar

Integer — O número de nós que são filhos imediatos do documento.

---

getDescendants()

Recebe todos os nós que são filhos diretos ou indiretos do documento, na ordem em que aparecem no documento.

Retornar

Content[] — Uma matriz de todos os nós que são filhos diretos ou indiretos do documento.

---

getDocType()

Recebe a declaração DocType do documento. Se o documento não tiver um nó DocumentType, esse método retornará null.

Retornar

DocType|null — O nó DocumentType ou null se o documento não tiver um nó DocumentType.

---

getRootElement()

Recebe o nó Element raiz do documento. Se o documento não tiver um nó Element raiz, esse método retornará null.

Retornar

Element|null — O nó Element raiz ou null se o documento não tiver um nó Element raiz.

---

hasRootElement()

Determina se o documento tem um nó Element raiz.

Retornar

Boolean — true se o documento tiver um nó Element raiz; false caso contrário.

---

removeContent()

Remove todos os nós que são filhos imediatos do documento.

Retornar

Content[] — Uma matriz de todos os nós que eram filhos imediatos do documento antes de serem removidos.

---

removeContent(content)

Remove o nó especificado, se ele for um filho imediato do documento. O argumento content pode ser um objeto Content ou qualquer objeto de nó que corresponda a um tipo listado em ContentType.

Parâmetros

Nome	Tipo	Descrição
content	Content	O nó a ser removido.

Retornar

Boolean — true se o nó era um filho imediato e foi removido; false caso contrário.

---

removeContent(index)

Remove o nó no índice especificado entre todos os nós que são filhos imediatos do documento. Se não houver um nó no índice especificado, esse método retornará null.

Parâmetros

Nome	Tipo	Descrição
index	Integer	O índice do nó entre todos os nós que são filhos imediatos do documento.

Retornar

Content|null — O nó removido ou null se não houver um nó no índice especificado.

---

setDocType(docType)

Define a declaração DocType do documento. Se o documento já tiver um nó DocType diferente, esse método vai substituir o nó antigo. Esse método gera uma exceção se o documento já contiver o mesmo nó DocType que está sendo definido.

Parâmetros

Nome	Tipo	Descrição
docType	DocType	O DocumentType a ser definido.

Retornar

Document — O documento, para encadeamento.

---

setRootElement(element)

Define o nó Element raiz do documento. Se o documento já tiver um nó Element raiz, esse método vai substituir o nó antigo.

Parâmetros

Nome	Tipo	Descrição
element	Element	O nó Element raiz a ser definido.

Retornar

Document — O documento, para encadeamento.