Introduction

Esta seção provê uma breve introdução conceitual ao DOM: o que ele é, como ele provê estruturas para documentos HTML e XML, como você pode acessá-lo, e como esta API apresenta informações de referência e exemplos.

O que é o DOM?

O Document Object Model (DOM) é uma interface de programação para documentos HTML e XML. Ele provê uma representação estruturada do documento e define um meio pelo qual a estrutura pode ser acessada por programas permitindo-os alterar a estrutura do documento, estilo e conteúdo. O DOM provê uma representação do documento como um conjunto estruturado de nós e objetos que têm propriedades e métodos. Essencialmente ele conecta páginas de internet a scripts ou linguagens de programação.

Uma página de internet é um documento. Este documento pode ser exibido numa janela de navegador, ou como código-fonte HTML. Mas é o mesmo documento em ambos os casos. O Document Object Model (DOM) provê uma outra forma de representar, armazenar e manipular o mesmo documento. O DOM é uma representação orientada a objeto completa da página, e pode ser modificada com uma linguagem de script como o JavaScript.

O padrão W3C DOM constitui as bases para a implementação do DOM nos mais modernos navegadores. Muitos navegadores oferecem extensões que vão além do padrão W3C, portanto a cautela deve ser exercida quando do seu uso em páginas onde os documentos podem ser acessados por vários navegadores com diferentes implementações do DOM.

Por exemplo, o DOM W3C especifica que o método getElementsByTagName no código abaixo deve retornar uma lista com todos os elementos <P> contidos no documento:

paragraphs = document.getElementsByTagName("P");
// paragraphs[0] é o primeiro elemento <p>
// paragraphs[1] é o segundo elemento <p>, etc.
alert(paragraphs[0].nodeName);

Todas as propriedades, métodos, e eventos disponíveis para manipular e criar páginas estão organizados em objetos (por exemplo, o objeto document representa o próprio documento, o objeto table implementa a interface DOM HTMLTableElement para acessar tabelas HTML, e assim por diante). Esta documentação dispõe uma referência objeto a objeto para o DOM implementado nos navegadores baseados no Gecko.

DOM e JavaScript

O rápido exemplo acima, parecido com a maioria dos exemplos desta referência, é JavaScript. Ou seja, ele foi escrito em JavaScript, mas ele usa o DOM para acessar o documento e seus elementos. O DOM não é uma linguagem de programação, mas sem ele, a linguagem JavaScript não teria nenhum modelo ou noção de páginas web, páginas XML e elementos com os quais ela geralmente lida. Todo elemento num documento—o documento como um todo, o cabeçalho, tabelas dentro do documento, cabeçalhos de tabelas, o texto dentro das células— faz parte do document object model para aquele documento, portanto eles podem ser acessados e manipulados fazendo-se uso do DOM e de uma linguagem de scripting como o JavaScript.

No início, JavaScript e o DOM eram fortemente ligados, mas eventualmente evoluíram em entidades separadas. O conteúdo da página é armazenado no DOM e pode ser acessado e manipulado via JavaScript, portanto nós podemos escrever esta equação aproximada:

API(web ou página XML) = DOM + JS(linguagem de scripting)

O DOM foi desenvolvido para ser independente de qualquer linguagem de programação em particular, tornando a representação estrutural do documento para uma única API consistente. Embora nos concentramos exclusivamente em JavaScript nesta documentação de referência, implementações do DOM por ser construídas para qualquer linguagem, como este exemplo em Python demonstra:

# Exemplo de DOM em Python
import xml.dom.minidom as m
doc = m.parse("C:\\Projects\\Py\\chap1.xml");
doc.nodeName # propriedade do DOM para o objeto document;
p_list = doc.getElementsByTagName("para");

Como eu acesso o DOM?

Você não tem que fazer nada de especial para começar a usar o DOM. Navegadores diferentes tem implementações diferentes do DOM, e estas implementações exibem graus de conformidade variantes em relação ao verdadeiro padrão DOM (um tema que tentamos evitar nesta documentação), mas cada navegador usa algum document object model para tornar as páginas acessíveis para script.

