IPresentationLoader

PropertiesMethodsEvents
Packageispring.presenter.player
Interfacepublic interface IPresentationLoader extends flash.events.IEventDispatcher

Language Version : ActionScript 3.0
Product Versions : iSpring Pro 6.0.3, iSpring Platform 6.0
Runtime Versions : AIR 1.0, Flash Player 10.1

The IPresentationLoader interface provides information about the presentation loading progress and the state of the presentation slides.

The IPresentationLoader interface can be obtained via the presentationLoader property of the IPresentationPlayer interface.

See also

ispring.presenter.IPresentationPlayer
ispring.presenter.player.SlideState
ispring.presenter.player.events.PresentationLoaderEvent

Public Properties
PropertyDefined By
presentationLoadingProgress : Number
[read-only] The presentation loading progress in the range 0...1.
IPresentationLoader
slidesCount : uint
[read-only] The total number of slides in the presentation.
IPresentationLoader
Public Methods
MethodDefined By
 
getSlideLoadingProgress(index:uint):Number
Returns the loading progress of the specified slide.
IPresentationLoader
 
getSlideState(index:uint):String
Returns the state of the specified slide.
IPresentationLoader
Events
Event Summary Defined By
 
slideLoaded
Dispatched when a slide of the presentation is loaded.IPresentationLoader
 
slideLoadingProgress
Dispatched when a slide loading progress is updated.IPresentationLoader
Property Detail
presentationLoadingProgressproperty
presentationLoadingProgress:Number  [read-only]

Language Version : ActionScript 3.0
Product Versions : iSpring Pro 6.0.3, iSpring Platform 6.0
Runtime Versions : AIR 1.0, Flash Player 10.1

The presentation loading progress in the range 0...1.


Implementation
    public function get presentationLoadingProgress():Number
slidesCountproperty 
slidesCount:uint  [read-only]

Language Version : ActionScript 3.0
Product Versions : iSpring Pro 6.0.3, iSpring Platform 6.0
Runtime Versions : AIR 1.0, Flash Player 10.1

The total number of slides in the presentation.


Implementation
    public function get slidesCount():uint
Method Detail
getSlideLoadingProgress()method
public function getSlideLoadingProgress(index:uint):Number

Language Version : ActionScript 3.0
Product Versions : iSpring Pro 6.0.3, iSpring Platform 6.0
Runtime Versions : AIR 1.0, Flash Player 10.1

Returns the loading progress of the specified slide.

Parameters

index:uint — The index of the slide within the presentation.

Returns
Number — The loading progress of the specified slide in the range 0...1.

Throws
RangeError — Throws if the specified slide index is out of range.
getSlideState()method 
public function getSlideState(index:uint):String

Language Version : ActionScript 3.0
Product Versions : iSpring Pro 6.0.3, iSpring Platform 6.0
Runtime Versions : AIR 1.0, Flash Player 10.1

Returns the state of the specified slide. See the ispring.presenter.player.SlideState constants for more details.

Parameters

index:uint — The index of the slide within the presentation.

Returns
String — The state of the specified slide.

Throws
RangeError — Throws if the specified slide index is out of range.

See also

ispring.presenter.player.SlideState
Event Detail
slideLoaded Event
Event Object Type: ispring.presenter.player.events.PresentationLoaderEvent
PresentationLoaderEvent.type property = ispring.presenter.player.events.PresentationLoaderEvent.SLIDE_LOADED

Language Version : ActionScript 3.0
Product Versions : iSpring Pro 6.0.3, iSpring Platform 6.0
Runtime Versions : AIR 1.0, Flash Player 10.1

Dispatched when a slide of the presentation is loaded.

The PresentationLoaderEvent.SLIDE_LOADED constant defines the value of the type property of the event object for a slideLoaded event.

The properties of the event object have the following values:

PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe Object that defines the event listener that handles the event. For example, if you use myButton.addEventListener() to register an event listener, myButton is the value of the currentTarget.
indexThe index of the loaded slide.
targetThe Object that dispatched the event; it is not always the Object listening for the event. Use the currentTarget property to always access the Object listening for the event.
slideLoadingProgress Event  
Event Object Type: ispring.presenter.player.events.PresentationLoaderEvent
PresentationLoaderEvent.type property = ispring.presenter.player.events.PresentationLoaderEvent.PROGRESS

Language Version : ActionScript 3.0
Product Versions : iSpring Pro 6.0.3, iSpring Platform 6.0
Runtime Versions : AIR 1.0, Flash Player 10.1

Dispatched when a slide loading progress is updated.

The PresentationLoaderEvent.PROGRESS constant defines the value of the type property of the event object for a slideLoadingProgress event.

The properties of the event object have the following values:

PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe Object that defines the event listener that handles the event. For example, if you use myButton.addEventListener() to register an event listener, myButton is the value of the currentTarget.
indexThe index of the slide which loading progress has been updated.
targetThe Object that dispatched the event; it is not always the Object listening for the event. Use the currentTarget property to always access the Object listening for the event.




Tue Dec 4 2012, 06:27 PM +04:00