Class SWFAddress

SWFAddress is distributed as a top level class. Projects that utilize code packages should use it with the com.asual.swfaddress package.

Public Properties

onChange:Function
[static] Change event.
onExternalChange:Function
[static] External change event.
onInit:Function
[static] Init event.
onInternalChange:Function
[static] Internal change event.

Public Methods

addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
[static] Registers an event listener.
back():void
[static] Loads the previous URL in the history list.
dispatchEvent(event:Event):Boolean
[static] Dispatches an event to all the registered listeners.
forward():void
[static] Loads the next URL in the history list.
up():void
[static] Navigates one level up in the deep linking path.
getBaseURL():String
[static] Provides the base address of the document.
getHistory():Boolean
[static] Provides the state of the history setting.
getParameter(param:String):Object
[static] Provides the value of a specific query parameter as a string or array of strings.
getParameterNames():Array
[static] Provides a list of all the query parameter names.
getPath():String
[static] Provides the deep linking value without the query string.
getPathNames():Array
[static] Provides a list of all the folders in the deep linking path.
getQueryString():String
[static] Provides the query string part of the deep linking value.
getStatus():String
[static] Provides the status of the browser window.
getStrict():Boolean
[static] Provides the state of the strict mode setting.
getTitle():String
[static] Provides the title of the HTML document.
getTracker():String
[static] Provides the tracker function.
getValue():String
[static] Provides the current deep linking value.
go(delta:Number):void
[static] Loads a URL from the history list.
hasEventListener(type:String):Boolean
[static] Checks the existance of any listeners registered for a specific type of event.
href(url:String, target:String = "_self"):void
[static] Opens a new URL in the browser.
popup(url:String, name:String = "popup", options:String = "", handler:String = ""):void
[static] Opens a browser popup window.
removeEventListener(type:String, listener:Function):void
[static] Removes an event listener.
resetStatus():void
[static] Resets the status of the browser window.
setHistory(history:Boolean):void
[static] Enables or disables the creation of history entries.
setStatus(status:String):void
[static] Sets the status of the browser window.
setStrict(strict:Boolean):void
[static] Enables or disables the strict mode.
setTitle(title:String):void
[static] Sets the title of the HTML document.
setTracker(tracker:String):void
[static] Sets a function for page view tracking.
setValue(value:String):void
[static] Sets the current deep linking value.

Property detail

onChange

public static var onChange:Function

Change event.

onExternalChange

public static var onExternalChange:Function

External change event.

onInit

public static var onInit:Function

Init event.

onInternalChange

public static var onInternalChange:Function

Internal change event.

Method detail

addEventListener

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

Registers an event listener.

Parameters
type:String — Event type.
listener:Function — Event listener.
useCapture:Boolean — Determines whether the listener works in the capture phase or the target and bubbling phases.
priority:int — The priority level of the event listener.
useWeakReference:Boolean — Determines whether the reference to the listener is strong or weak.

back

public static function back():void

Loads the previous URL in the history list.

dispatchEvent

public static function dispatchEvent(event:Event):Boolean

Dispatches an event to all the registered listeners.

Parameters
event:Event — Event object.
Returns
Boolean

forward

public static function forward():void

Loads the next URL in the history list.

getBaseURL

public static function getBaseURL():String

Provides the base address of the document.

Returns
String

getHistory

public static function getHistory():Boolean

Provides the state of the history setting.

Returns
Boolean

getParameter

public static function getParameter(param:String):Object

Provides the value of a specific query parameter as a string or array of strings.

Parameters
param:String — Parameter name.
Returns
String

getParameterNames

public static function getParameterNames():Array

Provides a list of all the query parameter names.

Returns
Array

getPath

public static function getPath():String

Provides the deep linking value without the query string.

Returns
String

getPathNames

public static function getPathNames():Array

Provides a list of all the folders in the deep linking path.

Returns
Array

getQueryString

public static function getQueryString():String

Provides the query string part of the deep linking value.

Returns
String

getStatus

public static function getStatus():String

Provides the status of the browser window.

Returns
String

getStrict

public static function getStrict():Boolean

Provides the state of the strict mode setting.

Returns
Boolean

getTitle

public static function getTitle():String

Provides the title of the HTML document.

Returns
String

getTracker

public static function getTracker():String

Provides the tracker function.

Returns
String

getValue

public static function getValue():String

Provides the current deep linking value.

Returns
String

go

public static function go(delta:Number):void

Loads a URL from the history list.

Parameters
delta:Number — An integer representing a relative position in the history list.

hasEventListener

public static function hasEventListener(type:String):Boolean

Checks the existance of any listeners registered for a specific type of event.

Parameters
type:String — Event type.
Returns
Boolean

href

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

Opens a new URL in the browser.

Parameters
url:String — The resource to be opened.
target:String (default = "_self") — Target window.

popup

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

Opens a browser popup window.

Parameters
url:String — Resource location.
name:String (default = "popup") — Name of the popup window.
options:String (default = "") — Options which get evaluted and passed to the window.open() method.
handler:String (default = "") — Optional JavsScript handler code for popup handling.

removeEventListener

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

Removes an event listener.

Parameters
type:String — Event type.
listener:Function — Event listener.

resetStatus

public static function resetStatus():void

Resets the status of the browser window.

setHistory

public static function setHistory(history:Boolean):void

Enables or disables the creation of history entries.

Parameters
history:Boolean — history History state.

setStatus

public static function setStatus(status:String):void

Sets the status of the browser window.

Parameters
status:String — Status value.

setStrict

public static function setStrict(strict:Boolean):void

Enables or disables the strict mode.

Parameters
strict:Boolean — strict Strict mode state.

setTitle

public static function setTitle(title:String):void

Sets the title of the HTML document.

Parameters
title:String — Title value.

setTracker

public static function setTracker(tracker:String):void

Sets a function for page view tracking. By default both 'urchinTracker' and 'pageTracker._trackPageview' are automatically invoked.

Parameters
tracker:String — Tracker function.

setValue

public static function setValue(value:String):void

Sets the current deep linking value.

Parameters
value:String — A value which will be appended to the base link of the HTML document.

© 2006-2009 Rostislav Hristov, Asual DZZD