Quando você cria um script–quer seja um elemento in-line <script> or através de uma instrução de carregamento externo–você pode imediatamente começar a fazer uso da API para os elementos document ou window para manipular o próprio documento ou para acessar os filhos do documento, que são os vários elementos na página. Sua programação em DOM pode ser algo simples como o seguinte código, que mostra uma mensagem atráves da função alert() do objeto window, ou pode usar métodos do DOM mais sofisticados para realmente criar novos conteúdos como no exemplo maior mais abaixo.

<body onload="window.alert('welcome to my home page!');">

Aparte do elemento <script> no qual o Javascript é definido, este Javascript define uma função a ser executada quando o documento é carregado (e quando todo o DOM está disponível para uso). Esta função cria um novo elemento H1, adiciona texto ao elemento e então adiciona o H1 à árvore deste documento.

<html>
<head>
<script>
// executa esta função quando o documento está carregado
window.onload = function() {
   // cria um par de elementos numa 
   // página HTML outrora vazia
   heading = document.createElement("h1");
   heading_text = document.createTextNode("Big Head!");
   heading.appendChild(heading_text);
   document.body.appendChild(heading);
}
</script>
</head>
<body>
</body>
</html>

Tipos de dados importantes

Esta referência tenta descrever os vários objetos e tipos da maneira mais simples quanto possível. Mas há uma série de diferentes de tipos de dados sendo passados pela API dos quais você deve estar ciente. Por uma questão de simplicidade, exemplos de sintaxe nesta referência da API tipicamente se referem aos nós como elements, a arrays de nós como nodeLists (ou simplesmente elements), e a atributos dos nós como attributes.

A seguinte tabela descreve brevemente estes tipos de dados.

The following table briefly describes these data types.

Interfaces DOM

Este guia é sobre os objetos e as verdadeiras coisas que você pode usar para manipular a hierarquia do DOM. É muitas vezes uma questão de indiferença que o objeto representando o elemento HTML form pegue sua propriedade name da interface HTMLFormElement mas sua propriedade className da própria interface HTMLElement. Em ambos os casos, a propriedade que você quer está simplesmente no objeto form.

Mas a relação entre objetos e interfaces que eles implementam no DOM podem ser confusos, e portanto esta seção tenta dizer um pouco mais sobre as interfaces reais da especificação do DOM e como elas se tornam disponíveis.

Interfaces e Objetos

Muitos objetos se valem de muitas interfaces diferentes. O objeto table, por exemplo, implementa uma Interface do elemento HTML Table especializada, que inclui métodos como createCaption e insertRow. Mas desde que ele também é um elemento HTML, table implementa a interface Element descrita no capítulo Referência de element do DOM. E finalmente, com um elemento HTML também é, assim como o DOM lhe considera, um nó em uma árvore de nós que criam um modelo de objeto para uma página web ou uma página XML, o elemento table também implementa a mais básica interface Node, a partir da qual o Element deriva.

Quando você tem uma referência para um objeto table, como no exemplo a seguir, você rotineiramente usa todas as três interfaces indiferentemente no objeto, talvez sem saber.

var table = document.getElementById("table");
var tableAttrs = table.attributes; // Node/Element interface
for(var i = 0; i < tableAttrs.length; i++){
  // HTMLTableElement interface: border attribute
  if(tableAttrs[i].nodeName.toLowerCase() == "border")
    table.border = "1"; 
}
// HTMLTableElement interface: summary attribute
table.summary = "note: increased border";

Interfaces do núcleo do DOM

Esta seção lista algumas das interfaces mais comumente usadas no DOM. A idéia não é descrever aqui o que estas APIs fazem, mas sim te dar uma idéia dos tipos de métodos e propriedades que você verá muitas vezes enquanto você usa o DOM. Estas APIs comuns são usadas nos exemplos mais extensos no capítulo Exemplos de DOM no final deste livro.

