Packagecom.jeffdePascale.fosfr.navigation.swfAddress
Classpublic class SWFAddressHandler
InheritanceSWFAddressHandler Inheritance flash.events.EventDispatcher

Ties SWFAddress functionality to the Navigation class of the Fosfr framework. SWFAddress is written and distributed by asual.com.


Public Properties
 PropertyDefined by
  enabled : Boolean
Specifies whether SWFAddressHandler dispatches and accepts changes to the SWFAddress object.
SWFAddressHandler
  showProjectInTitle : Boolean
Specifies whether to show the project title, specified in the configuration xml file, in the title bar.
SWFAddressHandler
  showSectionNameInTitle : Boolean
Specifies whether to show the SubSWF stringName specified in the configuration xml file (or through the forcedFullPageName paramter of loadSubSWF) in the title bar.
SWFAddressHandler
Public Methods
 MethodDefined by
  
SWFAddressHandler(_fosfr:Fosfr, _enabled:Boolean = true)
Creates an instance of the SWFAddressHandler class.
SWFAddressHandler
  
initialize():void
Starts functionality of the SWFAddressHandler instance.
SWFAddressHandler
  
setAddress(addressArray:Array = null, forceSubSWFName:String = null):void
Specifies a subPage value to add to the address bar.
SWFAddressHandler
  
updatePageTitle(str:String = null):void
Forces an update to the title bar.
SWFAddressHandler
Events
 EventSummaryDefined by
  
complete
Dispatched when SWFAddess reports a change to the url.SWFAddressHandler
  
subLink
Dispatched when SWFAddess reports a change to the url with more than one "/" present in the string.SWFAddressHandler
Property detail
enabledproperty
public var enabled:Boolean

Specifies whether SWFAddressHandler dispatches and accepts changes to the SWFAddress object.

The default value is true.

showProjectInTitleproperty 
public var showProjectInTitle:Boolean

Specifies whether to show the project title, specified in the configuration xml file, in the title bar.

showSectionNameInTitleproperty 
public var showSectionNameInTitle:Boolean

Specifies whether to show the SubSWF stringName specified in the configuration xml file (or through the forcedFullPageName paramter of loadSubSWF) in the title bar.

The default value is false.

See also

com.jeffdePascale.fosfr.FosfrSWFPrototype.loadSubSWF
Constructor detail
SWFAddressHandler()constructor
public function SWFAddressHandler(_fosfr:Fosfr, _enabled:Boolean = true)

Creates an instance of the SWFAddressHandler class.

Parameters
_fosfr:Fosfr — An instance of the Fosfr class.
 
_enabled:Boolean (default = true) — Optional, specifes the enabled state of SWFAddresHandler.

See also

enabled
com.jeffdePascale.fosfr.core.Fosfr
Method detail
initialize()method
public function initialize():void

Starts functionality of the SWFAddressHandler instance.

setAddress()method 
public function setAddress(addressArray:Array = null, forceSubSWFName:String = null):void

Specifies a subPage value to add to the address bar. This is automatically invoked by the Navigation class when subLinks are detected or dispatched. Values are added in slash syntax after the section name.

Parameters
addressArray:Array (default = null) — The subPage value.
 
forceSubSWFName:String (default = null)
updatePageTitle()method 
public function updatePageTitle(str:String = null):void

Forces an update to the title bar. If showSectionNameInTitle is false, no changes will register. Otherwise, the title bar will Show the project name followed by the string value specified. If the value of str is null, the SubSWF full name value from the NAvArray class will be inserted.

Parameters
str:String (default = null) — Optional, the string value to pass to the title bar.

See also

com.jeffdePascale.fosfr.navigation.NavArray
Event detail
completeevent 
Event object type: com.jeffdePascale.fosfr.navigation.swfAddress.SWFAddressHandlerEvent
SWFAddressHandlerEvent.type property = com.jeffdePascale.fosfr.navigation.swfAddress.SWFAddressHandlerEvent.CHANGE

Dispatched when SWFAddess reports a change to the url.

subLinkevent  
Event object type: com.jeffdePascale.fosfr.navigation.swfAddress.SWFAddressHandlerEvent
SWFAddressHandlerEvent.type property = com.jeffdePascale.fosfr.navigation.swfAddress.SWFAddressHandlerEvent.SUB_LINK

Dispatched when SWFAddess reports a change to the url with more than one "/" present in the string.

The SWFAddressHandlerEvent.SUB_LINK constant defines the value of the type property of the event object for a subLink event.

The properties of the event object have the following values:

Property Value
type "complete"
bubbles A Boolean value.
cancelable A Boolean value.
address A string value of the subLink address passed from the SWFAddressHandler class.