| Package | com.jeffdePascale.fosfr.navigation.graphicalNav |
| Class | public class GraphicalNavController |
| Inheritance | GraphicalNavController  flash.events.EventDispatcher |
| Property | Defined by | ||
|---|---|---|---|
| changeType : NavChangePrototype
[read-only]
A reference to the class method of the instantiated changeType for GraphicalNavController.
| GraphicalNavController | ||
| enabled : Boolean
Boolean value, specifies whether the graphicalNav will react to and set visual changes to the navigation.
| GraphicalNavController | ||
| navHolderName : String
A string value specifying either the name of the DisplayObject in the shellSWF containing the navigation elements.
| GraphicalNavController | ||
| navNamingConvention : String
Specifies the naming convention for navigation items.
| GraphicalNavController | ||
| numberList : String
An optional string value specifying a comma delimited list of integer values correlating to the desired nav elements to activate as graphicalNav buttons, as opposed ot using tghe navigation.navArray instance as a source.
| GraphicalNavController | ||
| Method | Defined by | ||
|---|---|---|---|
|
GraphicalNavController(_fosfr:Fosfr, _enabled:Boolean = true)
Creates an instance of the GraphicalNavController class.
| GraphicalNavController | ||
|
initialize(changeType:String, args:Array = null):void
| GraphicalNavController | ||
|
reDrawNavState():void
| GraphicalNavController | ||
|
reset():void
| GraphicalNavController | ||
|
setActive(id:int):void
| GraphicalNavController | ||
|
setNav():void
| GraphicalNavController | ||
| changeType | property |
changeType:NavChangePrototype [read-only]A reference to the class method of the instantiated changeType for GraphicalNavController.
Implementation public function get changeType():NavChangePrototype
| enabled | property |
public var enabled:BooleanBoolean value, specifies whether the graphicalNav will react to and set visual changes to the navigation.
The default value is true.
| navHolderName | property |
public var navHolderName:StringA string value specifying either the name of the DisplayObject in the shellSWF containing the navigation elements. If the DisplayObjet is nested within more than one instance, place a public variable in shell that maps to the instance, and assign the name of that variable to this property.
The default value is "nav_mc".
| navNamingConvention | property |
public var navNamingConvention:StringSpecifies the naming convention for navigation items. For example, if your navigation buttons were named nav0_mc, nav1_mc, etc, the value of this property would be "nav". Assumes all buttn names end in "_mc".
The default value is "nav".
| numberList | property |
public var numberList:StringAn optional string value specifying a comma delimited list of integer values correlating to the desired nav elements to activate as graphicalNav buttons, as opposed ot using tghe navigation.navArray instance as a source.
The default value is null.
| GraphicalNavController | () | constructor |
public function GraphicalNavController(_fosfr:Fosfr, _enabled:Boolean = true)Creates an instance of the GraphicalNavController class.
Parameters_fosfr:Fosfr — An instance of the Fosfr framework.
|
|
_enabled:Boolean (default = true) |
| initialize | () | method |
public function initialize(changeType:String, args:Array = null):voidParameters
changeType:String |
|
args:Array (default = null) |
| reDrawNavState | () | method |
public function reDrawNavState():void
| reset | () | method |
public function reset():void
| setActive | () | method |
public function setActive(id:int):voidParameters
id:int |
| setNav | () | method |
public function setNav():void