| Package | cpgears.movie |
| Interface | public interface IMovie extends flash.events.IEventDispatcher |
| Property | Defined By | ||
|---|---|---|---|
| captivateVersion : Version [read-only]
The version number for Captivate
| IMovie | ||
| contentHeight : Number [read-only]
The height of the Captivate movie excluding the playbar and TOC if applicable. | IMovie | ||
| contentLeft : Number [read-only]
The top left corner X position of the Captivate movie. | IMovie | ||
| contentTop : Number [read-only]
The top left corner Y position of the Captivate movie. | IMovie | ||
| contentWidth : Number [read-only]
The width of the Captivate movie excluding the playbar and TOC if applicable. | IMovie | ||
| controls : IMovieControls [read-only]
Returns the movie controls. | IMovie | ||
| handle : MovieClip [read-only]
Returns the presentation main movie (CaptivateMainTimeline). | IMovie | ||
| metadata : MetaData [read-only]
Returns the metadata associated to the movie. | IMovie | ||
| slide : ISlide [read-only]
The slide containing the widget. | IMovie | ||
| systemData : SystemData [read-only]
Returns information about the user's system. | IMovie | ||
| widget : IWidget [read-only]
Information about the widget in the Captivate context. | IMovie | ||
| Method | Defined By | ||
|---|---|---|---|
getCpVariable(variableName:String):*
Returns the value of a Captivate variable. | IMovie | ||
gotoSlide(SlideNumber:Number):void
Causes the movie to jump to the specified slide. | IMovie | ||
hasPlaybar():Boolean
Returns if the movie has a playbar. | IMovie | ||
isPreview():Boolean
Determines if the movie is in preview mode inside Captivate. | IMovie | ||
monitorVariable(variableName:String):void
Monitors a movie variable for changes. | IMovie | ||
replaceVariables(text:String):String
In a text, replaces all instances of a Captivate variable by their associated values. | IMovie | ||
setCpVariable(variableName:String, value:*):void
Sets the value of a specific Captivate variable. | IMovie | ||
| captivateVersion | property |
captivateVersion:Version [read-only] The version number for Captivate
public function get captivateVersion():Version| contentHeight | property |
contentHeight:Number [read-only] The height of the Captivate movie excluding the playbar and TOC if applicable.
public function get contentHeight():Number| contentLeft | property |
contentLeft:Number [read-only] The top left corner X position of the Captivate movie.
public function get contentLeft():Number| contentTop | property |
contentTop:Number [read-only] The top left corner Y position of the Captivate movie.
public function get contentTop():Number| contentWidth | property |
contentWidth:Number [read-only] The width of the Captivate movie excluding the playbar and TOC if applicable.
public function get contentWidth():Number| controls | property |
controls:IMovieControls [read-only] Returns the movie controls.
public function get controls():IMovieControls| handle | property |
handle:MovieClip [read-only] Returns the presentation main movie (CaptivateMainTimeline).
public function get handle():MovieClip| metadata | property |
metadata:MetaData [read-only] Returns the metadata associated to the movie.
public function get metadata():MetaData| slide | property |
slide:ISlide [read-only] The slide containing the widget.
public function get slide():ISlide| systemData | property |
systemData:SystemData [read-only] Returns information about the user's system.
public function get systemData():SystemData| widget | property |
widget:IWidget [read-only] Information about the widget in the Captivate context.
public function get widget():IWidget| getCpVariable | () | method |
public function getCpVariable(variableName:String):*Returns the value of a Captivate variable.
Parameters
variableName:String — The name of the Captivate variable to retrieve.
|
* — The value of the variable, null otherwise.
|
| gotoSlide | () | method |
public function gotoSlide(SlideNumber:Number):voidCauses the movie to jump to the specified slide.
The slide number are zero based meaning that the first slide is slide 0.
Parameters
SlideNumber:Number — The slide number to jump to.
|
| hasPlaybar | () | method |
public function hasPlaybar():BooleanReturns if the movie has a playbar.
ReturnsBoolean — true if the movie has a playbar, false otherwise.
|
| isPreview | () | method |
public function isPreview():BooleanDetermines if the movie is in preview mode inside Captivate.
ReturnsBoolean — true if in preview mode, false otherwise.
|
| monitorVariable | () | method |
public function monitorVariable(variableName:String):voidMonitors a movie variable for changes.
Parameters
variableName:String — The name of the variable to monitor.
|
| replaceVariables | () | method |
public function replaceVariables(text:String):StringIn a text, replaces all instances of a Captivate variable by their associated values.
Scans a text and replaces all occurences of a Captivate variable (enclosed in %%) by its associated value. E.g. The string 'Captivate version: %%CaptivateVersion%%.' would become: 'Captivate version: 5.0.0.'
Parameters
text:String — The text to convert which contains the Captivate variables.
|
String — The text where all Captivable variables have been replaced by their values.
|
| setCpVariable | () | method |
public function setCpVariable(variableName:String, value:*):voidSets the value of a specific Captivate variable.
Parameters
variableName:String — The name of the Captivate variable to set.
| |
value:* — The value of the variable.
|