Os objetos document e window são os objetos cuja interface você geralmente vai usar na maioria das vezes na programação com DOM. Em termos simples, o objeto window representa algo como o navegador, e o objeto document é a raiz do próprio documento. Element descende da interface genérica Node, e estas duas juntas fornecem muitos dos métodos e propriedades que você usa em elementos individuais. Estes elementos também podem ter interfaces específicas para lidar com os tipos de dados que eles contém, como no exemplo do objeto table na seção anterior.

A seguir está uma breve lista das APIs comuns para scripting usando o DOM em web e páginas XML.

• document.getElementById(id)
• element.getElementsByTagName(name)
• document.createElement(name)
• parentNode.appendChild(node)
• element.innerHTML
• element.style.left
• element.setAttribute
• element.element.getAttribute
• element.addEventListener
• window.content
• window.onload
• window.dump
• window.scrollTo

Testando a API do DOM

Este documento fornece amostras para cada interface que você pode usar em seu próprio desenvolvimento web. Em alguns casos, as amostras são páginas HTML completas, com o acesso ao DOM em um elemento <script>, a interface (por exemplo, botões) necessária para disparar o script em um form, e os elementos HTML sobre os quais o DOM opera listados. Quando for este o caso, você pode copiar a colar o conteúdo do exemplo dentro de um novo arquivo HTML, salvá-lo, e executar o exemplo em um navegador.

Há casos, no entanto, que os exemplos são mais concisos. Para executar exemplos que apenas demonstram a relação básica da interface para com os elementos HTML, você pode criar uma página de teste na qual as interfaces podem facilmente ser acessadas por scripts. A seguinte página web, bem simples, fornece um elemento <script> no seu cabeçalho onde você pode colocar funções que testam a interface, alguns poucos elementos HTML com atributos que você pode remover, criar, ou alterar, e a interface web necessária para chamar aquelas funções pelo navegador.

Você pode usar esta página de teste ou criar uma similar a fim de testar as interfaces do DOM nas quais você está interessado e ver como elas funcionam na plataforma do navegador. Você pode atualizar o conteúdo da função test() como necessário, criar mais botões, ou adicionar elementos conforme a necessidade.

<html>
<head>
<title>DOM Tests</title>
<script type="application/x-javascript">
function setBodyAttr(attr,value){
  if(document.body) eval('document.body.'+attr+'="'+value+'"');
  else notSupported();
}
</script>
</head> 
<body>
<div style="margin: .5in; height="400""> 
<p><b><tt>text</tt> color</p> 
<form> 
<select onChange="setBodyAttr('text',
    this.options[this.selectedIndex].value);"> 
<option value="black">black 
<option value="darkblue">darkblue 
</select>
 <p><b><tt>bgColor</tt></p>
 <select onChange="setBodyAttr('bgColor',
    this.options[this.selectedIndex].value);"> 
<option value="white">white 
<option value="lightgrey">gray
 </select>
<p><b><tt>link</tt></p> 
<select onChange="setBodyAttr('link',
     this.options[this.selectedIndex].value);">
<option value="blue">blue
<option value="green">green
</select>  <small>
     <a href="https://www.brownhen.com/dom_api_top.html" id="sample">
(sample link)</a></small><br>
</form>
<form>
  <input type="button" value="version" onclick="ver()" />
</form>
</div>
</body>
</html>

Para testar muitas interfaces em uma única página–por exemplo, uma "suite" de propriedades que afetam as cores de sua página web–você pode criar uma página de testes similar com um completo console de botões, campos de texto e outros elementos HTML. A seguinte captura de tela pode te dar alguma idéia de como as interfaces podem estar agrupadas para teste.

Figure 0.1 Amostra de uma página de teste do DOM

Neste exemplo, os menus dropdown atualizam dinamicamente aspectos da página que são acessíveis ao DOM como a cor de fundo (bgColor), a cor dos hyperlinks (aLink), e a cor do texto (text). Contudo você criar suas próprias páginas de teste e testar as interfaces ao passo que você lê sobre elas é uma parte importante do aprendizado de como usar o DOM efetivamente.