Packagecom.jeffdePascale.fosfr.navigation
Classpublic dynamic class NavArray

The NavArray class handles control of the list of subSWF files for the Navigation class.

See also

com.jeffdePascale.fosfr.navigation.Navigation

Public Properties
 PropertyDefined by
  isEmpty : Boolean
[read-only]
NavArray
Public Methods
 MethodDefined by
  
NavArray(_fosfr:Fosfr, _sectionArray:Array)
Creates an instance of the NavArray class.
NavArray
  
getSectionID(target:String, forcedFullPageName:String = null):uint
Returns the id value of the SubSWF file matching the string passed to the method.
NavArray
  
subSWFName(id:int, fullName:Boolean = false):String
Returns the string value of the SubSWF name in the position in the NavArray specified in the id parameter.
NavArray
Property detail
isEmptyproperty
isEmpty:Boolean  [read-only]Implementation
    public function get isEmpty():Boolean
Constructor detail
NavArray()constructor
public function NavArray(_fosfr:Fosfr, _sectionArray:Array)

Creates an instance of the NavArray class.

Parameters
_fosfr:Fosfr — An instance of the Fosfr class
 
_sectionArray:Array — An array generated from the configuration xml file of the Fosfr class. Array must be generated via the XMLListToArray.convert() method in the fosfr.utils branch.

See also

com.jeffdePascale.fosfr.Fosfr
Method detail
getSectionID()method
public function getSectionID(target:String, forcedFullPageName:String = null):uint

Returns the id value of the SubSWF file matching the string passed to the method. If the string is not found, a new entry is added to the array.

Parameters
target:String — the string value of the file, minus the ".swf" file extension, to cross reference to the array of SubSWF files.
 
forcedFullPageName:String (default = null) — Optional, overrides the stringName value of the SubSWF file referenced in the array of SubSWF files. The stringName is referenced by the SWFAddressHandler class to display a value in the title bar of the webpage for the SubSWF.

Returns
uint — The id value of the target string in relation to the array of SubSWF files.

See also

com.jeffdePascale.fosfr.navigation.swfAddress.SWFAddressHandler
subSWFName()method 
public function subSWFName(id:int, fullName:Boolean = false):String

Returns the string value of the SubSWF name in the position in the NavArray specified in the id parameter.

Parameters
id:int — the array position to cross reference.
 
fullName:Boolean (default = false) — optional boolean, of whether to pass back the string value or the full name as specified on the stringName attribute of the SubSWF in the configuration xml file.

Returns
String — The string value of the related SubSWF file. If the id position is invalid, returns null.