Classe SWFAddress

A classe SWFAddress pode ser configurada automáticamente com os parâmetros de chamada na propriedade src do JavaScript.
Exemplo <script language=javascript src="swfaddress.js?history=1&tracker=pageTracker._trackPageview&strict=1."></script>
A lista de opções suportadas inclui:

history:Boolean - Activa ou desactiva a criação de um registo do histórico de navegação.
strict:Boolean - Activa ou desactiva o modo strict .
tracker:String - Define a função para fazer o tracking da estatística das visitas.

Metodos Públicos

addEventListener(type, listener): void
[estática] Regista um event listener.
addId(id): void
[estática] Adiciona um id à lista de objectos Flash registados para a API.
back(): void
[estática] Carrega o último URL do histórico de navegação.
dispatchEvent(event): Boolean
[estática] Dispara um evento para todos os event listeners registados.
forward(): void
[estática] Carrega o próximo URL do histórico de navegação.
getBaseURL(): String
[static] Retorna o endereco base do documento.
getHistory(): Boolean
[estática] Devolve a configuração do histórico.
getId(index): String
[estática] Devolve a id do objecto Flash registado naquele indice.
getIds(): Array
[estática] Devolve a listagem de todos os objectos Flash registados.
getParameter(param): String
[estática] Devolve o valor de um parametro da querystring.
getParameterNames(): Array
[estática] Devolve a listagem de todos os nomes de parâmetros existentes na querystring.
getPath(): String
[estática] Devolve o valor da âncora, sem a querystring.
getPathNames(): Array
[static] Retorna uma lista de todas as pastas no caminho da ancora.
getQueryString(): String
[estática] Devolve a querystring.
getStatus(): String
[estática] Devolve o texto de estado da janela do navegador.
getStrict(): Boolean
[estática] Devolve o estado do modo strinct.
getTitle(): String
[estática] Devolve o título do documento HTML.
getTracker(): String
[estática] Devolve a função JavaScript definida como tracker da visualização da página.
getValue(): String
[estática] Devolve o valor da âncora.
go(delta): void
[estática] Carrega um URL da lista do histórico.
hasEventListener(event): Boolean
[estática] Verifica se existe algum event listener registado para um tipo de evento.
href(url, target): void
[estática] Carrega um novo URL no navegador.
popup(url, name, options, handler): void
[estática] Abre uma nova janela do navegador.
removeEventListener(type, listener): void
[estática] Remove um event listener.
removeId(id): void
[estática] Remove um id da lista de objectos Flash registados.
resetStatus(): void
[estática] Elimina o texto de estado da janela do navegador.
setHistory(history): void
[estática] Activa ou desactiva a criação de entradas no histórico.
setId(id): void
[estática] Define o id de um único objecto Flash para ser registado pela a API.
setStatus(status): void
[estática] Define o texto do estado da janela do navegador.
setStrict(strict): void
[estática] Activa ou desactiva o modo strict
setTitle(title): void
[estática] Define o título do documento HTML.
setTracker(tracker): void
[estática] Define uma função para fazer o page view tracking.
setValue(value): void
[estática] Define o valor da âncora.

Detalhe dos Métodos

addEventListener

public static function addEventListener(type, listener):void

Regista um event listener.

Parâmetros:
type:String - Tipo de evento.
listener:Function - Event listener.

addId

public static function addId(id):void

Adiciona um id à lista de objectos Flash registados para a API.

Parâmetros:
id:String - ID do objecto Flash

back

public static function back():void

Carrega o último URL do histórico de navegação.


dispatchEvent

public static function dispatchEvent(event):Boolean

Dispara um evento para todos os event listeners registados.

Parâmetros:
event:Object - Objecto de event.
Retorna:
Boolean 

forward

public static function forward():void

Carrega o próximo URL do histórico de navegação.


getBaseURL

public static function getBaseURL():String

Retorna o endereco base do documento.

Returns:
String 

getHistory

public static function getHistory():Boolean

Devolve a configuração do histórico.

Retorna:
Boolean 

getId

public static function getId(index):String

Devolve a id do objecto Flash registado naquele indice.

Parâmetros:
indice
Retorna:
String 

getIds

public static function getIds():Array

Devolve a lista completa dos objectos Flash registados.

