Packagecom.globfx.showroom
Classpublic class SwiffPlayerShape
InheritanceSwiffPlayerShape Inheritance flash.events.EventDispatcher

The SwiffPlayerShape class represents the PowerPoint shape that holds Flash Player into the PowerPoint slide.

It can be retrieved through the ShowRoom.shape property.

See also

com.globfx.showroom.ShowRoom
com.globfx.showroom.ShowRoom.shape


Public Properties
 PropertyDefined By
  effectIndex : int
[read-only] Returns the current ShowRoom effect to execute. Returns -1 if the shape is not yet initialized, 0 for the first effect, etc. The number of ShowRoom effects must have been specified in the PowerPoint ShowRoom UI ("Flash" Ribbon Tab or "Developer" Tab in the properties dialog box). See How to edit ShowRoom Effects.
SwiffPlayerShape
  fullScreen : Boolean
[read-only] A flag that indicates whether the Flash is displayed in full screen mode or into the slide.
SwiffPlayerShape
  numEffects : int
[read-only] Returns the number of ShowRoom effects applied to this shape. This number is specified in PowerPoint in the shapes properties. The number of ShowRoom effects must have been specified in the PowerPoint ShowRoom UI ("Flash" Ribbon Tab or "Developer" Tab in the properties dialog box). See How to edit ShowRoom Effects.
SwiffPlayerShape
Public Methods
 MethodDefined By
  
When displayed in full screen mode, closes the player to continue the slide show.
SwiffPlayerShape
Events
 Event Summary Defined By
  Dispatched when the ShowRoom effect index has changed. The number of ShowRoom effects must have been specified in the PowerPoint ShowRoom UI ("Flash" Ribbon Tab or "Developer" Tab in the properties dialog box). See How to edit ShowRoom Effects.SwiffPlayerShape
  Dispatched when the Swiff Player Shape is removed from the slide during the slide show and disposed.SwiffPlayerShape
Public Constants
 ConstantDefined By
  EFFECT_CHANGED : String = effectChanged
[static]
SwiffPlayerShape
  UNLOAD : String = unload
[static]
SwiffPlayerShape
Property Detail
effectIndexproperty
effectIndex:int  [read-only]

Returns the current ShowRoom effect to execute.

Returns -1 if the shape is not yet initialized, 0 for the first effect, etc.

The number of ShowRoom effects must have been specified in the PowerPoint ShowRoom UI ("Flash" Ribbon Tab or "Developer" Tab in the properties dialog box).

See How to edit ShowRoom Effects.


Implementation
    public function get effectIndex():int
fullScreenproperty 
fullScreen:Boolean  [read-only]

A flag that indicates whether the Flash is displayed in full screen mode or into the slide.


Implementation
    public function get fullScreen():Boolean
numEffectsproperty 
numEffects:int  [read-only]

Returns the number of ShowRoom effects applied to this shape.

This number is specified in PowerPoint in the shapes properties.

The number of ShowRoom effects must have been specified in the PowerPoint ShowRoom UI ("Flash" Ribbon Tab or "Developer" Tab in the properties dialog box).

See How to edit ShowRoom Effects.


Implementation
    public function get numEffects():int
Method Detail
closeFullScreenPlayer()method
public function closeFullScreenPlayer():void

When displayed in full screen mode, closes the player to continue the slide show.

Event Detail
playStateChanged Event
Event Object Type: flash.events.Event

Dispatched when the ShowRoom effect index has changed.

The number of ShowRoom effects must have been specified in the PowerPoint ShowRoom UI ("Flash" Ribbon Tab or "Developer" Tab in the properties dialog box).

See How to edit ShowRoom Effects.

unload Event  
Event Object Type: flash.events.Event

Dispatched when the Swiff Player Shape is removed from the slide during the slide show and disposed.

Constant Detail
EFFECT_CHANGEDConstant
public static const EFFECT_CHANGED:String = effectChanged

UNLOADConstant 
public static const UNLOAD:String = unload