Packagewidgetfactory.helpers.runtime
Classpublic class WidgetManager
InheritanceWidgetManager Inheritance Object
Implements IWidgetManager

Manages the runtime state of all WidgetFactory widgets in the Captivate Movie.



Public Methods
 MethodDefined By
  
WidgetManager(captivateMainTimeline:MovieClip)
Creates an instance of the WidgetManager class.
WidgetManager
  
Enacts checkWidgetsOnSlide() for the slide currently playing back in the movie.
WidgetManager
  
checkWidgetsOnSlide(slideNumber:int):void
Forces the WidgetManager to check if any widgets on a certain slide are now active at runtime.
WidgetManager
  
deRegister(widgetName:String, slideNumber:int):void
Stops the WidgetManager notifying passed in widget of runtime changes.
WidgetManager
  
getInstance(captivateMainTimeline:MovieClip):Object
[static] Retrieves the only instance of the WidgetManager class.
WidgetManager
  
register(untypedRuntimeData:Object):void
Signs up a widget with the WidgetManager to be notified when its runtime state changes.
WidgetManager
  
replaceFrameScriptOn(slide:MovieClip, frame:int):void
When an object is de-registered then its framescript needs to be removed so as not to cause an error.
WidgetManager
Constructor Detail
WidgetManager()Constructor
public function WidgetManager(captivateMainTimeline:MovieClip)

Creates an instance of the WidgetManager class.

Parameters
captivateMainTimeline:MovieClip
Method Detail
checkCurrentSlide()method
public function checkCurrentSlide():void

Enacts checkWidgetsOnSlide() for the slide currently playing back in the movie.

checkWidgetsOnSlide()method 
public function checkWidgetsOnSlide(slideNumber:int):void

Forces the WidgetManager to check if any widgets on a certain slide are now active at runtime.

Parameters

slideNumber:int — The number of the slide to check. (zero based)

deRegister()method 
public function deRegister(widgetName:String, slideNumber:int):void

Stops the WidgetManager notifying passed in widget of runtime changes.

Parameters

widgetName:String — The ItemName for the widget.
 
slideNumber:int — The number of the slide that the widget is placed on. (zero based)

getInstance()method 
public static function getInstance(captivateMainTimeline:MovieClip):Object

Retrieves the only instance of the WidgetManager class.

Parameters

captivateMainTimeline:MovieClip

Returns
Object — The only instance of the WidgetManager class.
register()method 
public function register(untypedRuntimeData:Object):void

Signs up a widget with the WidgetManager to be notified when its runtime state changes.

Parameters

untypedRuntimeData:Object — The object that holds the specific RuntimeData for the widget.

replaceFrameScriptOn()method 
public function replaceFrameScriptOn(slide:MovieClip, frame:int):void

When an object is de-registered then its framescript needs to be removed so as not to cause an error. However, it's possible that another object that has the same start frame or end frame. So we must replace it with this function which will check all the widgets on the slide for runtime (and won't cause an error).

Parameters

slide:MovieClip
 
frame:int