Retorna:
Array 

getParameter

public static function getParameter(param):String

Devolve o valor de um parametro da querystring.

Parâmetros:
param:String - Nome do parâmetro.
Retorna:
String 

getParameterNames

public static function getParameterNames():Array

Devolve a listagem de todos os nomes de parâmetros existentes na querystring.

Retorna:
Array 

getPath

public static function getPath():String

Devolve o valor da âncora, sem a querystring.

Retorna:
String 

getPathNames

public static function getPathNames():Array

Retorna uma lista de todas as pastas no caminho da ancora.

Returns:
Array 

getQueryString

public static function getQueryString():String

Devolve a querystring.

Retorna:
String 

getStatus

public static function getStatus():String

Devolve o texto de estado da janela do navegador.

Retorna:
String 

getStrict

public static function getStrict():Boolean

Devolve o estado do modo strinct.

Retorna:
Boolean 

getTitle

public static function getTitle():String

Devolve o título do documento HTML.

Retorna:
String 

getTracker

public static function getTracker():String

Devolve a função JavaScript definida como tracker da visualização da página.

Retorna:
String 

getValue

public static function getValue():String

Devolve o valor da âncora.

Retorna:
String 

go

public static function go(delta):void

Carrega um URL da lista do histórico.

Parâmetros:
delta:Number - Um inteiro que representa a posição relativa na lista de histórico.

hasEventListener

public static function hasEventListener(event):Boolean

Verifica se existe algum event listener registado para um tipo de evento.

Parâmetros:
event:String - Tipo de evento.
Retorna:
Boolean 

href

public static function href(url, target):void

Carrega um novo URL no navegador.

Parâmetros:
url:String - Localização do conteúdo a ser aberto.
target:String - Janela de destino.

popup

public static function popup(url, name, options, handler):void

Abre uma nova janela do navegador.

Parâmetros:
url:String - Localização do conteúdo a ser aberto.
name:String - Nome da nova janela .
options:String - Opções passadas como parâmetro para o método window.open() do javascript do navegador.
handler:String - Código JavaScript opcional para gerir a nova janela.

removeEventListener

public static function removeEventListener(type, listener):void

Remove um event listener.

Parâmetros:
type:String - Tipo de evento.
listener:Function - Event listener.

removeId

public static function removeId(id):void

Elimina um id da lista de objectos Flash registados pela API

Parâmetros:
id:String - ID do objecto.

resetStatus

public static function resetStatus():void

Elimina o texto de estado da janela do navegador.


setHistory

public static function setHistory(history):void

Activa ou desactiva a criação de entradas no histórico.

Parâmetros:
history:Boolean - Estado do histórico.

setId

public static function setId(id):void

Define o id de um único objecto Flash a ser utilizado pela API.

Parâmetros:
id:String - ID do objecto.

setStatus

public static function setStatus(status):void

Define o texto do estado da janela do navegador.

Parâmetros:
status:String - Texto a utilizar.

setStrict

public static function setStrict(strict):void

Activa ou desactiva o modo Strict. Com o modo activo, a API força a utilização da barra "/" quando se chama o setValue.

Parâmetros:
strict:Boolean - Estado do modo Strict.

setTitle

public static function setTitle(title):void

Define o título do documento HTML.

Parâmetros:
title:String - Novo texto do título.

setTracker

public static function setTracker(tracker):void

Define a função para ser utilizada nas chamadas ao tracker de visualização da página.
A função pré-definida é 'urchinTracker' utilizado pelo google analytics.

Parâmetros:
tracker:String - Função do tracker.

setValue

public static function setValue(value):void

Define o valor da âncora.

Parâmetros:
value:String - Um valor que será adicionado no fim do endereço do documento HTML actual.

Notas do tradutor:
Na versão inglesa utiliza-se o termo deep linking para definir o tipo de funcionalidade que esta API proporciona e para indicar o modo como efectivamente a comunica ao navegador e ao flash. No fundo coloca um cardinal (#) no fim do endereço e depois concatena o destino pretendido (ex: default.html#destino). Como o HTML já permitia este tipo de abordagem definida como âncora, optámos por utilizar a mesma nomenclatura, sendo que no exemplo anterior o valor da âncora é igual a "destino".