Packageispring.presenter.player
Interfacepublic interface IPresentationView 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 IPresentationView interface represents the presentation view providing access to the related presentation control interfaces.

The IPresentationView interface of the presentation can be obtained using the presentationView property of the IPresentationPlayer interface.

The IPresentationView2 interface providing additional functionality has become available since iSpring Pro 6.2 and iSpring Platform 6.2.

See also

ispring.presenter.IPresentationPlayer
ispring.presenter.player.IPresentationView2


Public Properties
PropertyDefined By
backdropAlpha : Number
Defines the alpha transparency value of the the unoccupied area of the presentation view.
IPresentationView
backdropColor : uint
Defines the color (0xRRGGBB) that fills the unoccupied area of the presentation view.
IPresentationView
core : IPresentationPlaybackCore
[read-only] Returns the IPresentationPlaybackCore interface providing access to the low-level components of the presentation player.
IPresentationView
displayObject : DisplayObject
[read-only] The flash.display.DisplayObject object visualizing the presentation slides.
IPresentationView
fullScreenManager : IFullScreenManager
[read-only] Returns the IFullScreenManager interface that allows switching the player between normal and full screen modes.
IPresentationView
keyboardController : IKeyboardController
[read-only] Returns the IKeyboardController interface which controls the presentation navigation using keyboard.
IPresentationView
playbackController : IPresentationPlaybackController
[read-only] Returns the IPresentationPlaybackController interface providing unrestricted presentation playback control facilities.
IPresentationView
presentationSlideExtent : Rectangle
[read-only] The extent of the presentation slide within the presentation view.
IPresentationView
restrictedPlaybackController : IPresentationPlaybackController
[read-only] Returns the IPresentationPlaybackController interface providing restricted presentation playback control facilities.
IPresentationView
soundController : ISoundController
[read-only] Returns the ISoundController interface allowing sound volume control.
IPresentationView
videoNarrationPlayer : IVideoNarrationPlayer
[read-only] Returns the IVideoNarrationPlayer interface representing the video narration player.
IPresentationView
Public Methods
MethodDefined By
 
resize(width:Number, height:Number):void
Resizes the presentation view display object.
IPresentationView
Events
Event Summary Defined By
 Dispatched to notify a listener to execute a meta command.IPresentationView
 Dispatched to notify the skin to hide the previously shown tooltip.IPresentationView
 Dispatched to notify listeners that a slide web object is to be hidden.IPresentationView
 Dispatched to notify the skin to show a hyperlink tooltip.IPresentationView
 Dispatched to notify listeners that a slide web object is to be shown.IPresentationView
Property Detail
backdropAlphaproperty
backdropAlpha: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

Defines the alpha transparency value of the the unoccupied area of the presentation view. Valid values are 0 (fully transparent) to 1 (fully opaque).

The default value is 1.


Implementation
    public function get backdropAlpha():Number
    public function set backdropAlpha(value:Number):void

See also

backdropColorproperty 
backdropColor:uint

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

Defines the color (0xRRGGBB) that fills the unoccupied area of the presentation view.

The default value is 0x000000.


Implementation
    public function get backdropColor():uint
    public function set backdropColor(value:uint):void

See also

