Packagewidgetfactory.helpers.runtime
Classpublic class RuntimeData
InheritanceRuntimeData Inheritance Object
Implements IRuntimeData

Holds information about the widget that the WidgetManager needs to detect runtime changes.

See also

WidgetManager

Public Properties
 PropertyDefined By
  endFrame : int
The number frame of the slide that the widget's runtime duration ends on.
RuntimeData
  getIsInRuntime : Function
A function on the widget that returns if it is in runtime or not.
RuntimeData
  isDisplayedForRestOfProject : Boolean
Indicates whether the widget was set by the Captivate Author to display for the rest of the project.
RuntimeData
  name : String
The item name of the widget.
RuntimeData
  runtimeMethod : Function
The method that the WidgetManager will call to notify the widget of a runtime change.
RuntimeData
  slideNumber : int
The number of the slide that the Captivate Author placed the widget on.
RuntimeData
  startFrame : int
The number frame of the slide that the widget's runtime duration begins on.
RuntimeData
  widgetSlide : MovieClip
A reference to the widget's home slide.
RuntimeData
Public Methods
 MethodDefined By
  
initializeFromObject(obj:Object):void
Takes an untyped RuntimeData object, extracts its data, and applies it to the properties of this object.
RuntimeData
Property Detail
endFrameproperty
endFrame:int

The number frame of the slide that the widget's runtime duration ends on.


Implementation
    public function get endFrame():int
    public function set endFrame(value:int):void
getIsInRuntimeproperty 
getIsInRuntime:Function

A function on the widget that returns if it is in runtime or not. If the function returns true, the WidgetManager will take it that the widget is in runtime. If the function returns false, the WidgetManager will take it that the widget is not in runtime.


Implementation
    public function get getIsInRuntime():Function
    public function set getIsInRuntime(value:Function):void
isDisplayedForRestOfProjectproperty 
isDisplayedForRestOfProject:Boolean

Indicates whether the widget was set by the Captivate Author to display for the rest of the project.


Implementation
    public function get isDisplayedForRestOfProject():Boolean
    public function set isDisplayedForRestOfProject(value:Boolean):void
nameproperty 
name:String

The item name of the widget.


Implementation
    public function get name():String
    public function set name(value:String):void
runtimeMethodproperty 
runtimeMethod:Function

The method that the WidgetManager will call to notify the widget of a runtime change. That method must receive a Boolean value. True will indicate that the widget is in runtime. False will indicate that it has exited runtime


Implementation
    public function get runtimeMethod():Function
    public function set runtimeMethod(value:Function):void
slideNumberproperty 
slideNumber:int

The number of the slide that the Captivate Author placed the widget on. (zero based)


Implementation
    public function get slideNumber():int
    public function set slideNumber(value:int):void
startFrameproperty 
startFrame:int

The number frame of the slide that the widget's runtime duration begins on.


Implementation
    public function get startFrame():int
    public function set startFrame(value:int):void
widgetSlideproperty 
widgetSlide:MovieClip

A reference to the widget's home slide.


Implementation
    public function get widgetSlide():MovieClip
    public function set widgetSlide(value:MovieClip):void
Method Detail
initializeFromObject()method
public function initializeFromObject(obj:Object):void

Takes an untyped RuntimeData object, extracts its data, and applies it to the properties of this object. Used when dealing with situations where classes can not be shared across widget instances.

Parameters

obj:Object — The untyped RuntimeData object through which the information will be extracted.





Thu Oct 27 2011, 12:14 PM +08:00