| Package | com.jeffdePascale.fosfr.navigation |
| Class | public class Navigation |
| Inheritance | Navigation  flash.events.EventDispatcher |
Navigation class adds functionality for building full sites with master SWF files and interchangeable content SWF's. It is enabled when implementing the FosfrMainSWF class as the document class for the SWF file, and requires additional files built off of the FosfrShellSWF and FosfrSubSWF classes to implement properly. Navigation also optionally adds functionality for handling SWFAddress events with the SWFAddressHandler class and control over a standardized navigation menu of displayObject's using the GraphicalNavController class.
See also
| Property | Defined by | ||
|---|---|---|---|
| autoShellLoad : Boolean
Boolean value, specifies whether, upon completion of loading of the Fosfr configuration xml file, the FosfrShellSWF file should automatically load in.
| Navigation | ||
| autoSubLoad : Boolean
Boolean value, specifies whether, upon completion of loading of the FosfrShellSWF file, the first FosfrSubSWF file cued for load should automatically load in.
| Navigation | ||
| currentSection : int [read-only]
The numerical value of the subSWF currently loaded in relation to its position in the
NavArray class. | Navigation | ||
| enableGraphicalNav : Boolean
Boolean value, specifies whether to instantiate an instance of the
GraphicalNavController class. | Navigation | ||
| enableSWFAddress : Boolean
Boolean value, specifies whether to instantiate an instance of the
SWFAddressHandler class. | Navigation | ||
| graphicalNavHandler : GraphicalNavController
[read-only]
An instance of the
GraphicalNavController class. | Navigation | ||
| initialSubSWF : uint [read-only]
The numerical value of the subSWF to load from the
NavArray class. | Navigation | ||
| navArray : NavArray
[read-only]
An instance of the
NavArray class. | Navigation | ||
| preloadInitialSubSWFWithShell : Boolean
Boolean value, specifies whether the initial SubSWF file for the site should be preloaded with the shell file.
| Navigation | ||
| shellClipName : String
String value specifying the instance name of the displayObject in the fosfrMainSWF file that the FosfrShellSWF file should be loaded into.
| Navigation | ||
| shellLoader : ShellLoader
[read-only]
An instance of the
ShellLoader class. | Navigation | ||
| shellString : String
String value, specifies the file name of the FosfrShellSWF file to load in, minus the ".swf" file extension.
| Navigation | ||
| skipShellPreload : Boolean
Boolean value, specifies whether the FosfrShellSWF file should be preloaded or just loaded directly.
| Navigation | ||
| subLoader : SubLoader
[read-only]
An instance of the
SubLoader class. | Navigation | ||
| subSWFClipName : String
String value specifying the instance name of the displayObject in the fosfrShellSWF file that the FosfrSubSWF files should be loaded into.
| Navigation | ||
| swfAddressHandler : SWFAddressHandler
[read-only]
An instance of the
SWFAddressHandler class. | Navigation | ||
| Method | Defined by | ||
|---|---|---|---|
|
Navigation(_fosfr:Fosfr, sectionArray:Array)
Creates an instance of the
Navigation class. | Navigation | ||
|
initialize():void
Intializes the
Navigation class and starts the loading process. | Navigation | ||
|
initialSubLoad(deepLink:Array = null, varObj:Object = null, skipPreload:Boolean = false, preloadArray:Array = null):void
| Navigation | ||
| Event | Summary | Defined by | ||
|---|---|---|---|---|
| Dispatched when the FosfrShellSWF has completed loading. | Navigation | |||
| Dispatched when FosfrShellSWF has completed loading. | Navigation | |||
| autoShellLoad | property |
public var autoShellLoad:Boolean
Boolean value, specifies whether, upon completion of loading of the Fosfr configuration xml file, the FosfrShellSWF file should automatically load in. Setting this to false is useful if you wish to add additional files to the ShellSWF preload. call the fosfr.navigation.shellLoader.load() method from the init method of your FosfrMainSWF file and pass the additional files in the preloadArray parameter.
The default value is true.
See also
| autoSubLoad | property |
public var autoSubLoad:Boolean
Boolean value, specifies whether, upon completion of loading of the FosfrShellSWF file, the first FosfrSubSWF file cued for load should automatically load in. The first file is determined by the SWFAddressHandler instance if enableSWFAddress is set to true, otherwise it defaults to loading the first file specified in the NavArray.
The default value is true.
See also
| currentSection | property |
currentSection:int [read-only]
The numerical value of the subSWF currently loaded in relation to its position in the NavArray class. A value of -1 means no section currently is loaded.
The default value is -1.
public function get currentSection():int
| enableGraphicalNav | property |
public var enableGraphicalNav:Boolean
Boolean value, specifies whether to instantiate an instance of the GraphicalNavController class.
The default value is false.
See also
| enableSWFAddress | property |
public var enableSWFAddress:Boolean
Boolean value, specifies whether to instantiate an instance of the SWFAddressHandler class.
The default value is false.
See also
| graphicalNavHandler | property |
graphicalNavHandler:GraphicalNavController [read-only]
An instance of the GraphicalNavController class.
public function get graphicalNavHandler():GraphicalNavController
See also
| initialSubSWF | property |
initialSubSWF:uint [read-only]
The numerical value of the subSWF to load from the NavArray class.
The default value is 0.
public function get initialSubSWF():uint
| navArray | property |
navArray:NavArray [read-only]
An instance of the NavArray class.
public function get navArray():NavArray
See also
| preloadInitialSubSWFWithShell | property |
public var preloadInitialSubSWFWithShell:Boolean
Boolean value, specifies whether the initial SubSWF file for the site should be preloaded with the shell file. If set to true, the skipPreload parameter of the subLoader.load() method for the first section is set to false.
The default value is true.
See also
| shellClipName | property |
public var shellClipName:StringString value specifying the instance name of the displayObject in the fosfrMainSWF file that the FosfrShellSWF file should be loaded into.
The default value is shellHolder_mc.
| shellLoader | property |
shellLoader:ShellLoader [read-only]
An instance of the ShellLoader class.
public function get shellLoader():ShellLoader
See also
| shellString | property |
public var shellString:StringString value, specifies the file name of the FosfrShellSWF file to load in, minus the ".swf" file extension.
The default value is shell.
| skipShellPreload | property |
public var skipShellPreload:BooleanBoolean value, specifies whether the FosfrShellSWF file should be preloaded or just loaded directly.
The default value is false.
| subLoader | property |
subLoader:SubLoader [read-only]
An instance of the SubLoader class.
public function get subLoader():SubLoader
See also
| subSWFClipName | property |
public var subSWFClipName:StringString value specifying the instance name of the displayObject in the fosfrShellSWF file that the FosfrSubSWF files should be loaded into.
The default value is subSWFHolder_mc.
| swfAddressHandler | property |
swfAddressHandler:SWFAddressHandler [read-only]
An instance of the SWFAddressHandler class.
public function get swfAddressHandler():SWFAddressHandler
See also
| Navigation | () | constructor |
public function Navigation(_fosfr:Fosfr, sectionArray:Array)
Creates an instance of the Navigation class.
_fosfr:Fosfr — an instance of the Fosfr class.
|
|
sectionArray:Array — an array of files to be passed to the instance of the NavArray class, specified as subSWF files by the configuration xml file for the Fosfr project. This array must be generated using the XMLListToArray.convert() method in the utils folder.
|
See also
| initialize | () | method |
public function initialize():void
Intializes the Navigation class and starts the loading process.
| initialSubLoad | () | method |
public function initialSubLoad(deepLink:Array = null, varObj:Object = null, skipPreload:Boolean = false, preloadArray:Array = null):voidParameters
deepLink:Array (default = null) |
|
varObj:Object (default = null) |
|
skipPreload:Boolean (default = false) |
|
preloadArray:Array (default = null) |
| shellLoaded | event |
com.jeffdePascale.fosfr.navigation.NavigationEvent
com.jeffdePascale.fosfr.navigation.NavigationEvent.SHELL_LOADED
Dispatched when the FosfrShellSWF has completed loading.
The NavigationEvent.SHELL_LOADED constant defines the value of the type property of the event object for a shellLoaded event.
The properties of the event object have the following values:
| Property | Value |
|---|---|
type | "complete" |
bubbles | A Boolean value. |
cancelable | A Boolean value. |
| subSWFLoaded | event |
com.jeffdePascale.fosfr.navigation.NavigationEvent
com.jeffdePascale.fosfr.navigation.NavigationEvent.SUB_SWF_LOADED
Dispatched when FosfrShellSWF has completed loading.
The NavigationEvent.SUB_SWF_LOADED constant defines the value of the type property of the event object for a subSWFLoaded event.
The properties of the event object have the following values:
| Property | Value |
|---|---|
type | "complete" |
bubbles | A Boolean value. |
cancelable | A Boolean value. |