coreproperty 
core:IPresentationPlaybackCore  [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

Returns the IPresentationPlaybackCore interface providing access to the low-level components of the presentation player.


Implementation
    public function get core():IPresentationPlaybackCore

See also

displayObjectproperty 
displayObject:DisplayObject  [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 flash.display.DisplayObject object visualizing the presentation slides.


Implementation
    public function get displayObject():DisplayObject

See also

fullScreenManagerproperty 
fullScreenManager:IFullScreenManager  [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

Returns the IFullScreenManager interface that allows switching the player between normal and full screen modes.


Implementation
    public function get fullScreenManager():IFullScreenManager

See also

keyboardControllerproperty 
keyboardController:IKeyboardController  [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

Returns the IKeyboardController interface which controls the presentation navigation using keyboard.


Implementation
    public function get keyboardController():IKeyboardController

See also

playbackControllerproperty 
playbackController:IPresentationPlaybackController  [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

Returns the IPresentationPlaybackController interface providing unrestricted presentation playback control facilities.

The unrestricted playback controller properties and methods ignore the playback and navigation restrictions (such as branching rules) which the presentation creator can define using iSpring Pro. To obtain the IPresentationPlaybackController interface which takes such restrictions into account, use the restrictedPlaybackController property.


Implementation
    public function get playbackController():IPresentationPlaybackController

See also

presentationSlideExtentproperty 
presentationSlideExtent:Rectangle  [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 extent of the presentation slide within the presentation view.


Implementation
    public function get presentationSlideExtent():Rectangle

See also

restrictedPlaybackControllerproperty 
restrictedPlaybackController:IPresentationPlaybackController  [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

Returns the IPresentationPlaybackController interface providing restricted presentation playback control facilities.

The restricted playback controller methods and properties take the playback and navigation restrictions (such as branching rules) into consideration. To obtain the IPresentationPlaybackController interface which ignores such restrictions, use the playbackController property.


Implementation
    public function get restrictedPlaybackController():IPresentationPlaybackController

See also

soundControllerproperty 
soundController:ISoundController  [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

Returns the ISoundController interface allowing sound volume control.


Implementation
    public function get soundController():ISoundController

See also

videoNarrationPlayerproperty 
videoNarrationPlayer:IVideoNarrationPlayer  [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

Returns the IVideoNarrationPlayer interface representing the video narration player.


Implementation
    public function get videoNarrationPlayer():IVideoNarrationPlayer

See also

Method Detail
resize()method
public function resize(width:Number, height:Number):void

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

Resizes the presentation view display object.

The slides within the presentation view are resized to inscribe the presentation view preserving their original aspect ratio. If the presentation view aspect ratio differs from the slide aspect ratio, the unoccupied area of the presentation view is filled with the backdrop color defined by the backdropColor and backdropAlpha properties.

Parameters

width:Number — A new width of the presentation view, in pixels.
 
height:Number — A new height of the presentation view, in pixels.

See also

Event Detail
executeMetaCommand Event
Event Object Type: ispring.presenter.player.events.MetaCommandEvent
MetaCommandEvent.type property = ispring.presenter.player.events.MetaCommandEvent.EXECUTE_META_COMMAND

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 to notify a listener to execute a meta command. A meta command can be associated with a slide or a hyperlink on a slide.

The MetaEvent.EXECUTE_META_COMMAND constant defines the value of the type property of the event object for a executeMetaCommand event.

The properties of the event object have the following values:

PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
commandThe IMetaCommand interface providing information about the meta command.
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.
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.
hideTooltip Event  
Event Object Type: ispring.presenter.player.events.TooltipEvent
TooltipEvent.type property = ispring.presenter.player.events.TooltipEvent.HIDE_TOOLTIP

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 to notify the skin to hide the previously shown tooltip.

The TooltipEvent.HIDE_TOOLTIP constant defines the value of the type property of the event object for a hideTooltip 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.
linkIdA unique identifier of the hyperlink.
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.
textnull
hideWebObject Event  
Event Object Type: ispring.presenter.player.events.WebObjectEvent
WebObjectEvent.type property = ispring.presenter.player.events.WebObjectEvent.HIDE_WEB_OBJECT

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

Dispatched to notify listeners that a slide web object is to be hidden.

The WebObjectEvent.HIDE_WEB_OBJECT constant defines the value of the type property of the event object for a hideWebObject 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.
webObjectThe IWebObject interface providing information about the web object to be hidden.
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.
showTooltip Event  
Event Object Type: ispring.presenter.player.events.TooltipEvent
TooltipEvent.type property = ispring.presenter.player.events.TooltipEvent.SHOW_TOOLTIP

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 to notify the skin to show a hyperlink tooltip.

The TooltipEvent.SHOW_TOOLTIP constant defines the value of the type property of the event object for a showTooltip 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.
linkIdA unique identifier of the hyperlink.
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.
textThe tooltip text.
showWebObject Event  
Event Object Type: ispring.presenter.player.events.WebObjectEvent
WebObjectEvent.type property = ispring.presenter.player.events.WebObjectEvent.SHOW_WEB_OBJECT

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

Dispatched to notify listeners that a slide web object is to be shown.

The WebObjectEvent.SHOW_WEB_OBJECT constant defines the value of the type property of the event object for a showWebObject 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.
webObjectThe IWebObject interface providing information about the web object to be displayed.
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.