Classe SWFAddress

O SWFAddress é distribuido como uma classe de topo de nível. Os projectos que utilizem pacotes de código devem utilizá-la com o pacote com.asual.swfaddress.

Propriedades Públicas

onChange:Função
[estática] Chamada quando há uma mudança no endereço
onInit:Função
[estática] Chamada quando ocorre a inicialização da API.

Métodos Públicos

addEventListener(type:String, listener:Function):void
[estática] Regista um event listener.
back():void
[estática] Carrega o último URL do histórico de navegação.
dispatchEvent(event: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
[estática] Retorna o endereco base do documento.
getHistory():Boolean
[estática] Devolve a configuração do histórico.
getParameter(param:String):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 strict.
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:Number):void
[estática] Carrega um URL da lista do histórico.
hasEventListener(type:String):Boolean
[estática] Verifica se existe algum event listener registado para um tipo de evento.
href(url:String, target:String = "_self"):void
[estática] Carrega um novo URL no navegador.
popup(url:String, name:String = "popup", options:String = "", handler:String = ""):void
[estática] Abre uma nova janela do navegador.
removeEventListener(type:String, listener:Function):void
[estática] Remove um event listener.
resetStatus():void
[estática] Elimina o texto de estado da janela do navegador.
setHistory(history:Boolean):void
[estática] Activa ou desactiva a criação de entradas no histórico.
setStatus(status:String):void
[estática] Define o texto do estado da janela do navegador.
setStrict(strict:Boolean):void
[estática] Activa ou desactiva o modo strict.
setTitle(title:String):void
[estática] Define o título do documento HTML.
setTracker(tracker:String):void
[estática] Define uma função para fazer o page view tracking.
setValue(value:String):void
[estática] Define o valor da âncora.

Detalhe das propriedades

onChange

public static var onChange:Function

Chamada quando há uma mudança no endereço.

onInit

public static var onInit:Function

Chamada quando ocorre a inicialização da API.

Detalhe dos métodos

addEventListener

public static function addEventListener(type:String, listener:Function):void

Regista um event listener.

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

back

public static function back():void

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

dispatchEvent

public static function dispatchEvent(event:Event):Boolean

Dispara um evento para todos os event listeners registados.

Parâmetros
event:Event — Objecto de evento.
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

getParameter

public static function getParameter(param:String):String

Devolve o valor de um parâmetro 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 Strict, utilizado para forçar a utilização da barra "/" na formatação da âncora.

Retorna

Boolean

getTitle

public static function getTitle():String

Devolve o título do documento HTML.

Retorna
String

getTracker

public static function getTracker():String

Provides the tracker function.

Devolve
String

getValue

public static function getValue():String

Devolve o valor da âncora.

Retorna
String

go

public static function go(delta:Number):void

Carrega um URL da lista do histórico.

Parâmetros
delta:Number — Um inteiro que representa o índice da posição relativa no histórico.

hasEventListener

public static function hasEventListener(type:String):Boolean

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

Parâmetros
type:String — Tipo de evento.
Retorna
Boolean

href

public static function href(url:String, target:String = "_self"):void

Carrega um novo URL no navegador.

Parâmetros
url:String — Localização do conteúdo a ser aberto.
target:String (default = "_self") — Janela de destino.

popup

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

Abre uma nova janela do navegador.

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

removeEventListener

public static function removeEventListener(type:String, listener:Function):void

Remove um event listener.

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

resetStatus

public static function resetStatus():void

Elimina o texto de estado da janela do navegador.

setHistory

public static function setHistory(history:Boolean):void

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

Parâmetros
history:Boolean —Estado activo ou desactivo .

setStatus

public static function setStatus(status:String):void

Define o texto do estado da janela do navegador.

Parâmetros
status:String — Valor para o novo texto do estado.

setStrict

public static function setStrict(strict:Boolean):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:String):void

Define o título do documento HTML.

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

setTracker

public static function setTracker(tracker:String):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:String):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".

© 2006-2008 Rostislav Hristov, Asual DZZD. Tradução para português por Luis Bello Moraes.